X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=bc380882075bb3d7123cfdcf0542a9dd8f33ba6a;hb=549f187d3a2b1d15f96c4556714666ed954447bb;hp=19218dbb726f9e5fdd4f1428e56613acbef93970;hpb=9f75fa254b57b62156db30f809c4ee07124301a1;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index 19218dbb7..abb604693 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -2,6 +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; @@ -10,7 +19,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 ); } } @@ -19,212 +28,345 @@ sub _H { return $::locale->quote_special_chars('HTML', $string); } -sub _hashify { - return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_; +sub _J { + my $string = shift; + $string =~ s/(\"|\'|\\)/\\$1/g; + return $string; } sub new { - my $class = shift; - my $context = shift; + my ($class, $context, @args) = @_; - return bless { }, $class; + return bless { + CONTEXT => $context, + }, $class; } -sub name_to_id { - my $self = shift; - my $name = shift; +sub _context { + die 'not an accessor' if @_ > 1; + return $_[0]->{CONTEXT}; +} + +sub _call_presenter { + my ($method, $self, @args) = @_; + + my $presenter = $::request->presenter; - $name =~ s/[^\w_]/_/g; - $name =~ s/_+/_/g; + splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH'); - return $name; + if (my $sub = SL::Presenter::Simple->can($method)) { + return $sub->(@args); + } + + if ($presenter->can($method)) { + return $presenter->$method(@args); + } + + $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!"); + return; } -sub attributes { - my $self = shift; - my %options = _hashify(@_); +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 { + 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 yes_no_tag { + 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 stylesheet_tag { + my $self = shift; + my $code = ''; + + foreach my $file (@_) { + $file .= '.css' unless $file =~ m/\.css$/; + $file = "css/${file}" unless $file =~ m|/|; - my @result = (); - while (my ($name, $value) = each %options) { - next unless $name; - $value ||= ''; - push @result, _H($name) . '="' . _H($value) . '"'; + $code .= qq||; } - return @result ? ' ' . join(' ', @result) : ''; + return $code; } -sub html_tag { - my $self = shift; - my $tag = shift; - my $content = shift; - my $attributes = $self->attributes(@_); - return "<${tag}${attributes}/>" unless defined($content); - return "<${tag}${attributes}>${content}"; +# simple version with select_tag +sub vendor_selector { + 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 : ''; + + 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); } -sub select_tag { - my $self = shift; - my $name = shift; - my $options_str = shift; - my %attributes = _hashify(@_); - $attributes{id} ||= $self->name_to_id($name); - $options_str = $self->options_for_select($options_str) if ref $options_str; +# simple version with select_tag +sub part_selector { + 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 : ''; - return $self->html_tag('select', $options_str, %attributes, name => $name); + 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 textarea_tag { - my $self = shift; - my $name = shift; - my $content = shift; - my %attributes = _hashify(@_); - $attributes{id} ||= $self->name_to_id($name); - $content = $content ? '' : _H($content); +sub javascript_tag { + my $self = shift; + my $code = ''; - return $self->html_tag('textarea', $content, %attributes, name => $name); + foreach my $file (@_) { + $file .= '.js' unless $file =~ m/\.js$/; + $file = "js/${file}" unless $file =~ m|/|; + + $code .= qq||; + } + + return $code; } -sub checkbox_tag { - my $self = shift; - my $name = shift; - my %attributes = _hashify(@_); +sub tabbed { + my ($self, $tabs, %params) = _hashify(2, @_); + my $id = $params{id} || 'tab_' . _tag_id(); - $attributes{id} ||= $self->name_to_id($name); - $attributes{value} = 1 unless defined $attributes{value}; - my $label = delete $attributes{label}; + $params{selected} *= 1; - if ($attributes{checked}) { - $attributes{checked} = 'checked'; - } else { - delete $attributes{checked}; + 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 $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); } - my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox'); - $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label; + return '' unless @header; - return $code; + my $ul = $self->ul_tag(join('', @header), id => $id); + return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget'); } -sub radio_button_tag { - my $self = shift; - my $name = shift; - my %attributes = _hashify(@_); +sub tab { + my ($self, $name, $src, %params) = _hashify(3, @_); + + $params{method} ||= 'process'; - $attributes{value} = 1 unless defined $attributes{value}; - $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value}); - my $label = delete $attributes{label}; + return () if defined $params{if} && !$params{if}; - if ($attributes{checked}) { - $attributes{checked} = 'checked'; + my $data; + if ($params{method} eq 'raw') { + $data = $src; + } elsif ($params{method} eq 'process') { + $data = $self->_context->process($src, %{ $params{args} || {} }); } else { - delete $attributes{checked}; + die "unknown tag method '$params{method}'"; } - my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio'); - $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label; + return () unless $data; - return $code; + return +{ name => $name, data => $data }; } -sub input_tag { - my $self = shift; - my $name = shift; - my $value = shift; - my %attributes = _hashify(@_); +sub areainput_tag { + my ($self, $name, $value, %attributes) = _hashify(3, @_); - $attributes{id} ||= $self->name_to_id($name); - $attributes{type} ||= 'text'; + 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); - return $self->html_tag('input', undef, %attributes, name => $name, value => $value); -} + $attributes{id} ||= _tag_id(); + my $id = $attributes{id}; + + return $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols) if $rows > 1; -sub hidden_tag { - return shift->input_tag(@_, type => 'hidden'); + return '' + . $self->input_tag($name, $value, %attributes, size => $cols) + . "" + . ''; } -sub submit_tag { - return shift->input_tag(@_, type => 'submit', class => 'submit'); +sub multiselect2side { + my ($self, $id, %params) = _hashify(2, @_); + + $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 options_for_select { - my $self = shift; - my $collection = shift; - my %options = _hashify(@_); +sub sortable_element { + my ($self, $selector, %params) = _hashify(2, @_); - my $value_key = $options{value} || 'id'; - my $title_key = $options{title} || $value_key; + my %attributes = ( distance => 5, + helper => <<'JAVASCRIPT' ); + function(event, ui) { + ui.children().each(function() { + $(this).width($(this).width()); + }); + return ui; + } +JAVASCRIPT - my @elements = (); - push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty}; + my $stop_event = ''; - if ($collection && (ref $collection eq 'ARRAY')) { - foreach my $element (@{ $collection }) { - my @result = !ref $element ? ( $element, $element ) - : ref $element eq 'ARRAY' ? ( $element->[0], $element->[1] ) - : ref $element eq 'HASH' ? ( $element->{$value_key}, $element->{$title_key} ) - : ( $element->$value_key, $element->$title_key ); + 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}_', ''); })"; - push @elements, \@result; + my $params_js = $params{params} ? qq| + ($params{params})| : ''; + my $ajax_return = ''; + if ($params{ajax_return}) { + $ajax_return = 'kivi.eval_json_result'; } + + $stop_event = < $result->[0] ); - $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || '')); + if (!$params{dont_recolor}) { + $stop_event .= <*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0'); + \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1'); +JAVASCRIPT + } - $code .= $self->html_tag('option', _H($result->[1]), %attributes); + if ($stop_event) { + $attributes{stop} = < + \$(function() { + \$( "${selector}" ).sortable({ ${attr_str} }) + }); + +JAVASCRIPT + return $code; } -sub javascript { - my ($self, $data) = @_; - return $self->html_tag('script', $data, type => 'text/javascript'); +sub dump { + my $self = shift; + return '
' . Data::Dumper::Dumper(@_) . '
'; } -sub date_tag { - my ($self, $name, $value, @slurp) = @_; - my %params = _hashify(@slurp); - my $name_e = _H($name); - my $seq = _tag_id(); +sub sortable_table_header { + my ($self, $by, %params) = _hashify(2, @_); + + my $controller = $self->{CONTEXT}->stash->get('SELF'); + 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 = $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{sort_by} eq $by) { + my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down'; + $image = ''; + $new_dir = 1 - ($current_sort_params{sort_dir} || 0); + } - $params{cal_align} ||= 'BR'; + $params{ $models->sorted->form_params->[0] } = $by; + $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0'); - $self->input_tag($name, $value, - id => $name_e, - 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}), - %params, - ) . - $self->javascript( - "Calendar.setup({ inputField: '$name_e', ifFormat: '$::myconfig{jsc_dateformat}', align: '$params{cal_align}', button: 'trigger$seq' });" - ) : ''); + return '' . _H($title) . $image . ''; +} -sub javascript_tag { - my $self = shift; - my $code = ''; +sub paginate_controls { + my ($self, %params) = _hashify(1, @_); - foreach my $file (@_) { - $file .= '.js' unless $file =~ m/\.js$/; - $file = "js/${file}" unless $file =~ m|/|; + my $controller = $self->{CONTEXT}->stash->get('SELF'); + my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS'); + my $pager = $models->paginated; +# my $paginate_spec = $controller->get_paginate_spec; - $code .= qq||; - } + my %paginate_params = $models->get_paginate_args; - return $code; + my %template_params = ( + pages => \%paginate_params, + url_maker => sub { + 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 $models->get_callback(%url_params); + }, + %params, + ); + + return SL::Presenter->get->render('common/paginate', %template_params); } 1; @@ -241,98 +383,80 @@ 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 - -=item C - -Converts a name to a HTML id by replacing various characters. - -=item C +The following items are just forwarded to L: -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 +The following functions are just forwarded to L: -=item C +=over 2 -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. +=item * C -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. +=item * C -=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. +=item * C -=item C +=item * C -Creates a HTML 'textarea' tag named C<$name> with the content -C<$value> and with arbitrary HTML attributes from C<%attributes>. The -tag's C defaults to C. +=back -=item C +Available high-level functions implemented in this module: -Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary -HTML attributes from C<%attributes>. The tag's C defaults to -C. The tag's C defaults to C<1>. +=over 4 -If C<%attributes> contains a key C