X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=6db220296b9a318e9e068525f9c84ee9351343a4;hb=da2fecb453416b3731a896ab6d35e9992be3d9eb;hp=dc06e8a9998821684767a1330247eedbf8447cb6;hpb=ffdfdc7ec6ab9888bddae77697f3476726b01bd3;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index dc06e8a99..6db220296 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -3,6 +3,10 @@ package SL::Template::Plugin::L; use base qw( Template::Plugin ); use Template::Plugin; use List::MoreUtils qw(apply); +use List::Util qw(max); +use Scalar::Util qw(blessed); + +use SL::Presenter; use strict; @@ -11,7 +15,7 @@ use strict; # Do not use these id's to store information across requests. my $_id_sequence = int rand 1e7; sub _tag_id { - return $_id_sequence = ($_id_sequence + 1) % 1e7; + return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 ); } } @@ -20,6 +24,12 @@ sub _H { return $::locale->quote_special_chars('HTML', $string); } +sub _J { + my $string = shift; + $string =~ s/(\"|\'|\\)/\\$1/g; + return $string; +} + sub _hashify { return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_; } @@ -37,72 +47,62 @@ sub _context { return $_[0]->{CONTEXT}; } -sub name_to_id { - my $self = shift; - my $name = shift; - - $name =~ s/[^\w_]/_/g; - $name =~ s/_+/_/g; +sub _call_presenter { + my ($method, $self, @args) = @_; - return $name; -} - -sub attributes { - my $self = shift; - my %options = _hashify(@_); + my $presenter = $::request->presenter; - my @result = (); - while (my ($name, $value) = each %options) { - next unless $name; - $value = '' if !defined($value); - push @result, _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 = shift; - my $tag = shift; - my $content = shift; - my $attributes = $self->attributes(@_); +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}"; +sub _set_id_attribute { + my ($attributes, $name) = @_; + SL::Presenter::Tag::_set_id_attribute($attributes, $name); } -sub select_tag { - my $self = shift; - my $name = shift; - my $options_str = shift; - my %attributes = _hashify(@_); +sub img_tag { + my ($self, @slurp) = @_; + my %options = _hashify(@slurp); - $attributes{id} ||= $self->name_to_id($name); - $options_str = $self->options_for_select($options_str) if ref $options_str; + $options{alt} ||= ''; - return $self->html_tag('select', $options_str, %attributes, name => $name); + return $self->html_tag('img', undef, %options); } 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); + _set_id_attribute(\%attributes, $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 = shift; - my $name = shift; - my %attributes = _hashify(@_); + 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}; if ($attributes{checked}) { $attributes{checked} = 'checked'; @@ -112,6 +112,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; } @@ -121,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}) { @@ -137,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 { @@ -176,57 +168,43 @@ 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}; + if ( $attributes{confirm} ) { + $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");'; + } return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit'); } -sub options_for_select { - my $self = shift; - my $collection = shift; - my %options = _hashify(@_); +sub button_tag { + my ($self, $onclick, $value, @slurp) = @_; + my %attributes = _hashify(@slurp); - my $value_key = $options{value} || 'id'; - my $title_key = $options{title} || $value_key; + _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name}; + $attributes{type} ||= 'button'; - my $value_sub = $options{value_sub}; - my $title_sub = $options{title_sub}; + $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm}; - my $value_title_sub = $options{value_title_sub}; + return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick); +} - my $access = sub { - my ($element, $index, $key, $sub) = @_; - my $ref = ref $element; - return $sub ? $sub->($element) - : !$ref ? $element - : $ref eq 'ARRAY' ? $element->[$index] - : $ref eq 'HASH' ? $element->{$key} - : $element->$key; - }; +sub ajax_submit_tag { + my ($self, $url, $form_selector, $text, @slurp) = @_; - my @elements = (); - push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty}; - push @elements, map [ - $value_title_sub ? $value_title_sub->($_) : ( - $access->($_, 0, $value_key, $value_sub), - $access->($_, 1, $title_key, $title_sub), - ) - ], @{ $collection } if $collection && ref $collection eq 'ARRAY'; + $url = _J($url); + $form_selector = _J($form_selector); + my $onclick = qq|submit_ajax_form('${url}', '${form_selector}')|; - my $code = ''; - foreach my $result (@elements) { - my %attributes = ( value => $result->[0] ); - $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || '')); + return $self->button_tag($onclick, $text, @slurp); +} - $code .= $self->html_tag('option', _H($result->[1]), %attributes); - } +sub yes_no_tag { + my ($self, $name, $value) = splice @_, 0, 3; + my %attributes = _hashify(@_); - return $code; + return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes); } sub javascript { @@ -234,35 +212,77 @@ 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||; + } + + 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"}; - - $params{cal_align} ||= 'BR'; - - $self->input_tag($name, $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)', - %params, - ) . ((!$params{no_cal}) ? - $self->html_tag('img', undef, - src => 'image/calendar.png', - id => "trigger$seq", - title => _H($::myconfig{dateformat}), + onblur => "check_right_date_format(this);", %params, - ) . - $self->javascript( - "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });" - ) : ''); + @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 $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) : + (ref $value && $value->can('id')) ? $value->id : ''; + + return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(), + default => $actual_vendor_id, + title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name }, + 'with_empty' => 1, + %params); +} + + +# simple version with select_tag +sub part_selector { + my ($self, $name, $value, %params) = @_; + + my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) : + (ref $value && $value->can('id')) ? $value->id : ''; + + return $self->select_tag($name, SL::DB::Manager::Part->get_all(), + default => $actual_part_id, + title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description }, + with_empty => 1, + %params); +} + sub javascript_tag { my $self = shift; @@ -281,7 +301,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; @@ -294,27 +314,15 @@ sub tabbed { next if $tab eq ''; - my $selected = $params{selected} == $i; - my $tab_id = _tag_id(); - 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 { @@ -339,6 +347,165 @@ sub tab { return +{ name => $name, data => $data }; } +sub areainput_tag { + my ($self, $name, $value, @slurp) = @_; + my %attributes = _hashify(@slurp); + + my ($rows, $cols); + my $min = delete $attributes{min_rows} || 1; + + if (exists $attributes{cols}) { + $cols = delete $attributes{cols}; + $rows = $::form->numtextrows($value, $cols); + } else { + $rows = delete $attributes{rows} || 1; + } + + 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) : ())); +} + +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 = < + \$().ready(function() { + \$('#${id}').multiselect2side({ ${vars} }); + }); + +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 = <*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0'); + \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1'); +JAVASCRIPT + } + + if ($stop_event) { + $attributes{stop} = < + \$(function() { + \$( "${selector}" ).sortable({ ${attr_str} }) + }); + +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, class => 'jqModal') +} + +sub dump { + my $self = shift; + require Data::Dumper; + return '
' . Data::Dumper::Dumper(@_) . '
'; +} + +sub sortable_table_header { + my ($self, $by, @slurp) = @_; + my %params = _hashify(@slurp); + + my $controller = $self->{CONTEXT}->stash->get('SELF'); + my $sort_spec = $controller->get_sort_spec; + my $by_spec = $sort_spec->{$by}; + my %current_sort_params = $controller->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'; + $image = ''; + $new_dir = 1 - ($current_sort_params{dir} || 0); + } + + $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by; + $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0'); + + return '' . _H($title) . $image . ''; +} + +sub paginate_controls { + my ($self) = @_; + + my $controller = $self->{CONTEXT}->stash->get('SELF'); + my $paginate_spec = $controller->get_paginate_spec; + my %paginate_params = $controller->get_current_paginate_params; + + 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}; + + return $controller->get_callback(%url_params); + }, + ); + + return SL::Presenter->get->render('common/paginate', %template_params); +} + 1; __END__ @@ -353,64 +520,63 @@ Usage from a template: [% USE L %] - [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %] + [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %] + + [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' }, + { direction => 'right', display => 'To the right' } ], + value_key => 'direction', title_key => 'display', default => 'right')) %] - [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' }, - { direction => 'right', display => 'To the right' } ], - value => 'direction', title => 'display', default => 'right')) %] + [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' }, + { direction => 'right', display => 'To the right', selected => 1 } ], + value_key => 'direction', title_key => 'display')) %] =head1 DESCRIPTION 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 +=over 2 -Converts a name to a HTML id by replacing various characters. +=item * C -=item C +=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. +=item * C -=item C +=back -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. +=head2 HIGH-LEVEL FUNCTIONS -C<$content_string> is not HTML escaped. +The following functions are just forwarded to L: -=back +=over 2 -=head2 HIGH-LEVEL FUNCTIONS +=item * C -=over 4 +=item * C -=item C +=back -Creates a HTML 'select' tag named C<$name> with the contents -C<$options_string> and with arbitrary HTML attributes from -C<%attributes>. The tag's C defaults to C. +Available high-level functions implemented in this module: -The C<$options_string> is usually created by the -L function. If C<$options_string> is an array -reference then it will be passed to L -automatically. +=over 4 -=item C +=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. +Creates a HTML 'select' tag with the two entries C and C by +calling L. C<$value> determines +which entry is selected. The C<%attributes> are passed through to +L. =item C @@ -426,9 +592,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 @@ -445,13 +630,14 @@ If C<%attributes> contains a key C