X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=78efe642aaaaae16214745cfd504c54a392e9f79;hb=35d63a9fdee45777535d7ec815bfbc76c5c1bdc9;hp=66f6fcc58ec07ca60a3dfffa4cedcec7c0dccdfc;hpb=4f15b8f0ee316711afb118db91f057eec5924d43;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index 66f6fcc58..78efe642a 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -2,11 +2,13 @@ package SL::Template::Plugin::L; use base qw( Template::Plugin ); use Template::Plugin; +use Data::Dumper; use List::MoreUtils qw(apply); use List::Util qw(max); use Scalar::Util qw(blessed); use SL::Presenter; +use SL::Util qw(_hashify); use strict; @@ -19,11 +21,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); @@ -35,10 +32,6 @@ sub _J { return $string; } -sub _hashify { - return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_; -} - sub new { my ($class, $context, @args) = @_; @@ -53,187 +46,45 @@ sub _context { } sub _call_presenter { - my ($method, @args) = @_; + my ($method, $self, @args) = @_; - my $presenter = $::request->presenter; + my $presenter = $::request->presenter; - return '' unless $presenter->can($method); + if (!$presenter->can($method)) { + $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!"); + return ''; + } splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH'); $presenter->$method(@args); } -sub name_to_id { - my $self = shift; - my $name = shift; +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', @_); } +sub part_picker { return _call_presenter('part_picker', @_); } - $name =~ s/[^\w_]/_/g; - $name =~ s/_+/_/g; - - return $name; -} - -sub attributes { - my ($self, @slurp) = @_; - my %options = _hashify(@slurp); - - 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) . '"'; - } - - return @result ? ' ' . join(' ', @result) : ''; -} - -sub html_tag { - my ($self, $tag, $content, @slurp) = @_; - my $attributes = $self->attributes(@slurp); - - return "<${tag}${attributes}>" unless defined($content); - return "<${tag}${attributes}>${content}"; +sub _set_id_attribute { + my ($attributes, $name) = @_; + SL::Presenter::Tag::_set_id_attribute($attributes, $name); } sub img_tag { - my ($self, @slurp) = @_; - my %options = _hashify(@slurp); + my ($self, %options) = _hashify(1, @_); $options{alt} ||= ''; 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); + my ($self, $name, $content, %attributes) = _hashify(3, @_); - $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) : ''; @@ -242,10 +93,9 @@ sub textarea_tag { } sub checkbox_tag { - my ($self, $name, @slurp) = @_; - my %attributes = _hashify(@slurp); + my ($self, $name, %attributes) = _hashify(2, @_); - $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}; @@ -264,12 +114,10 @@ sub checkbox_tag { } sub radio_button_tag { - my $self = shift; - my $name = shift; - my %attributes = _hashify(@_); + my ($self, $name, %attributes) = _hashify(2, @_); - $attributes{value} = 1 unless defined $attributes{value}; - $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value}); + _set_id_attribute(\%attributes, $name); + $attributes{value} = 1 unless exists $attributes{value}; my $label = delete $attributes{label}; if ($attributes{checked}) { @@ -284,19 +132,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 { - my ($self, $name, $value, @slurp) = @_; - return $self->input_tag($name, $value, _hashify(@slurp), type => 'hidden'); + my ($self, $name, $value, %attributes) = _hashify(3, @_); + return $self->input_tag($name, $value, %attributes, type => 'hidden'); } sub div_tag { @@ -315,8 +153,7 @@ sub li_tag { } sub link { - my ($self, $href, $content, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $href, $content, %params) = _hashify(3, @_); $href ||= '#'; @@ -324,8 +161,7 @@ sub link { } sub submit_tag { - my ($self, $name, $value, @slurp) = @_; - my %attributes = _hashify(@slurp); + my ($self, $name, $value, %attributes) = _hashify(3, @_); if ( $attributes{confirm} ) { $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");'; @@ -335,18 +171,28 @@ sub submit_tag { } sub button_tag { - my ($self, $onclick, $value, @slurp) = @_; - my %attributes = _hashify(@slurp); + my ($self, $onclick, $value, %attributes) = _hashify(3, @_); - $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|kivi.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(@_); + my ($self, $name, $value, %attributes) = _hashify(3, @_); return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes); } @@ -372,20 +218,20 @@ sub stylesheet_tag { my $date_tag_id_idx = 0; sub date_tag { - my ($self, $name, $value, @slurp) = @_; + my ($self, $name, $value, %params) = _hashify(3, @_); - my %params = _hashify(@slurp); - my $id = $self->name_to_id($name) . _tag_id(); + _set_id_attribute(\%params, $name); my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : (); - my @class = $params{no_cal} || $params{readonly} ? () : (class => 'datepicker'); + my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker'); + push @classes, delete($params{class}) if $params{class}; + my %class = @classes ? (class => join(' ', @classes)) : (); return $self->input_tag( $name, blessed($value) ? $value->to_lxoffice : $value, - id => $id, size => 11, onblur => "check_right_date_format(this);", %params, - @class, @onchange, + %class, @onchange, ); } @@ -444,8 +290,7 @@ sub javascript_tag { } sub tabbed { - my ($self, $tabs, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $tabs, %params) = _hashify(2, @_); my $id = $params{id} || 'tab_' . _tag_id(); $params{selected} *= 1; @@ -471,8 +316,7 @@ sub tabbed { } sub tab { - my ($self, $name, $src, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $name, $src, %params) = _hashify(3, @_); $params{method} ||= 'process'; @@ -493,8 +337,7 @@ sub tab { } sub areainput_tag { - my ($self, $name, $value, @slurp) = @_; - my %attributes = _hashify(@slurp); + my ($self, $name, $value, %attributes) = _hashify(3, @_); my ($rows, $cols); my $min = delete $attributes{min_rows} || 1; @@ -512,8 +355,7 @@ sub areainput_tag { } sub multiselect2side { - my ($self, $id, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $id, %params) = _hashify(2, @_); $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\""; $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\""; @@ -532,8 +374,7 @@ EOCODE } sub sortable_element { - my ($self, $selector, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $selector, %params) = _hashify(2, @_); my %attributes = ( distance => 5, helper => <<'JAVASCRIPT' ); @@ -552,8 +393,10 @@ JAVASCRIPT my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })"; $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })"; + my $params_js = $params{params} ? qq| + ($params{params})| : ''; + $stop_event = <text('Help'); @@ -603,18 +445,11 @@ sub online_help_tag { sub dump { my $self = shift; - require Data::Dumper; return '
' . Data::Dumper::Dumper(@_) . '
'; } -sub truncate { - my $self = shift; - return _call_presenter('truncate', @_); -} - sub sortable_table_header { - my ($self, $by, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $by, %params) = _hashify(2, @_); my $controller = $self->{CONTEXT}->stash->get('SELF'); my $sort_spec = $controller->get_sort_spec; @@ -636,7 +471,7 @@ sub sortable_table_header { } sub paginate_controls { - my ($self) = @_; + my ($self, %params) = _hashify(1, @_); my $controller = $self->{CONTEXT}->stash->get('SELF'); my $paginate_spec = $controller->get_paginate_spec; @@ -645,22 +480,18 @@ sub paginate_controls { my %template_params = ( pages => \%paginate_params, url_maker => sub { - my %url_params = _hashify(@_); + my %url_params = _hashify(0, @_); $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page}; $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page}; return $controller->get_callback(%url_params); }, + %params, ); return SL::Presenter->get->render('common/paginate', %template_params); } -sub simple_format { - my $self = shift; - return _call_presenter('simple_format', @_); -} - 1; __END__ @@ -690,86 +521,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 attribute is usually calculated automatically. This can be +overridden by either specifying an C attribute or by setting +C to trueish. + =head1 FUNCTIONS =head2 LOW-LEVEL FUNCTIONS -=over 4 - -=item C - -Converts a name to a HTML id by replacing various characters. +The following items are just forwarded to L: -=item C - -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 +=item * C -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 Etag/E tag will be created. Attributes -are key/value pairs added to the opening tag. +=item * C -C<$content_string> is not HTML escaped. +=item * C =back =head2 HIGH-LEVEL FUNCTIONS -=over 4 - -=item C +The following functions are just forwarded to L: -Creates a HTML 'select' tag named C<$name> with the contents of one -'EoptionE' 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. - -=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, I and may contain I keys that name the keys in the element to use -for the value, title and default respectively. +=item * C -=item 4. A blessed reference. In this case C<%attributes> must contain -I, I and may contain I keys that name functions called on the blessed -reference whose return values are used as the value, title and default -respectively. +=item * C =back -For cases 3 and 4 C<$attributes{value_key}> defaults to C, -C<$attributes{title_key}> defaults to C<$attributes{value_key}> -and C<$attributes{default_key}> defaults to C. - -In addition to pure keys/method you can also provide coderefs as I -and/or I and/or I. 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 may be provided, which in turn takes -precedence over the C and C subs. It will only be called once for each -element and must return a list of value and title. - -If the option C is set then an empty element (value -C) will be used as the first element. The title to display for -this element can be set with the option C and defaults to -an empty string. +Available high-level functions implemented in this module: -The option C 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 defaults to C. +=over 4 =item C @@ -778,12 +564,6 @@ calling L. C<$value> determines which entry is selected. The C<%attributes> are passed through to L. -=item C - -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 defaults to C. - =item C Creates a HTML 'input type=hidden' tag named C<$name> with the value @@ -798,9 +578,28 @@ tag's C defaults to C. If C<$attributes{confirm}> is set then a JavaScript popup dialog will be added via the C 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 + +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 in +C). The button's label will be C<$text>. + +=item C + +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 Creates a HTML 'textarea' tag named C<$name> with the content @@ -940,6 +739,11 @@ If trueish then the children will not be recolored. The default is to recolor the children by setting the class C on odd and C on even entries. +=item C + +An optional JavaScript string that is evaluated before sending the +POST request. The result must be a string that is appended to the URL. + =back Example: