Auf Romans Anregen - Ein simples POD basiertes Hilfesystem

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

diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm
index ac31e310415c3dc5749550f8dd4e85263b8090f6..2299a66b1c47cc4e4611222ec66d013dc01bbeb2 100644 (file)
--- 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 base qw( Template::Plugin );
 use Template::Plugin;
 use List::MoreUtils qw(apply);

+use List::Util qw(max);

 
 use strict;
 
 
 use strict;
 


@@ -20,15 +21,27 @@ sub _H {
   return $::locale->quote_special_chars('HTML', $string);
 }
 
   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] } : @_;
 }
 
 sub new {
 sub _hashify {
   return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
 }
 
 sub new {

-  my $class   = shift;
-  my $context = shift;
+  my ($class, $context, @args) = @_;
+
+  return bless {
+    CONTEXT => $context,
+  }, $class;
+}

 
 

-  return bless { }, $class;
+sub _context {
+  die 'not an accessor' if @_ > 1;
+  return $_[0]->{CONTEXT};

 }
 
 sub name_to_id {
 }
 
 sub name_to_id {


@@ -42,13 +55,14 @@ sub name_to_id {
 }
 
 sub attributes {
 }
 
 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;
 
   my @result = ();
   while (my ($name, $value) = each %options) {
     next unless $name;

-    $value ||= '';
+    next if $name eq 'disabled' && !$value;
+    $value = '' if !defined($value);

     push @result, _H($name) . '="' . _H($value) . '"';
   }
 
     push @result, _H($name) . '="' . _H($value) . '"';
   }
 


@@ -56,10 +70,8 @@ sub attributes {
 }
 
 sub html_tag {
 }
 
 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}>";
 
   return "<${tag}${attributes}/>" unless defined($content);
   return "<${tag}${attributes}>${content}</${tag}>";


@@ -78,10 +90,8 @@ sub select_tag {
 }
 
 sub textarea_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) : '';
 
   $attributes{id}   ||= $self->name_to_id($name);
   $content            = $content ? _H($content) : '';


@@ -90,9 +100,8 @@ sub textarea_tag {
 }
 
 sub checkbox_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};
 
   $attributes{id}    ||= $self->name_to_id($name);
   $attributes{value}   = 1 unless defined $attributes{value};


@@ -132,10 +141,8 @@ sub radio_button_tag {
 }
 
 sub input_tag {
 }
 
 sub input_tag {

-  my $self            = shift;
-  my $name            = shift;
-  my $value           = shift;
-  my %attributes      = _hashify(@_);
+  my ($self, $name, $value, @slurp) = @_;
+  my %attributes      = _hashify(@slurp);

 
   $attributes{id}   ||= $self->name_to_id($name);
   $attributes{type} ||= 'text';
 
   $attributes{id}   ||= $self->name_to_id($name);
   $attributes{type} ||= 'text';


@@ -147,8 +154,44 @@ sub hidden_tag {
   return shift->input_tag(@_, type => 'hidden');
 }
 
   return shift->input_tag(@_, type => 'hidden');
 }
 

+sub div_tag {
+  my ($self, $content, @slurp) = @_;
+  return $self->html_tag('div', $content, @slurp);
+}
+
+sub ul_tag {
+  my ($self, $content, @slurp) = @_;
+  return $self->html_tag('ul', $content, @slurp);
+}
+
+sub li_tag {
+  my ($self, $content, @slurp) = @_;
+  return $self->html_tag('li', $content, @slurp);
+}
+
+sub link {
+  my ($self, $href, $content, @slurp) = @_;
+  my %params = _hashify(@slurp);
+
+  $href ||= '#';
+
+  return $self->html_tag('a', $content, %params, href => $href);
+}
+

 sub submit_tag {
 sub submit_tag {

-  return shift->input_tag(@_, type => 'submit', class => 'submit');
+  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 {
 }
 
 sub options_for_select {


@@ -164,6 +207,8 @@ sub options_for_select {
 
   my $value_title_sub = $options{value_title_sub};
 
 
   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;
   my $access = sub {
     my ($element, $index, $key, $sub) = @_;
     my $ref = ref $element;


@@ -186,7 +231,7 @@ sub options_for_select {
   my $code = '';
   foreach my $result (@elements) {
     my %attributes = ( value => $result->[0] );
   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);
   }
 
     $code .= $self->html_tag('option', _H($result->[1]), %attributes);
   }


@@ -199,6 +244,20 @@ sub javascript {
   return $self->html_tag('script', $data, type => 'text/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);
 sub date_tag {
   my ($self, $name, $value, @slurp) = @_;
   my %params   = _hashify(@slurp);


@@ -226,8 +285,9 @@ sub date_tag {
     %params,
   ) .
   $self->javascript(
     %params,
   ) .
   $self->javascript(

-    "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq'  });"
+    "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });"

   ) : '');
   ) : '');

+}

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


@@ -243,6 +303,117 @@ sub javascript_tag {
   return $code;
 }
 
   return $code;
 }
 

+sub tabbed {
+  my ($self, $tabs, @slurp) = @_;
+  my %params   = _hashify(@slurp);
+  my $id       = $params{id} || 'tab_' . _tag_id();
+
+  $params{selected} *= 1;
+
+  die 'L.tabbed needs an arrayred of tabs for first argument'
+    unless ref $tabs eq 'ARRAY';
+
+  my (@header, @blocks);
+  for my $i (0..$#$tabs) {
+    my $tab = $tabs->[$i];
+
+    next if $tab eq '';
+
+    my $selected = $params{selected} == $i;
+    my $tab_id   = "__tab_id_$i";
+    push @header, $self->li_tag(
+      $self->link('', $tab->{name}, rel => $tab_id),
+        ($selected ? (class => 'selected') : ())
+    );
+    push @blocks, $self->div_tag($tab->{data},
+      id => $tab_id, class => 'tabcontent');
+  }
+
+  return '' unless @header;
+  return $self->ul_tag(
+    join('', @header), id => $id, class => 'shadetabs'
+  ) .
+  $self->div_tag(
+    join('', @blocks), class => 'tabcontentstyle'
+  ) .
+  $self->javascript(
+    qq|var $id = new ddtabcontent("$id");$id.setpersist(true);| .
+    qq|$id.setselectedClassTarget("link");$id.init();|
+  );
+}
+
+sub tab {
+  my ($self, $name, $src, @slurp) = @_;
+  my %params = _hashify(@slurp);
+
+  $params{method} ||= 'process';
+
+  return () if defined $params{if} && !$params{if};
+
+  my $data;
+  if ($params{method} eq 'raw') {
+    $data = $src;
+  } elsif ($params{method} eq 'process') {
+    $data = $self->_context->process($src, %{ $params{args} || {} });
+  } else {
+    die "unknown tag method '$params{method}'";
+  }
+
+  return () unless $data;
+
+  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 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__
 1;
 
 __END__


@@ -328,6 +499,11 @@ Creates a HTML 'input type=submit class=submit' 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)>.
 
 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
 tag's C<id> defaults to C<name_to_id($name)>.
 

+If C<$attributes{confirm}> is set then a JavaScript popup dialog will
+be added via the C<onclick> handler asking the question given with
+C<$attributes{confirm}>. If request is only submitted if the user
+clicks the dialog's ok/yes button.
+

 =item C<textarea_tag $name, $value, %attributes>
 
 Creates a HTML 'textarea' tag named C<$name> with the content
 =item C<textarea_tag $name, $value, %attributes>
 
 Creates a HTML 'textarea' tag named C<$name> with the content


@@ -369,6 +545,68 @@ 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.
 
 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
+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>.
+
+=item C<tabbed \@tab, %attributes>
+
+Will create a tabbed area. The tabs should be created with the helper function
+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<dump REF>
+
+Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
+

 =back
 
 =head2 CONVERSION FUNCTIONS
 =back
 
 =head2 CONVERSION FUNCTIONS


@@ -417,6 +655,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.
 
 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
 =back
 
 =head1 MODULE AUTHORS