X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=0ed2a8784718ce68e202b16c17be111b1b13321c;hb=b27c05d659c377d0911e6b1bde6d4d92d6cc19e2;hp=23a293fbfe77cf6c9422afa479eacbb1236b1139;hpb=e5205a2352978ce3c665ecb5d7a017f308b7d139;p=kivitendo-erp.git

diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm
index 23a293fbf..0ed2a8784 100644
--- a/SL/Template/Plugin/L.pm
+++ b/SL/Template/Plugin/L.pm
@@ -3,6 +3,7 @@ package SL::Template::Plugin::L;
 use base qw( Template::Plugin );
 use Template::Plugin;
 use List::MoreUtils qw(apply);
+use List::Util qw(max);
 
 use strict;
 
@@ -20,6 +21,12 @@ sub _H {
   return $::locale->quote_special_chars('HTML', $string);
 }
 
+sub _J {
+  my $string =  "" . shift;
+  $string    =~ s/\"/\\\"/g;
+  return $string;
+}
+
 sub _hashify {
   return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
 }
@@ -48,12 +55,13 @@ sub name_to_id {
 }
 
 sub attributes {
-  my $self    = shift;
-  my %options = _hashify(@_);
+  my ($self, @slurp)    = @_;
+  my %options = _hashify(@slurp);
 
   my @result = ();
   while (my ($name, $value) = each %options) {
     next unless $name;
+    next if $name eq 'disabled' && !$value;
     $value = '' if !defined($value);
     push @result, _H($name) . '="' . _H($value) . '"';
   }
@@ -62,10 +70,8 @@ sub attributes {
 }
 
 sub html_tag {
-  my $self       = shift;
-  my $tag        = shift;
-  my $content    = shift;
-  my $attributes = $self->attributes(@_);
+  my ($self, $tag, $content, @slurp) = @_;
+  my $attributes = $self->attributes(@slurp);
 
   return "<${tag}${attributes}/>" unless defined($content);
   return "<${tag}${attributes}>${content}</${tag}>";
@@ -84,10 +90,8 @@ sub select_tag {
 }
 
 sub textarea_tag {
-  my $self            = shift;
-  my $name            = shift;
-  my $content         = shift;
-  my %attributes      = _hashify(@_);
+  my ($self, $name, $content, @slurp) = @_;
+  my %attributes      = _hashify(@slurp);
 
   $attributes{id}   ||= $self->name_to_id($name);
   $content            = $content ? _H($content) : '';
@@ -96,13 +100,13 @@ sub textarea_tag {
 }
 
 sub checkbox_tag {
-  my $self             = shift;
-  my $name             = shift;
-  my %attributes       = _hashify(@_);
+  my ($self, $name, @slurp) = @_;
+  my %attributes       = _hashify(@slurp);
 
   $attributes{id}    ||= $self->name_to_id($name);
   $attributes{value}   = 1 unless defined $attributes{value};
   my $label            = delete $attributes{label};
+  my $checkall         = delete $attributes{checkall};
 
   if ($attributes{checked}) {
     $attributes{checked} = 'checked';
@@ -112,6 +116,7 @@ sub checkbox_tag {
 
   my $code  = $self->html_tag('input', undef,  %attributes, name => $name, type => 'checkbox');
   $code    .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+  $code    .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
 
   return $code;
 }
@@ -139,7 +144,7 @@ sub radio_button_tag {
 
 sub input_tag {
   my ($self, $name, $value, @slurp) = @_;
-  my %attributes                    = _hashify(@slurp);
+  my %attributes      = _hashify(@slurp);
 
   $attributes{id}   ||= $self->name_to_id($name);
   $attributes{type} ||= 'text';
@@ -176,16 +181,21 @@ sub link {
 }
 
 sub submit_tag {
-  my $self             = shift;
-  my $name             = shift;
-  my $value            = shift;
-  my %attributes       = _hashify(@_);
+  my ($self, $name, $value, @slurp) = @_;
+  my %attributes = _hashify(@slurp);
 
   $attributes{onclick} = "if (confirm('" . delete($attributes{confirm}) . "')) return true; else return false;" if $attributes{confirm};
 
   return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
 }
 
+sub button_tag {
+  my ($self, $onclick, $value, @slurp) = @_;
+  my %attributes = _hashify(@slurp);
+
+  return $self->input_tag(undef, $value, %attributes, type => 'button', onclick => $onclick);
+}
+
 sub options_for_select {
   my $self            = shift;
   my $collection      = shift;
@@ -199,6 +209,8 @@ sub options_for_select {
 
   my $value_title_sub = $options{value_title_sub};
 
+  my %selected        = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : defined($options{default}) ? [ $options{default} ] : [] };
+
   my $access = sub {
     my ($element, $index, $key, $sub) = @_;
     my $ref = ref $element;
@@ -212,7 +224,7 @@ sub options_for_select {
   my @elements = ();
   push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
   push @elements, map [
-    $value_title_sub ? $value_title_sub->($_) : (
+    $value_title_sub ? @{ $value_title_sub->($_) } : (
       $access->($_, 0, $value_key, $value_sub),
       $access->($_, 1, $title_key, $title_sub),
     )
@@ -221,7 +233,7 @@ sub options_for_select {
   my $code = '';
   foreach my $result (@elements) {
     my %attributes = ( value => $result->[0] );
-    $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || ''));
+    $attributes{selected} = 'selected' if $selected{ defined($result->[0]) ? $result->[0] : '' };
 
     $code .= $self->html_tag('option', _H($result->[1]), %attributes);
   }
@@ -234,6 +246,20 @@ sub javascript {
   return $self->html_tag('script', $data, type => 'text/javascript');
 }
 
+sub stylesheet_tag {
+  my $self = shift;
+  my $code = '';
+
+  foreach my $file (@_) {
+    $file .= '.css'        unless $file =~ m/\.css$/;
+    $file  = "css/${file}" unless $file =~ m|/|;
+
+    $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
+  }
+
+  return $code;
+}
+
 sub date_tag {
   my ($self, $name, $value, @slurp) = @_;
   my %params   = _hashify(@slurp);
@@ -263,6 +289,7 @@ sub date_tag {
   $self->javascript(
     "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });"
   ) : '');
+}
 
 sub javascript_tag {
   my $self = shift;
@@ -281,7 +308,7 @@ sub javascript_tag {
 sub tabbed {
   my ($self, $tabs, @slurp) = @_;
   my %params   = _hashify(@slurp);
-  my $id       = 'tab_' . _tag_id();
+  my $id       = $params{id} || 'tab_' . _tag_id();
 
   $params{selected} *= 1;
 
@@ -295,7 +322,7 @@ sub tabbed {
     next if $tab eq '';
 
     my $selected = $params{selected} == $i;
-    my $tab_id = _tag_id();
+    my $tab_id   = "__tab_id_$i";
     push @header, $self->li_tag(
       $self->link('', $tab->{name}, rel => $tab_id),
         ($selected ? (class => 'selected') : ())
@@ -339,6 +366,114 @@ sub tab {
   return +{ name => $name, data => $data };
 }
 
+sub areainput_tag {
+  my ($self, $name, $value, @slurp) = @_;
+  my %attributes      = _hashify(@slurp);
+
+  my $rows = delete $attributes{rows}     || 1;
+  my $min  = delete $attributes{min_rows} || 1;
+
+  return $rows > 1
+    ? $self->textarea_tag($name, $value, %attributes, rows => max $rows, $min)
+    : $self->input_tag($name, $value, %attributes);
+}
+
+sub multiselect2side {
+  my ($self, $id, @slurp) = @_;
+  my %params              = _hashify(@slurp);
+
+  $params{labelsx}        = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
+  $params{labeldx}        = "\"" . _J($params{labeldx} || $::locale->text('Selected'))  . "\"";
+  $params{moveOptions}    = 'false';
+
+  my $vars                = join(', ', map { "${_}: " . $params{$_} } keys %params);
+  my $code                = <<EOCODE;
+<script type="text/javascript">
+  \$().ready(function() {
+    \$('#${id}').multiselect2side({ ${vars} });
+  });
+</script>
+EOCODE
+
+  return $code;
+}
+
+sub sortable_element {
+  my ($self, $selector, @slurp) = @_;
+  my %params                    = _hashify(@slurp);
+
+  my %attributes = ( distance => 5,
+                     helper   => <<'JAVASCRIPT' );
+    function(event, ui) {
+      ui.children().each(function() {
+        $(this).width($(this).width());
+      });
+      return ui;
+    }
+JAVASCRIPT
+
+  my $stop_event = '';
+
+  if ($params{url} && $params{with}) {
+    my $as      = $params{as} || $params{with};
+    my $filter  = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
+    $filter    .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
+
+    $stop_event = <<JAVASCRIPT;
+        \$.post('$params{url}', { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
+JAVASCRIPT
+  }
+
+  if (!$params{dont_recolor}) {
+    $stop_event .= <<JAVASCRIPT;
+        \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
+        \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
+JAVASCRIPT
+  }
+
+  if ($stop_event) {
+    $attributes{stop} = <<JAVASCRIPT;
+      function(event, ui) {
+        ${stop_event}
+        return ui;
+      }
+JAVASCRIPT
+  }
+
+  $params{handle}     = '.dragdrop' unless exists $params{handle};
+  $attributes{handle} = "'$params{handle}'" if $params{handle};
+
+  my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
+
+  my $code = <<JAVASCRIPT;
+<script type="text/javascript">
+  \$(function() {
+    \$( "${selector}" ).sortable({ ${attr_str} })
+  });
+</script>
+JAVASCRIPT
+
+  return $code;
+}
+
+sub online_help_tag {
+  my ($self, $tag, @slurp) = @_;
+  my %params               = _hashify(@slurp);
+  my $cc                   = $::myconfig{countrycode};
+  my $file                 = "doc/online/$cc/$tag.html";
+  my $text                 = $params{text} || $::locale->text('Help');
+
+  die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
+  return unless -f $file;
+  return $self->html_tag('a', $text, href => $file, target => '_blank');
+}
+
+sub dump {
+  my $self = shift;
+  require Data::Dumper;
+  return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
+}
+
 1;
 
 __END__
@@ -445,6 +580,10 @@ 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.
 
+If C<%attributes> contains a key C<checkall> then the value is taken as a
+JQuery selector and clicking this checkbox will also toggle all checkboxes
+matching the selector.
+
 =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
@@ -470,6 +609,13 @@ tag for each file name parameter passed. Each file name will be
 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
 doesn't contain a slash.
 
+=item C<stylesheet_tag $file1, $file2, $file3...>
+
+Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
+for each file name parameter passed. Each file name will be postfixed
+with '.css' if it isn't already and prefixed with 'css/' if it doesn't
+contain a slash.
+
 =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
@@ -481,7 +627,126 @@ Right + Bottom becomes C<BL>.
 =item C<tabbed \@tab, %attributes>
 
 Will create a tabbed area. The tabs should be created with the helper function
-C<tab>
+C<tab>. Example:
+
+  [% L.tabbed([
+    L.tab(LxERP.t8('Basic Data'),       'part/_main_tab.html'),
+    L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
+  ]) %]
+
+An optional attribute is C<selected>, which accepts the ordinal of a tab which
+should be selected by default.
+
+=item C<areainput_tag $name, $content, %PARAMS>
+
+Creates a generic input tag or textarea tag, depending on content size. The
+mount of desired rows must be given with C<rows> parameter, Accpeted parameters
+include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
+
+You can force input by setting rows to 1, and you can force textarea by setting
+rows to anything >1.
+
+=item C<multiselect2side $id, %params>
+
+Creates a JavaScript snippet calling the jQuery function
+C<multiselect2side> on the select control with the ID C<$id>. The
+select itself is not created. C<%params> can contain the following
+entries:
+
+=over 2
+
+=item C<labelsx>
+
+The label of the list of available options. Defaults to the
+translation of 'Available'.
+
+=item C<labeldx>
+
+The label of the list of selected options. Defaults to the
+translation of 'Selected'.
+
+=back
+
+=item C<sortable_element $selector, %params>
+
+Makes the children of the DOM element C<$selector> (a jQuery selector)
+sortable with the I<jQuery UI Selectable> library. The children can be
+dragged & dropped around. After dropping an element an URL can be
+postet to with the element IDs of the sorted children.
+
+If this is used then the JavaScript file C<js/jquery-ui.js> must be
+included manually as well as it isn't loaded via C<$::form-gt;header>.
+
+C<%params> can contain the following entries:
+
+=over 2
+
+=item C<url>
+
+The URL to POST an AJAX request to after a dragged element has been
+dropped. The AJAX request's return value is ignored. If given then
+C<$params{with}> must be given as well.
+
+=item C<with>
+
+A string that is interpreted as the prefix of the children's ID. Upon
+POSTing the result each child whose ID starts with C<$params{with}> is
+considered. The prefix and the following "_" is removed from the
+ID. The remaining parts of the IDs of those children are posted as a
+single array parameter. The array parameter's name is either
+C<$params{as}> or, missing that, C<$params{with}>.
+
+=item C<as>
+
+Sets the POST parameter name for AJAX request after dropping an
+element (see C<$params{with}>).
+
+=item C<handle>
+
+An optional jQuery selector specifying which part of the child element
+is dragable. If the parameter is not given then it defaults to
+C<.dragdrop> matching DOM elements with the class C<dragdrop>.  If the
+parameter is set and empty then the whole child element is dragable,
+and clicks through to underlying elements like inputs or links might
+not work.
+
+=item C<dont_recolor>
+
+If trueish then the children will not be recolored. The default is to
+recolor the children by setting the class C<listrow0> on odd and
+C<listrow1> on even entries.
+
+=back
+
+Example:
+
+  <script type="text/javascript" src="js/jquery-ui.js"></script>
+
+  <table id="thing_list">
+    <thead>
+      <tr><td>This</td><td>That</td></tr>
+    </thead>
+    <tbody>
+      <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
+      <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
+    </tbody>
+  <table>
+
+  [% L.sortable_element('#thing_list tbody',
+                        url          => 'controller.pl?action=SystemThings/reorder',
+                        with         => 'thingy',
+                        as           => 'thing_ids',
+                        recolor_rows => 1) %]
+
+After dropping e.g. the third element at the top of the list a POST
+request would be made to the C<reorder> action of the C<SystemThings>
+controller with a single parameter called C<thing_ids> -- an array
+containing the values C<[ 6, 2, 15 ]>.
+
+=item C<dump REF>
+
+Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
 
 =back
 
@@ -531,6 +796,24 @@ 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.
 
+The option C<default> can be either a scalar or an array reference
+containing the values of the options which should be set to be
+selected.
+
+=item C<tab, description, target, %PARAMS>
+
+Creates a tab for C<tabbed>. The description will be used as displayed name.
+The target should be a block or template that can be processed. C<tab> supports
+a C<method> parameter, which can override the process method to apply target.
+C<method => 'raw'> will just include the given text as is. I was too lazy to
+implement C<include> properly.
+
+Also an C<if> attribute is supported, so that tabs can be suppressed based on
+some occasion. In this case the supplied block won't even get processed, and
+the resulting tab will get ignored by C<tabbed>:
+
+  L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
+
 =back
 
 =head1 MODULE AUTHORS