Standard-Auswahl für Umlaufvermögenskonto (Bank) mandantenweit setzen. Ferner yearend...

[mfinanz.git] / SL / Template / Plugin / L.pm

diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm
index 40e132a86ee9ee67a313049f60063609abe1339e..d1ecdbd8c6d239e909cb0a07cccefc7e6e1040ed 100644 (file)
--- a/SL/Template/Plugin/L.pm
+++ b/SL/Template/Plugin/L.pm
@@ -5,6 +5,24 @@ use Template::Plugin;
 
 use strict;
 
 
 use strict;
 

+{ # This will give you an id for identifying html tags and such.
+  # It's guaranteed to be unique unless you exceed 10 mio calls per request.
+  # Do not use these id's to store information across requests.
+my $_id_sequence = int rand 1e7;
+sub _tag_id {
+  return $_id_sequence = ($_id_sequence + 1) % 1e7;
+}
+}
+
+sub _H {
+  my $string = shift;
+  return $::locale->quote_special_chars('HTML', $string);
+}
+
+sub _hashify {
+  return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
+}
+

 sub new {
   my $class   = shift;
   my $context = shift;
 sub new {
   my $class   = shift;
   my $context = shift;


@@ -12,15 +30,25 @@ sub new {
   return bless { }, $class;
 }
 
   return bless { }, $class;
 }
 

+sub name_to_id {
+  my $self =  shift;
+  my $name =  shift;
+
+  $name    =~ s/[^\w_]/_/g;
+  $name    =~ s/_+/_/g;
+
+  return $name;
+}
+

 sub attributes {
   my $self    = shift;
 sub attributes {
   my $self    = shift;

-  my $options = shift || {};
+  my %options = _hashify(@_);

 
   my @result = ();
 
   my @result = ();

-  while (my ($name, $value) = each %{ $options }) {
+  while (my ($name, $value) = each %options) {

     next unless $name;
     $value ||= '';
     next unless $name;
     $value ||= '';

-    push @result, "${name}=\"" . $::locale->quote_special_chars('HTML', $value) . '"';
+    push @result, _H($name) . '="' . _H($value) . '"';

   }
 
   return @result ? ' ' . join(' ', @result) : '';
   }
 
   return @result ? ' ' . join(' ', @result) : '';


@@ -30,33 +58,67 @@ sub html_tag {
   my $self       = shift;
   my $tag        = shift;
   my $content    = shift;
   my $self       = shift;
   my $tag        = shift;
   my $content    = shift;

-  my $attributes = $self->attributes(shift || {});
+  my $attributes = $self->attributes(@_);

 
   return "<${tag}${attributes}/>" unless $content;
   return "<${tag}${attributes}>${content}</${tag}>";
 }
 
 sub select_tag {
 
   return "<${tag}${attributes}/>" unless $content;
   return "<${tag}${attributes}>${content}</${tag}>";
 }
 
 sub select_tag {

-  my $self              = shift;
-  my $name              = shift;
-  my $options_str       = shift;
-  my $attributes        = shift || {};
+  my $self            = shift;
+  my $name            = shift;
+  my $options_str     = shift;
+  my %attributes      = _hashify(@_);

 
 

-  $attributes->{name}   = $name;
-  $attributes->{id}   ||= $name;
+  $attributes{id}   ||= $self->name_to_id($name);

 
 

-  return $self->html_tag('select', $options_str, $attributes);
+  return $self->html_tag('select', $options_str, %attributes, name => $name);
+}
+
+sub checkbox_tag {
+  my $self             = shift;
+  my $name             = shift;
+  my %attributes       = _hashify(@_);
+
+  $attributes{id}    ||= $self->name_to_id($name);
+  $attributes{value}   = 1 unless defined $attributes{value};
+  my $label            = delete $attributes{label};
+
+  if ($attributes{checked}) {
+    $attributes{checked} = 'checked';
+  } else {
+    delete $attributes{checked};
+  }
+
+  my $code  = $self->html_tag('input', undef,  %attributes, name => $name, type => 'checkbox');
+  $code    .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+
+  return $code;
+}
+
+sub input_tag {
+  my $self            = shift;
+  my $name            = shift;
+  my $value           = shift;
+  my %attributes      = _hashify(@_);
+
+  $attributes{id}   ||= $self->name_to_id($name);
+  $attributes{type} ||= 'text';
+
+  return $self->html_tag('input', undef, %attributes, name => $name, value => $value);

 }
 
 sub options_for_select {
   my $self          = shift;
   my $collection    = shift;
 }
 
 sub options_for_select {
   my $self          = shift;
   my $collection    = shift;

-  my $options       = shift || {};
+  my %options       = _hashify(@_);

 
 

-  my $value_key     = $options->{value} || 'id';
-  my $title_key     = $options->{title} || $value_key;
+  my $value_key     = $options{value} || 'id';
+  my $title_key     = $options{title} || $value_key;
+
+  my @elements      = ();
+  push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};

 
 

-  my @tags          = ();

   if ($collection && (ref $collection eq 'ARRAY')) {
     foreach my $element (@{ $collection }) {
       my @result = !ref $element            ? ( $element,               $element               )
   if ($collection && (ref $collection eq 'ARRAY')) {
     foreach my $element (@{ $collection }) {
       my @result = !ref $element            ? ( $element,               $element               )


@@ -64,14 +126,49 @@ sub options_for_select {
                  :  ref $element eq 'HASH'  ? ( $element->{$value_key}, $element->{$title_key} )
                  :                            ( $element->$value_key,   $element->$title_key   );
 
                  :  ref $element eq 'HASH'  ? ( $element->{$value_key}, $element->{$title_key} )
                  :                            ( $element->$value_key,   $element->$title_key   );
 

-      my %attributes = ( value => $result[0] );
-      $attributes{selected} = 'selected' if $options->{default} && ($options->{default} eq ($result[0] || ''));
-
-      push @tags, $self->html_tag('option', $result[1], \%attributes);
+      push @elements, \@result;

     }
   }
 
     }
   }
 

-  return join('', @tags);
+  my $code = '';
+  foreach my $result (@elements) {
+    my %attributes = ( value => $result->[0] );
+    $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || ''));
+
+    $code .= $self->html_tag('option', _H($result->[1]), %attributes);
+  }
+
+  return $code;
+}
+
+sub javascript {
+  my ($self, $data) = @_;
+  return $self->html_tag('script', $data, type => 'text/javascript');
+}
+
+sub date_tag {
+  my ($self, $name, $value, @slurp) = @_;
+  my %params   = _hashify(@slurp);
+  my $name_e   = _H($name);
+  my $seq      = _tag_id();
+
+  $params{cal_align} ||= 'BR';
+
+  $self->input_tag($name, $value,
+    size   => 11,
+    title  => _H($::myconfig{dateformat}),
+    onBlur => 'check_right_date_format(this)',
+    %params,
+  ) . ((!$params{no_cal}) ?
+  $self->html_tag('img', undef,
+    src    => 'image/calendar.png',
+    id     => "trigger$seq",
+    title  => _H($::myconfig{dateformat}),
+    %params,
+  ) .
+  $self->javascript(
+    "Calendar.setup({ inputField: '$name_e', ifFormat: '$::myconfig{jsc_dateformat}', align: '$params{cal_align}', button: 'trigger$seq'  });"
+  ) : '');

 }
 
 1;
 }
 
 1;


@@ -101,22 +198,77 @@ functions that create HTML tags from various kinds of data sources.
 
 =head1 FUNCTIONS
 
 
 =head1 FUNCTIONS
 

+=head2 LOW-LEVEL FUNCTIONS
+

 =over 4
 
 =over 4
 

-=item C<attributes \%items>
+=item C<name_to_id $name>
+
+Converts a name to a HTML id by replacing various characters.

 
 

-Creates a string from all elements in C<\%items> suitable for usage as
+=item C<attributes %items>
+
+Creates a string from all elements in C<%items> suitable for usage as

 HTML tag attributes. Keys and values are HTML escaped even though keys
 must not contain non-ASCII characters for browsers to accept them.
 
 HTML tag attributes. Keys and values are HTML escaped even though keys
 must not contain non-ASCII characters for browsers to accept them.
 

-=item C<html_tag $tag_name, $content_string, \%attributes>
+=item C<html_tag $tag_name, $content_string, %attributes>

 
 Creates an opening and closing HTML tag for C<$tag_name> and puts
 C<$content_string> between the two. If C<$content_string> is undefined
 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
 are key/value pairs added to the opening tag.
 
 
 Creates an opening and closing HTML tag for C<$tag_name> and puts
 C<$content_string> between the two. If C<$content_string> is undefined
 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
 are key/value pairs added to the opening tag.
 

-=item C<options_for_select \@collection, \%options>
+C<$content_string> is not HTML escaped.
+
+=back
+
+=head2 HIGH-LEVEL FUNCTIONS
+
+=over 4
+
+=item C<select_tag $name, $options_string, %attributes>
+
+Creates a HTML 'select' tag named C<$name> with the contents
+C<$options_string> and with arbitrary HTML attributes from
+C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
+
+The $options_string is usually created by the C<options_for_select>
+function.
+
+=item C<input_tag $name, $value, %attributes>
+
+Creates a HTML 'input type=text' tag named C<$name> with the value
+C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C<id> defaults to C<name_to_id($name)>.
+
+=item C<checkbox_tag $name, %attributes>
+
+Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
+HTML attributes from C<%attributes>. The tag's C<id> defaults to
+C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
+
+If C<%attributes> contains a key C<label> then a HTML 'label' tag is
+created with said C<label>. No attribute named C<label> is created in
+that case.
+
+=item C<date_tag $name, $value, %attributes>
+
+=item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
+
+Creates a date input field, with an attached javascript that will open a
+calendar on click. The javascript ist by default anchoered at the bottom right
+sight. This can be overridden with C<cal_align>, see Calendar documentation for
+the details, usually you'll want a two letter abbreviation of the alignment.
+Right + Bottom becomes C<BL>.
+
+=back
+
+=head2 CONVERSION FUNCTIONS
+
+=over 4
+
+=item C<options_for_select \@collection, %options>

 
 Creates a string suitable for a HTML 'select' tag consisting of one
 'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
 
 Creates a string suitable for a HTML 'select' tag consisting of one
 'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value


@@ -130,11 +282,11 @@ the value, the second element is its title.
 
 =item 2. A scalar. The scalar is both the value and the title.
 
 
 =item 2. A scalar. The scalar is both the value and the title.
 

-=item 3. A hash reference. In this case C<\%options> must contain
+=item 3. A hash reference. In this case C<%options> must contain

 I<value> and I<title> keys that name the keys in the element to use
 for the value and title respectively.
 
 I<value> and I<title> keys that name the keys in the element to use
 for the value and title respectively.
 

-=item 4. A blessed reference. In this case C<\%options> must contain
+=item 4. A blessed reference. In this case C<%options> must contain

 I<value> and I<title> keys that name functions called on the blessed
 reference whose return values are used as the value and title
 respectively.
 I<value> and I<title> keys that name functions called on the blessed
 reference whose return values are used as the value and title
 respectively.


@@ -144,14 +296,10 @@ respectively.
 For cases 3 and 4 C<$options{value}> defaults to C<id> and
 C<$options{title}> defaults to C<$options{value}>.
 
 For cases 3 and 4 C<$options{value}> defaults to C<id> and
 C<$options{title}> defaults to C<$options{value}>.
 

-=item C<select_tag $name, $options_string, \%attributes>
-
-Creates a HTML 'select' tag named $name with the contents
-$options_string and with arbitrary HTML attributes from
-C<\%attributes>. The tag's C<id> defaults to C<$name>.
-
-The $options_string is usually created by the C<options_for_select>
-function.
+If the option C<with_empty> is set then an empty element (value
+C<undef>) will be used as the first element. The title to display for
+this element can be set with the option C<empty_title> and defaults to
+an empty string.

 
 =back
 
 
 =back