X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=6db220296b9a318e9e068525f9c84ee9351343a4;hb=1b9d0f70b5e58c510ed2ab4337eb0f6512d779ca;hp=43ac5d2508ef40e837fd672c77b75d4af92f4d65;hpb=4e4bd8f9d9b5c89d42829011786d3766a0b926bf;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index 43ac5d250..6db220296 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -6,6 +6,8 @@ use List::MoreUtils qw(apply); use List::Util qw(max); use Scalar::Util qw(blessed); +use SL::Presenter; + use strict; { # This will give you an id for identifying html tags and such. @@ -17,19 +19,14 @@ 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); } sub _J { - my $string = "" . shift; - $string =~ s/\"/\\\"/g; + my $string = shift; + $string =~ s/(\"|\'|\\)/\\$1/g; return $string; } @@ -50,56 +47,47 @@ 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}"; +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, $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) : ''; @@ -111,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}; @@ -134,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}) { @@ -150,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 { @@ -192,7 +171,9 @@ sub submit_tag { 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'); } @@ -201,63 +182,29 @@ 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 options_for_select { - my $self = shift; - my $collection = shift; - my %options = _hashify(@_); +sub ajax_submit_tag { + my ($self, $url, $form_selector, $text, @slurp) = @_; - my $value_key = $options{value} || 'id'; - my $title_key = $options{title} || $value_key; + $url = _J($url); + $form_selector = _J($form_selector); + my $onclick = qq|submit_ajax_form('${url}', '${form_selector}')|; - my $value_sub = $options{value_sub}; - my $title_sub = $options{title_sub}; - - my $value_title_sub = $options{value_title_sub}; - - my %selected = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : defined($options{default}) ? [ $options{default} ] : [] }; - - 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; - }; - - 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'; - - my $code = ''; - foreach my $result (@elements) { - my %attributes = ( value => $result->[0] ); - $attributes{selected} = 'selected' if $selected{ defined($result->[0]) ? $result->[0] : '' }; - - $code .= $self->html_tag('option', _H($result->[1]), %attributes); - } - - return $code; + return $self->button_tag($onclick, $text, @slurp); } sub yes_no_tag { my ($self, $name, $value) = splice @_, 0, 3; my %attributes = _hashify(@_); - my $options = $self->options_for_select([ [ 1, $::locale->text('Yes') ], [ 0, $::locale->text('No') ] ], default => $value ? 1 : 0); - return $self->select_tag($name, $options, %attributes); + return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes); } sub javascript { @@ -279,75 +226,32 @@ 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 { my ($self, $name, $value, %params) = @_; my $name_e = _H($name); - $self->hidden_tag($name, (ref $value && $value->can('id')) ? $value->id : '') . - $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params) . - $self->javascript(<{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 @@ -356,12 +260,12 @@ sub vendor_selector { my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) : (ref $value && $value->can('id')) ? $value->id : ''; - my $options_str = $self->options_for_select(SL::DB::Manager::Vendor->get_all(), - default => $actual_vendor_id, - title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name }, - 'with_empty' => 1); - return $self->select_tag($name, $options_str, %params); + 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); } @@ -371,12 +275,12 @@ sub part_selector { my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) : (ref $value && $value->can('id')) ? $value->id : ''; - my $options_str = $self->options_for_select(SL::DB::Manager::Part->get_all(), - default => $actual_part_id, - title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description }, - 'with_empty' => 1); - return $self->select_tag($name, $options_str, %params); + 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); } @@ -410,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 { @@ -570,6 +462,50 @@ sub dump { 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__ @@ -584,72 +520,64 @@ 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 Creates a HTML 'select' tag with the two entries C and C by -calling L and L. C<$value> determines +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 @@ -664,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 @@ -687,13 +634,10 @@ If C<%attributes> contains a key C then the value is taken as a JQuery selector and clicking this checkbox will also toggle all checkboxes matching the selector. -=item C $align_code, %attributes> +=item C 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, see Calendar documentation for -the details, usually you'll want a two letter abbreviation of the alignment. -Right + Bottom becomes C. +calendar on click. =item C @@ -719,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 $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, see Calendar documentation for -the details, usually you'll want a two letter abbreviation of the alignment. -Right + Bottom becomes C. - =item C Will create a tabbed area. The tabs should be created with the helper function @@ -737,9 +673,6 @@ C. Example: L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab), ]) %] -An optional attribute is C, which accepts the ordinal of a tab which -should be selected by default. - =item C Creates a generic input tag or textarea tag, depending on content size. The @@ -852,57 +785,34 @@ containing the values C<[ 6, 2, 15 ]>. Dumps the Argument using L into a EpreE block. -=back +=item C -=head2 CONVERSION FUNCTIONS +Create a link and image suitable for placement in a table +header. C<$by> must be an index set up by the controller with +L. -=over 4 +The optional parameter C<$params{title}> can override the column title +displayed to the user. Otherwise the column title from the +controller's sort spec is used. -=item C +The other parameters in C<%params> are passed unmodified to the +underlying call to L. -Creates a string suitable for a HTML 'select' tag consisting of one -'EoptionE' tag for each element in C<\@collection>. 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: +See the documentation of L for an +overview and further usage instructions. -=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. +Create a set of links used to paginate a list view. -=item 2. A scalar. The scalar is both the value and the title. - -=item 3. A hash reference. In this case C<%options> must contain -I and I keys that name the keys in the element to use -for the value and title respectively. - -=item 4. A blessed reference. In this case C<%options> must contain -I<value> and I<title> keys that name functions called on the blessed -reference whose return values are used as the value and title -respectively. +See the documentation of L<SL::Controller::Helper::Paginated> for an +overview and further usage instructions. =back -For cases 3 and 4 C<$options{value}> defaults to C<id> and -C<$options{title}> defaults to C<$options{value}>. - -In addition to pure keys/method you can also provide coderefs as I<value_sub> -and/or I<title_sub>. If present, these take precedence over keys or methods, -and are called with the element as first argument. It must return the value or -title. - -Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes -precedence over each individual sub. 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. +=head2 CONVERSION FUNCTIONS -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. +=over 4 =item C<tab, description, target, %PARAMS> @@ -918,6 +828,14 @@ 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]> + +See L<SL::Presenter::Text/truncate>. + +=item C<simple_format $text> + +See L<SL::Presenter::Text/simple_format>. + =back =head1 MODULE AUTHORS