X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=abb6046936e536139b641f65976acd10b994405b;hb=53593baa211863fbf66540cf1bcc36c8fb37257f;hp=8de38ab1708893dc4a1b851141a0cd414af1b118;hpb=072c82159a805189a5c6e39c6e5fb35f91cc01d0;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index 8de38ab17..abb604693 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -2,11 +2,15 @@ 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::Presenter::ALL; +use SL::Presenter::Simple; +use SL::Util qw(_hashify); use strict; @@ -19,11 +23,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 +34,6 @@ sub _J { return $string; } -sub _hashify { - return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_; -} - sub new { my ($class, $context, @args) = @_; @@ -53,237 +48,49 @@ sub _context { } sub _call_presenter { - my ($method, @args) = @_; + my ($method, $self, @args) = @_; - my $presenter = $::request->presenter; - - return '' unless $presenter->can($method); + my $presenter = $::request->presenter; 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; - - $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) . '"'; + if (my $sub = SL::Presenter::Simple->can($method)) { + return $sub->(@args); } - 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 img_tag { - my ($self, @slurp) = @_; - my %options = _hashify(@slurp); - - $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 $with_optgroups = delete($attributes{with_optgroups}); - - my %selected; - - if ( ref($attributes{default}) eq 'ARRAY' ) { - - foreach my $entry (@{$attributes{default}}) { - $selected{$entry} = 1; - } - } elsif ( defined($attributes{default}) ) { - $selected{$attributes{default}} = 1; + if ($presenter->can($method)) { + return $presenter->$method(@args); } - delete($attributes{default}); - - - my @all_options; - push @all_options, [undef, $empty_title || ''] if $with_empty; - - my $normalize_entry = sub { - my ($type, $entry, $sub, $key) = @_; - - return $sub->($entry) if $sub; - - my $ref = ref($entry); - - if ( !$ref ) { - return $entry if $type eq 'value' || $type eq 'title'; - return 0; - } - - if ( $ref eq 'ARRAY' ) { - return $entry->[ $type eq 'value' ? 0 : $type eq 'title' ? 1 : 2 ]; - } - - return $entry->{$key} if $ref eq 'HASH'; - return $entry->$key if $type ne 'default' || $entry->can($key); - return undef; - }; - - my $list_to_code = sub { - my ($sub_collection) = @_; - - my @options; - foreach my $entry ( @{ $sub_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) { - $entry->[2] = 1 if $selected{$entry->[0]}; - } - - return join '', map { $self->html_tag('option', _H($_->[1]), value => $_->[0], selected => $_->[2]) } @options; - }; - - my $code; - - if (!$with_optgroups) { - $code = $list_to_code->($collection); - - } else { - $code = join '', map { - my ($optgroup_title, $sub_collection) = @{ $_ }; - $self->html_tag('optgroup', $list_to_code->($sub_collection), label => $optgroup_title) - } @{ $collection }; - } - - return $self->html_tag('select', $code, %attributes, name => $name); -} - -sub textarea_tag { - my ($self, $name, $content, @slurp) = @_; - my %attributes = _hashify(@slurp); - - $attributes{id} ||= $self->name_to_id($name); - $attributes{rows} *= 1; # required by standard - $attributes{cols} *= 1; # required by standard - $content = $content ? _H($content) : ''; - - return $self->html_tag('textarea', $content, %attributes, name => $name); -} - -sub checkbox_tag { - 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'; - } 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; - $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall; - - return $code; -} - -sub radio_button_tag { - my $self = shift; - my $name = shift; - my %attributes = _hashify(@_); - - $attributes{value} = 1 unless defined $attributes{value}; - $attributes{id} ||= $self->name_to_id($name . "_" . $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 => 'radio'); - $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label; - - 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'); -} - -sub div_tag { - my ($self, $content, @slurp) = @_; - return $self->html_tag('div', $content, @slurp); + $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!"); + return; +} + +sub name_to_id { return _call_presenter('name_to_id', @_); } +sub html_tag { return _call_presenter('html_tag', @_); } +sub hidden_tag { return _call_presenter('hidden_tag', @_); } +sub select_tag { return _call_presenter('select_tag', @_); } +sub checkbox_tag { return _call_presenter('checkbox_tag', @_); } +sub input_tag { return _call_presenter('input_tag', @_); } +sub javascript { return _call_presenter('javascript', @_); } +sub truncate { return _call_presenter('truncate', @_); } +sub simple_format { return _call_presenter('simple_format', @_); } +sub button_tag { return _call_presenter('button_tag', @_); } +sub submit_tag { return _call_presenter('submit_tag', @_); } +sub ajax_submit_tag { return _call_presenter('ajax_submit_tag', @_); } +sub link { return _call_presenter('link_tag', @_); } +sub input_number_tag { return _call_presenter('input_number_tag', @_); } +sub textarea_tag { return _call_presenter('textarea_tag', @_); } +sub date_tag { return _call_presenter('date_tag', @_); } +sub div_tag { return _call_presenter('div_tag', @_); } +sub radio_button_tag { return _call_presenter('radio_button_tag', @_); } +sub img_tag { return _call_presenter('img_tag', @_); } +sub restricted_html { return _call_presenter('restricted_html', @_); } +sub stripped_html { return _call_presenter('stripped_html', @_); } + +sub _set_id_attribute { + my ($attributes, $name, $unique) = @_; + SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique); } sub ul_tag { @@ -296,48 +103,12 @@ sub li_tag { 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 { - my ($self, $name, $value, @slurp) = @_; - my %attributes = _hashify(@slurp); - - if ( $attributes{confirm} ) { - $attributes{onclick} = 'return confirm("'. _J(delete($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); - - $attributes{id} ||= $self->name_to_id($attributes{name}) if $attributes{name}; - $attributes{type} ||= 'button'; - - return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick); -} - 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); } -sub javascript { - my ($self, $data) = @_; - return $self->html_tag('script', $data, type => 'text/javascript'); -} - sub stylesheet_tag { my $self = shift; my $code = ''; @@ -352,38 +123,10 @@ sub stylesheet_tag { return $code; } -my $date_tag_id_idx = 0; -sub date_tag { - my ($self, $name, $value, @slurp) = @_; - - my %params = _hashify(@slurp); - my $id = $self->name_to_id($name) . _tag_id(); - 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, - id => $id, - size => 11, - onblur => "check_right_date_format(this);", - %params, - @class, @onchange, - ); -} - -sub customer_picker { - my ($self, $name, $value, %params) = @_; - my $name_e = _H($name); - - $::request->{layout}->add_javascripts('autocomplete_customer.js'); - - $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') . - $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params); -} # simple version with select_tag sub vendor_selector { - my ($self, $name, $value, %params) = @_; + my ($self, $name, $value, %params) = _hashify(3, @_); my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) : (ref $value && $value->can('id')) ? $value->id : ''; @@ -398,7 +141,7 @@ sub vendor_selector { # simple version with select_tag sub part_selector { - my ($self, $name, $value, %params) = @_; + my ($self, $name, $value, %params) = _hashify(3, @_); my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) : (ref $value && $value->can('id')) ? $value->id : ''; @@ -426,8 +169,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; @@ -453,8 +195,7 @@ sub tabbed { } sub tab { - my ($self, $name, $src, @slurp) = @_; - my %params = _hashify(@slurp); + my ($self, $name, $src, %params) = _hashify(3, @_); $params{method} ||= 'process'; @@ -475,27 +216,26 @@ 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; + my $cols = delete $attributes{cols} || delete $attributes{size}; + my $minrows = delete $attributes{min_rows} || 1; + my $maxrows = delete $attributes{max_rows}; + my $rows = $::form->numtextrows($value, $cols, $maxrows, $minrows); - if (exists $attributes{cols}) { - $cols = delete $attributes{cols}; - $rows = $::form->numtextrows($value, $cols); - } else { - $rows = delete $attributes{rows} || 1; - } + $attributes{id} ||= _tag_id(); + my $id = $attributes{id}; - return $rows > 1 - ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ())) - : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ())); + return $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols) if $rows > 1; + + return '' + . $self->input_tag($name, $value, %attributes, size => $cols) + . "" + . ''; } 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')) . "\""; @@ -514,8 +254,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' ); @@ -534,8 +273,14 @@ 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})| : ''; + my $ajax_return = ''; + if ($params{ajax_return}) { + $ajax_return = 'kivi.eval_json_result'; + } + $stop_event = <text('Help'); - - die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/; - return unless -f $file; - return $self->html_tag('a', $text, href => $file, class => 'jqModal') -} - 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; + my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS'); + my $sort_spec = $models->get_sort_spec; my $by_spec = $sort_spec->{$by}; - my %current_sort_params = $controller->get_current_sort_params; + my %current_sort_params = $models->get_current_sort_params; my ($image, $new_dir) = ('', $current_sort_params{dir}); my $title = delete($params{title}) || $::locale->text($by_spec->{title}); - if ($current_sort_params{by} eq $by) { - my $current_dir = $current_sort_params{dir} ? 'up' : 'down'; + if ($current_sort_params{sort_by} eq $by) { + my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down'; $image = ''; - $new_dir = 1 - ($current_sort_params{dir} || 0); + $new_dir = 1 - ($current_sort_params{sort_dir} || 0); } - $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by; - $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0'); + $params{ $models->sorted->form_params->[0] } = $by; + $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0'); - return '' . _H($title) . $image . ''; + return '' . _H($title) . $image . ''; } sub paginate_controls { - my ($self) = @_; + my ($self, %params) = _hashify(1, @_); my $controller = $self->{CONTEXT}->stash->get('SELF'); - my $paginate_spec = $controller->get_paginate_spec; - my %paginate_params = $controller->get_current_paginate_params; + my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS'); + my $pager = $models->paginated; +# my $paginate_spec = $controller->get_paginate_spec; + + my %paginate_params = $models->get_paginate_args; my %template_params = ( pages => \%paginate_params, url_maker => sub { - my %url_params = _hashify(@_); - $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}; + my %url_params = _hashify(0, @_); + $url_params{ $pager->form_params->[0] } = delete $url_params{page}; + $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page}; - return $controller->get_callback(%url_params); + return $models->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__ @@ -672,118 +398,48 @@ 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 +The following items are just forwarded to L: -=item C - -Converts a name to a HTML id by replacing various characters. - -=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 2 -=over 12 +=item * C -=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 * C -=item 2. A scalar. The scalar is both the value and the title. +=item * C -=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. - -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. - -If the option C is set then this function expects -C<\@collection> to be one level deeper. The upper-most level is -translated into a HTML C tag. So the structure becomes: +Available high-level functions implemented in this module: =over 4 -=item 1. Array of array references. Each element in the -C<\@collection> is converted into an optgroup. - -=item 2. The optgroup's C