L-Plugin und Presenter: Erzeugung "ID"-Attribute mittels "no_id => 1" unterdrückbar
[kivitendo-erp.git] / SL / Template / Plugin / L.pm
index 09eaf72..6db2202 100644 (file)
@@ -19,11 +19,6 @@ sub _tag_id {
 }
 }
 
-my %_valueless_attributes = map { $_ => 1 } qw(
-  checked compact declare defer disabled ismap multiple noresize noshade nowrap
-  readonly selected
-);
-
 sub _H {
   my $string = shift;
   return $::locale->quote_special_chars('HTML', $string);
@@ -52,37 +47,31 @@ sub _context {
   return $_[0]->{CONTEXT};
 }
 
-sub name_to_id {
-  my $self =  shift;
-  my $name =  shift;
-
-  $name    =~ s/[^\w_]/_/g;
-  $name    =~ s/_+/_/g;
-
-  return $name;
-}
+sub _call_presenter {
+  my ($method, $self, @args) = @_;
 
-sub attributes {
-  my ($self, @slurp)    = @_;
-  my %options = _hashify(@slurp);
+  my $presenter              = $::request->presenter;
 
-  my @result = ();
-  while (my ($name, $value) = each %options) {
-    next unless $name;
-    next if $_valueless_attributes{$name} && !$value;
-    $value = '' if !defined($value);
-    push @result, $_valueless_attributes{$name} ? _H($name) : _H($name) . '="' . _H($value) . '"';
+  if (!$presenter->can($method)) {
+    $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
+    return '';
   }
 
-  return @result ? ' ' . join(' ', @result) : '';
+  splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
+
+  $presenter->$method(@args);
 }
 
-sub html_tag {
-  my ($self, $tag, $content, @slurp) = @_;
-  my $attributes = $self->attributes(@slurp);
+sub name_to_id    { return _call_presenter('name_to_id',    @_); }
+sub html_tag      { return _call_presenter('html_tag',      @_); }
+sub select_tag    { return _call_presenter('select_tag',    @_); }
+sub input_tag     { return _call_presenter('input_tag',     @_); }
+sub truncate      { return _call_presenter('truncate',      @_); }
+sub simple_format { return _call_presenter('simple_format', @_); }
 
-  return "<${tag}${attributes}>" unless defined($content);
-  return "<${tag}${attributes}>${content}</${tag}>";
+sub _set_id_attribute {
+  my ($attributes, $name) = @_;
+  SL::Presenter::Tag::_set_id_attribute($attributes, $name);
 }
 
 sub img_tag {
@@ -94,134 +83,11 @@ sub img_tag {
   return $self->html_tag('img', undef, %options);
 }
 
-sub select_tag {
-  my $self            = shift;
-  my $name            = shift;
-  my $collection      = shift;
-  my %attributes      = _hashify(@_);
-
-  $attributes{id}   ||= $self->name_to_id($name);
-
-  my $value_key       = delete($attributes{value_key}) || 'id';
-  my $title_key       = delete($attributes{title_key}) || $value_key;
-  my $default_key     = delete($attributes{default_key}) || 'selected';
-
-
-  my $value_title_sub = delete($attributes{value_title_sub});
-
-  my $value_sub       = delete($attributes{value_sub});
-  my $title_sub       = delete($attributes{title_sub});
-  my $default_sub     = delete($attributes{default_sub});
-
-  my $with_empty      = delete($attributes{with_empty});
-  my $empty_title     = delete($attributes{empty_title});
-
-  my %selected;
-
-  if ( ref($attributes{default}) eq 'ARRAY' ) {
-
-    foreach my $entry (@{$attributes{default}}) {
-      $selected{$entry} = 1;
-    }
-  } elsif ( defined($attributes{default}) ) {
-    $selected{$attributes{default}} = 1;
-  }
-
-  delete($attributes{default});
-
-
-  my @options;
-
-  if ( $with_empty ) {
-    push(@options, [undef, $empty_title || '']);
-  }
-
-  my $normalize_entry = sub {
-
-    my ($type, $entry, $sub, $key) = @_;
-
-    if ( $sub ) {
-      return $sub->($entry);
-    }
-
-    my $ref = ref($entry);
-
-    if ( !$ref ) {
-
-      if ( $type eq 'value' || $type eq 'title' ) {
-        return $entry;
-      }
-
-      return 0;
-    }
-
-    if ( $ref eq 'ARRAY' ) {
-
-      if ( $type eq 'value' ) {
-        return $entry->[0];
-      }
-
-      if ( $type eq 'title' ) {
-        return $entry->[1];
-      }
-
-      return $entry->[2];
-    }
-
-    if ( $ref eq 'HASH' ) {
-      return $entry->{$key};
-    }
-
-    if ( $type ne 'default' || $entry->can($key) ) {
-      return $entry->$key;
-    }
-
-    return undef;
-  };
-
-  foreach my $entry ( @{ $collection } ) {
-    my $value;
-    my $title;
-
-    if ( $value_title_sub ) {
-      ($value, $title) = @{ $value_title_sub->($entry) };
-    } else {
-
-      $value = $normalize_entry->('value', $entry, $value_sub, $value_key);
-      $title = $normalize_entry->('title', $entry, $title_sub, $title_key);
-    }
-
-    my $default = $normalize_entry->('default', $entry, $default_sub, $default_key);
-
-    push(@options, [$value, $title, $default]);
-  }
-
-  foreach my $entry (@options) {
-    if ( exists($selected{$entry->[0]}) ) {
-      $entry->[2] = 1;
-    }
-  }
-
-  my $code = '';
-
-  foreach my $entry (@options) {
-    my %args = (value => $entry->[0]);
-
-    $args{selected} = $entry->[2];
-
-    $code .= $self->html_tag('option', _H($entry->[1]), %args);
-  }
-
-  $code = $self->html_tag('select', $code, %attributes, name => $name);
-
-  return $code;
-}
-
 sub textarea_tag {
   my ($self, $name, $content, @slurp) = @_;
   my %attributes      = _hashify(@slurp);
 
-  $attributes{id}   ||= $self->name_to_id($name);
+  _set_id_attribute(\%attributes, $name);
   $attributes{rows}  *= 1; # required by standard
   $attributes{cols}  *= 1; # required by standard
   $content            = $content ? _H($content) : '';
@@ -233,7 +99,7 @@ sub checkbox_tag {
   my ($self, $name, @slurp) = @_;
   my %attributes       = _hashify(@slurp);
 
-  $attributes{id}    ||= $self->name_to_id($name);
+  _set_id_attribute(\%attributes, $name);
   $attributes{value}   = 1 unless defined $attributes{value};
   my $label            = delete $attributes{label};
   my $checkall         = delete $attributes{checkall};
@@ -256,8 +122,8 @@ sub radio_button_tag {
   my $name             = shift;
   my %attributes       = _hashify(@_);
 
+  _set_id_attribute(\%attributes, $name);
   $attributes{value}   = 1 unless defined $attributes{value};
-  $attributes{id}    ||= $self->name_to_id($name . "_" . $attributes{value});
   my $label            = delete $attributes{label};
 
   if ($attributes{checked}) {
@@ -272,18 +138,9 @@ sub radio_button_tag {
   return $code;
 }
 
-sub input_tag {
-  my ($self, $name, $value, @slurp) = @_;
-  my %attributes      = _hashify(@slurp);
-
-  $attributes{id}   ||= $self->name_to_id($name);
-  $attributes{type} ||= 'text';
-
-  return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
-}
-
 sub hidden_tag {
-  return shift->input_tag(@_, type => 'hidden');
+  my ($self, $name, $value, @slurp) = @_;
+  return $self->input_tag($name, $value, _hashify(@slurp), type => 'hidden');
 }
 
 sub div_tag {
@@ -325,12 +182,24 @@ sub button_tag {
   my ($self, $onclick, $value, @slurp) = @_;
   my %attributes = _hashify(@slurp);
 
-  $attributes{id}   ||= $self->name_to_id($attributes{name}) if $attributes{name};
+  _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
   $attributes{type} ||= 'button';
 
+  $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
+
   return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
 }
 
+sub ajax_submit_tag {
+  my ($self, $url, $form_selector, $text, @slurp) = @_;
+
+  $url           = _J($url);
+  $form_selector = _J($form_selector);
+  my $onclick    = qq|submit_ajax_form('${url}', '${form_selector}')|;
+
+  return $self->button_tag($onclick, $text, @slurp);
+}
+
 sub yes_no_tag {
   my ($self, $name, $value) = splice @_, 0, 3;
   my %attributes            = _hashify(@_);
@@ -357,41 +226,22 @@ sub stylesheet_tag {
   return $code;
 }
 
+my $date_tag_id_idx = 0;
 sub date_tag {
   my ($self, $name, $value, @slurp) = @_;
+
   my %params   = _hashify(@slurp);
-  my $name_e   = _H($name);
-  my $seq      = _tag_id();
-  my $datefmt  = apply {
-    s/d+/\%d/gi;
-    s/m+/\%m/gi;
-    s/y+/\%Y/gi;
-  } $::myconfig{"dateformat"};
-
-  my $cal_align = delete $params{cal_align} || 'BR';
-  my $onchange  = delete $params{onchange};
-  my $str_value = blessed $value ? $value->to_lxoffice : $value;
-
-  $self->input_tag($name, $str_value,
-    id     => $name_e,
+  _set_id_attribute(\%params, $name);
+  my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
+  my @class    = $params{no_cal} || $params{readonly} ? () : (class => 'datepicker');
+
+  return $self->input_tag(
+    $name, blessed($value) ? $value->to_lxoffice : $value,
     size   => 11,
-    title  => _H($::myconfig{dateformat}),
-    onBlur => 'check_right_date_format(this)',
-    ($onchange ? (
-    onChange => $onchange,
-    ) : ()),
+    onblur => "check_right_date_format(this);",
     %params,
-  ) . ((!$params{no_cal} && !$params{readonly}) ?
-  $self->html_tag('img', undef,
-    src    => 'image/calendar.png',
-    alt    => $::locale->text('Calendar'),
-    id     => "trigger$seq",
-    title  => _H($::myconfig{dateformat}),
-    %params,
-  ) .
-  $self->javascript(
-    "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$cal_align', button: 'trigger$seq' });"
-  ) : '');
+    @class, @onchange,
+  );
 }
 
 sub customer_picker {
@@ -464,27 +314,15 @@ sub tabbed {
 
     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');
+    my $tab_id = "__tab_id_$i";
+    push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
+    push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
   }
 
   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();|
-  );
+
+  my $ul = $self->ul_tag(join('', @header), id => $id);
+  return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
 }
 
 sub tab {
@@ -624,18 +462,6 @@ sub dump {
   return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
 }
 
-sub truncate {
-  my ($self, $text, @slurp) = @_;
-  my %params                = _hashify(@slurp);
-
-  $params{at}             ||= 50;
-  $params{at}               =  3 if 3 > $params{at};
-  $params{at}              -= 3;
-
-  return $text if length($text) < $params{at};
-  return substr($text, 0, $params{at}) . '...';
-}
-
 sub sortable_table_header {
   my ($self, $by, @slurp) = @_;
   my %params              = _hashify(@slurp);
@@ -709,86 +535,41 @@ Usage from a template:
 A module modeled a bit after Rails' ActionView helpers. Several small
 functions that create HTML tags from various kinds of data sources.
 
+The C<id> attribute is usually calculated automatically. This can be
+overridden by either specifying an C<id> attribute or by setting
+C<no_id> to trueish.
+
 =head1 FUNCTIONS
 
 =head2 LOW-LEVEL FUNCTIONS
 
-=over 4
-
-=item C<name_to_id $name>
+The following items are just forwarded to L<SL::Presenter::Tag>:
 
-Converts a name to a HTML id by replacing various characters.
-
-=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.
+=over 2
 
-=item C<html_tag $tag_name, $content_string, %attributes>
+=item * C<name_to_id $name>
 
-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<stringify_attributes %items>
 
-C<$content_string> is not HTML escaped.
+=item * C<html_tag $tag_name, $content_string, %attributes>
 
 =back
 
 =head2 HIGH-LEVEL FUNCTIONS
 
-=over 4
-
-=item C<select_tag $name, \@collection, %attributes>
-
-Creates a HTML 'select' tag named C<$name> with the contents of one
-'E<lt>optionE<gt>' tag for each element in C<\@collection> and with arbitrary
-HTML attributes from C<%attributes>. The value
-to use and the title to display are extracted from the elements in
-C<\@collection>. Each element can be one of four things:
-
-=over 12
-
-=item 1. An array reference with at least two elements. The first element is
-the value, the second element is its title. The third element is optional and and should contain a boolean.
-If it is true, than the element will be used as default.
+The following functions are just forwarded to L<SL::Presenter::Tag>:
 
-=item 2. A scalar. The scalar is both the value and the title.
+=over 2
 
-=item 3. A hash reference. In this case C<%attributes> must contain
-I<value_key>, I<title_key> and may contain I<default_key> keys that name the keys in the element to use
-for the value, title and default respectively.
+=item * C<input_tag $name, $value, %attributes>
 
-=item 4. A blessed reference. In this case C<%attributes> must contain
-I<value_key>, I<title_key> and may contain I<default_key> keys that name functions called on the blessed
-reference whose return values are used as the value, title and default
-respectively.
+=item * C<select_tag $name, \@collection, %attributes>
 
 =back
 
-For cases 3 and 4 C<$attributes{value_key}> defaults to C<id>,
-C<$attributes{title_key}> defaults to C<$attributes{value_key}>
-and C<$attributes{default_key}> defaults to C<selected>.
-
-In addition to pure keys/method you can also provide coderefs as I<value_sub>
-and/or I<title_sub> and/or I<default_sub>. If present, these take precedence over keys or methods,
-and are called with the element as first argument. It must return the value, title or default.
-
-Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes
-precedence over the C<value_sub> and C<title_sub> subs. It will only be called once for each
-element and must return a list of value and title.
-
-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.
+Available high-level functions implemented in this module:
 
-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.
-
-The tag's C<id> defaults to C<name_to_id($name)>.
+=over 4
 
 =item C<yes_no_tag $name, $value, %attributes>
 
@@ -797,12 +578,6 @@ calling L<select_tag>. C<$value> determines
 which entry is selected. The C<%attributes> are passed through to
 L<select_tag>.
 
-=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<hidden_tag $name, $value, %attributes>
 
 Creates a HTML 'input type=hidden' tag named C<$name> with the value
@@ -817,9 +592,28 @@ 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
+C<$attributes{confirm}>. The request is only submitted if the user
 clicks the dialog's ok/yes button.
 
+=item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
+
+Creates a HTML 'input type="button"' tag with a very specific onclick
+handler that submits the form given by the jQuery selector
+C<$form_selector> to the URL C<$url> (the actual JavaScript function
+called for that is C<submit_ajax_form()> in C<js/client_js.js>). The
+button's label will be C<$text>.
+
+=item C<button_tag $onclick, $text, %attributes>
+
+Creates a HTML 'input type="button"' tag with an onclick handler
+C<$onclick> and a value of C<$text>. The button does not have a name
+nor an ID by default.
+
+If C<$attributes{confirm}> is set then a JavaScript popup dialog will
+be prepended to the C<$onclick> handler asking the question given with
+C<$attributes{confirm}>. The 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
@@ -840,13 +634,10 @@ 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>
+=item C<date_tag $name, $value, %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>.
+calendar on click.
 
 =item C<radio_button_tag $name, %attributes>
 
@@ -872,14 +663,6 @@ 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
@@ -890,9 +673,6 @@ C<tab>. Example:
     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
@@ -1048,15 +828,13 @@ the resulting tab will get ignored by C<tabbed>:
 
   L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
 
-=item C<truncate $text, %params>
+=item C<truncate $text, [%params]>
+
+See L<SL::Presenter::Text/truncate>.
 
-Returns the C<$text> truncated after a certain number of
-characters.
+=item C<simple_format $text>
 
-The number of characters to truncate at is determined by the parameter
-C<at> which defaults to 50. If the text is longer than C<$params{at}>
-then it will be truncated and postfixed with '...'. Otherwise it will
-be returned unmodified.
+See L<SL::Presenter::Text/simple_format>.
 
 =back