1 package SL::Template::Plugin::L;
3 use base qw( Template::Plugin );
6 use List::MoreUtils qw(apply);
7 use List::Util qw(max);
8 use Scalar::Util qw(blessed);
11 use SL::Util qw(_hashify);
15 { # This will give you an id for identifying html tags and such.
16 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
17 # Do not use these id's to store information across requests.
18 my $_id_sequence = int rand 1e7;
20 return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
26 return $::locale->quote_special_chars('HTML', $string);
31 $string =~ s/(\"|\'|\\)/\\$1/g;
36 my ($class, $context, @args) = @_;
44 die 'not an accessor' if @_ > 1;
45 return $_[0]->{CONTEXT};
49 my ($method, $self, @args) = @_;
51 my $presenter = $::request->presenter;
53 if (!$presenter->can($method)) {
54 $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
58 splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
60 $presenter->$method(@args);
63 sub name_to_id { return _call_presenter('name_to_id', @_); }
64 sub html_tag { return _call_presenter('html_tag', @_); }
65 sub select_tag { return _call_presenter('select_tag', @_); }
66 sub input_tag { return _call_presenter('input_tag', @_); }
67 sub truncate { return _call_presenter('truncate', @_); }
68 sub simple_format { return _call_presenter('simple_format', @_); }
69 sub part_picker { return _call_presenter('part_picker', @_); }
70 sub chart_picker { return _call_presenter('chart_picker', @_); }
71 sub customer_vendor_picker { return _call_presenter('customer_vendor_picker', @_); }
73 sub _set_id_attribute {
74 my ($attributes, $name, $unique) = @_;
75 SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique);
79 my ($self, %options) = _hashify(1, @_);
83 return $self->html_tag('img', undef, %options);
87 my ($self, $name, $content, %attributes) = _hashify(3, @_);
89 _set_id_attribute(\%attributes, $name);
90 $attributes{rows} *= 1; # required by standard
91 $attributes{cols} *= 1; # required by standard
92 $content = $content ? _H($content) : '';
94 return $self->html_tag('textarea', $content, %attributes, name => $name);
98 my ($self, $name, %attributes) = _hashify(2, @_);
100 _set_id_attribute(\%attributes, $name);
101 $attributes{value} = 1 unless defined $attributes{value};
102 my $label = delete $attributes{label};
103 my $checkall = delete $attributes{checkall};
104 my $for_submit = delete $attributes{for_submit};
106 if ($attributes{checked}) {
107 $attributes{checked} = 'checked';
109 delete $attributes{checked};
113 $code .= $self->hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit;
114 $code .= $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
115 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
116 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
121 sub radio_button_tag {
122 my ($self, $name, %attributes) = _hashify(2, @_);
124 $attributes{value} = 1 unless exists $attributes{value};
126 _set_id_attribute(\%attributes, $name, 1);
127 my $label = delete $attributes{label};
129 if ($attributes{checked}) {
130 $attributes{checked} = 'checked';
132 delete $attributes{checked};
135 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
136 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
142 my ($self, $name, $value, %attributes) = _hashify(3, @_);
143 return $self->input_tag($name, $value, %attributes, type => 'hidden');
147 my ($self, $content, @slurp) = @_;
148 return $self->html_tag('div', $content, @slurp);
152 my ($self, $content, @slurp) = @_;
153 return $self->html_tag('ul', $content, @slurp);
157 my ($self, $content, @slurp) = @_;
158 return $self->html_tag('li', $content, @slurp);
162 my ($self, $href, $content, %params) = _hashify(3, @_);
166 return $self->html_tag('a', $content, %params, href => $href);
170 my ($self, $name, $value, %attributes) = _hashify(3, @_);
172 if ( $attributes{confirm} ) {
173 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
176 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
180 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
182 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
183 $attributes{type} ||= 'button';
185 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
187 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
190 sub ajax_submit_tag {
191 my ($self, $url, $form_selector, $text, @slurp) = @_;
194 $form_selector = _J($form_selector);
195 my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
197 return $self->button_tag($onclick, $text, @slurp);
201 my ($self, $name, $value, %attributes) = _hashify(3, @_);
203 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
207 my ($self, $data) = @_;
208 return $self->html_tag('script', $data, type => 'text/javascript');
215 foreach my $file (@_) {
216 $file .= '.css' unless $file =~ m/\.css$/;
217 $file = "css/${file}" unless $file =~ m|/|;
219 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
225 my $date_tag_id_idx = 0;
227 my ($self, $name, $value, %params) = _hashify(3, @_);
229 _set_id_attribute(\%params, $name);
230 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
231 my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker');
232 push @classes, delete($params{class}) if $params{class};
233 my %class = @classes ? (class => join(' ', @classes)) : ();
235 $::request->presenter->need_reinit_widgets($params{id});
237 return $self->input_tag(
238 $name, blessed($value) ? $value->to_lxoffice : $value,
240 onblur => "check_right_date_format(this);",
246 # simple version with select_tag
247 sub vendor_selector {
248 my ($self, $name, $value, %params) = _hashify(3, @_);
250 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
251 (ref $value && $value->can('id')) ? $value->id : '';
253 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
254 default => $actual_vendor_id,
255 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
261 # simple version with select_tag
263 my ($self, $name, $value, %params) = _hashify(3, @_);
265 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
266 (ref $value && $value->can('id')) ? $value->id : '';
268 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
269 default => $actual_part_id,
270 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
280 foreach my $file (@_) {
281 $file .= '.js' unless $file =~ m/\.js$/;
282 $file = "js/${file}" unless $file =~ m|/|;
284 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
291 my ($self, $tabs, %params) = _hashify(2, @_);
292 my $id = $params{id} || 'tab_' . _tag_id();
294 $params{selected} *= 1;
296 die 'L.tabbed needs an arrayred of tabs for first argument'
297 unless ref $tabs eq 'ARRAY';
299 my (@header, @blocks);
300 for my $i (0..$#$tabs) {
301 my $tab = $tabs->[$i];
305 my $tab_id = "__tab_id_$i";
306 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
307 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
310 return '' unless @header;
312 my $ul = $self->ul_tag(join('', @header), id => $id);
313 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
317 my ($self, $name, $src, %params) = _hashify(3, @_);
319 $params{method} ||= 'process';
321 return () if defined $params{if} && !$params{if};
324 if ($params{method} eq 'raw') {
326 } elsif ($params{method} eq 'process') {
327 $data = $self->_context->process($src, %{ $params{args} || {} });
329 die "unknown tag method '$params{method}'";
332 return () unless $data;
334 return +{ name => $name, data => $data };
338 my ($self, $name, $value, %attributes) = _hashify(3, @_);
340 my $cols = delete $attributes{cols} || delete $attributes{size};
341 my $minrows = delete $attributes{min_rows} || 1;
342 my $maxrows = delete $attributes{max_rows};
343 my $rows = $::form->numtextrows($value, $cols, $maxrows, $minrows);
346 ? $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols)
347 : $self->input_tag($name, $value, %attributes, size => $cols);
350 sub multiselect2side {
351 my ($self, $id, %params) = _hashify(2, @_);
353 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
354 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
355 $params{moveOptions} = 'false';
357 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
359 <script type="text/javascript">
360 \$().ready(function() {
361 \$('#${id}').multiselect2side({ ${vars} });
369 sub sortable_element {
370 my ($self, $selector, %params) = _hashify(2, @_);
372 my %attributes = ( distance => 5,
373 helper => <<'JAVASCRIPT' );
374 function(event, ui) {
375 ui.children().each(function() {
376 $(this).width($(this).width());
384 if ($params{url} && $params{with}) {
385 my $as = $params{as} || $params{with};
386 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
387 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
389 my $params_js = $params{params} ? qq| + ($params{params})| : '';
391 $stop_event = <<JAVASCRIPT;
392 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
396 if (!$params{dont_recolor}) {
397 $stop_event .= <<JAVASCRIPT;
398 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
399 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
404 $attributes{stop} = <<JAVASCRIPT;
405 function(event, ui) {
412 $params{handle} = '.dragdrop' unless exists $params{handle};
413 $attributes{handle} = "'$params{handle}'" if $params{handle};
415 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
417 my $code = <<JAVASCRIPT;
418 <script type="text/javascript">
420 \$( "${selector}" ).sortable({ ${attr_str} })
430 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
433 sub sortable_table_header {
434 my ($self, $by, %params) = _hashify(2, @_);
436 my $controller = $self->{CONTEXT}->stash->get('SELF');
437 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
438 my $sort_spec = $models->get_sort_spec;
439 my $by_spec = $sort_spec->{$by};
440 my %current_sort_params = $models->get_current_sort_params;
441 my ($image, $new_dir) = ('', $current_sort_params{dir});
442 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
444 if ($current_sort_params{sort_by} eq $by) {
445 my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
446 $image = '<img border="0" src="image/' . $current_dir . '.png">';
447 $new_dir = 1 - ($current_sort_params{sort_dir} || 0);
450 $params{ $models->sorted->form_params->[0] } = $by;
451 $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
453 return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
456 sub paginate_controls {
457 my ($self, %params) = _hashify(1, @_);
459 my $controller = $self->{CONTEXT}->stash->get('SELF');
460 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
461 my $pager = $models->paginated;
462 # my $paginate_spec = $controller->get_paginate_spec;
464 my %paginate_params = $models->get_paginate_args;
466 my %template_params = (
467 pages => \%paginate_params,
469 my %url_params = _hashify(0, @_);
470 $url_params{ $pager->form_params->[0] } = delete $url_params{page};
471 $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
473 return $models->get_callback(%url_params);
478 return SL::Presenter->get->render('common/paginate', %template_params);
487 SL::Templates::Plugin::L -- Layouting / tag generation
491 Usage from a template:
495 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
497 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
498 { direction => 'right', display => 'To the right' } ],
499 value_key => 'direction', title_key => 'display', default => 'right')) %]
501 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
502 { direction => 'right', display => 'To the right', selected => 1 } ],
503 value_key => 'direction', title_key => 'display')) %]
507 A module modeled a bit after Rails' ActionView helpers. Several small
508 functions that create HTML tags from various kinds of data sources.
510 The C<id> attribute is usually calculated automatically. This can be
511 overridden by either specifying an C<id> attribute or by setting
516 =head2 LOW-LEVEL FUNCTIONS
518 The following items are just forwarded to L<SL::Presenter::Tag>:
522 =item * C<name_to_id $name>
524 =item * C<stringify_attributes %items>
526 =item * C<html_tag $tag_name, $content_string, %attributes>
530 =head2 HIGH-LEVEL FUNCTIONS
532 The following functions are just forwarded to L<SL::Presenter::Tag>:
536 =item * C<input_tag $name, $value, %attributes>
538 =item * C<select_tag $name, \@collection, %attributes>
542 Available high-level functions implemented in this module:
546 =item C<yes_no_tag $name, $value, %attributes>
548 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
549 calling L<select_tag>. C<$value> determines
550 which entry is selected. The C<%attributes> are passed through to
553 =item C<hidden_tag $name, $value, %attributes>
555 Creates a HTML 'input type=hidden' tag named C<$name> with the value
556 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
557 tag's C<id> defaults to C<name_to_id($name)>.
559 =item C<submit_tag $name, $value, %attributes>
561 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
562 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
563 tag's C<id> defaults to C<name_to_id($name)>.
565 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
566 be added via the C<onclick> handler asking the question given with
567 C<$attributes{confirm}>. The request is only submitted if the user
568 clicks the dialog's ok/yes button.
570 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
572 Creates a HTML 'input type="button"' tag with a very specific onclick
573 handler that submits the form given by the jQuery selector
574 C<$form_selector> to the URL C<$url> (the actual JavaScript function
575 called for that is C<kivi.submit_ajax_form()> in
576 C<js/client_js.js>). The button's label will be C<$text>.
578 =item C<button_tag $onclick, $text, %attributes>
580 Creates a HTML 'input type="button"' tag with an onclick handler
581 C<$onclick> and a value of C<$text>. The button does not have a name
582 nor an ID by default.
584 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
585 be prepended to the C<$onclick> handler asking the question given with
586 C<$attributes{confirm}>. The request is only submitted if the user
587 clicks the dialog's "ok/yes" button.
589 =item C<textarea_tag $name, $value, %attributes>
591 Creates a HTML 'textarea' tag named C<$name> with the content
592 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
593 tag's C<id> defaults to C<name_to_id($name)>.
595 =item C<checkbox_tag $name, %attributes>
597 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
598 HTML attributes from C<%attributes>. The tag's C<id> defaults to
599 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
601 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
602 created with said C<label>. No attribute named C<label> is created in
605 If C<%attributes> contains a key C<checkall> then the value is taken as a
606 JQuery selector and clicking this checkbox will also toggle all checkboxes
607 matching the selector.
609 =item C<date_tag $name, $value, %attributes>
611 Creates a date input field, with an attached javascript that will open a
614 =item C<radio_button_tag $name, %attributes>
616 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
617 HTML attributes from C<%attributes>. The tag's C<value> defaults to
618 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
620 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
621 created with said C<label>. No attribute named C<label> is created in
624 =item C<javascript_tag $file1, $file2, $file3...>
626 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
627 tag for each file name parameter passed. Each file name will be
628 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
629 doesn't contain a slash.
631 =item C<stylesheet_tag $file1, $file2, $file3...>
633 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
634 for each file name parameter passed. Each file name will be postfixed
635 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
638 =item C<tabbed \@tab, %attributes>
640 Will create a tabbed area. The tabs should be created with the helper function
644 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
645 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
648 =item C<areainput_tag $name, $content, %PARAMS>
650 Creates a generic input tag or textarea tag, depending on content size. The
651 amount of desired rows must be either given with the C<rows> parameter or can
652 be computed from the value and the C<cols> paramter, Accepted parameters
653 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
655 You can force input by setting rows to 1, and you can force textarea by setting
658 =item C<multiselect2side $id, %params>
660 Creates a JavaScript snippet calling the jQuery function
661 C<multiselect2side> on the select control with the ID C<$id>. The
662 select itself is not created. C<%params> can contain the following
669 The label of the list of available options. Defaults to the
670 translation of 'Available'.
674 The label of the list of selected options. Defaults to the
675 translation of 'Selected'.
679 =item C<sortable_element $selector, %params>
681 Makes the children of the DOM element C<$selector> (a jQuery selector)
682 sortable with the I<jQuery UI Selectable> library. The children can be
683 dragged & dropped around. After dropping an element an URL can be
684 postet to with the element IDs of the sorted children.
686 If this is used then the JavaScript file C<js/jquery-ui.js> must be
687 included manually as well as it isn't loaded via C<$::form-gt;header>.
689 C<%params> can contain the following entries:
695 The URL to POST an AJAX request to after a dragged element has been
696 dropped. The AJAX request's return value is ignored. If given then
697 C<$params{with}> must be given as well.
701 A string that is interpreted as the prefix of the children's ID. Upon
702 POSTing the result each child whose ID starts with C<$params{with}> is
703 considered. The prefix and the following "_" is removed from the
704 ID. The remaining parts of the IDs of those children are posted as a
705 single array parameter. The array parameter's name is either
706 C<$params{as}> or, missing that, C<$params{with}>.
710 Sets the POST parameter name for AJAX request after dropping an
711 element (see C<$params{with}>).
715 An optional jQuery selector specifying which part of the child element
716 is dragable. If the parameter is not given then it defaults to
717 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
718 parameter is set and empty then the whole child element is dragable,
719 and clicks through to underlying elements like inputs or links might
722 =item C<dont_recolor>
724 If trueish then the children will not be recolored. The default is to
725 recolor the children by setting the class C<listrow0> on odd and
726 C<listrow1> on even entries.
730 An optional JavaScript string that is evaluated before sending the
731 POST request. The result must be a string that is appended to the URL.
737 <script type="text/javascript" src="js/jquery-ui.js"></script>
739 <table id="thing_list">
741 <tr><td>This</td><td>That</td></tr>
744 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
745 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
746 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
750 [% L.sortable_element('#thing_list tbody',
751 url => 'controller.pl?action=SystemThings/reorder',
754 recolor_rows => 1) %]
756 After dropping e.g. the third element at the top of the list a POST
757 request would be made to the C<reorder> action of the C<SystemThings>
758 controller with a single parameter called C<thing_ids> -- an array
759 containing the values C<[ 6, 2, 15 ]>.
763 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
765 =item C<sortable_table_header $by, %params>
767 Create a link and image suitable for placement in a table
768 header. C<$by> must be an index set up by the controller with
769 L<SL::Controller::Helper::make_sorted>.
771 The optional parameter C<$params{title}> can override the column title
772 displayed to the user. Otherwise the column title from the
773 controller's sort spec is used.
775 The other parameters in C<%params> are passed unmodified to the
776 underlying call to L<SL::Controller::Base::url_for>.
778 See the documentation of L<SL::Controller::Helper::Sorted> for an
779 overview and further usage instructions.
781 =item C<paginate_controls>
783 Create a set of links used to paginate a list view.
785 See the documentation of L<SL::Controller::Helper::Paginated> for an
786 overview and further usage instructions.
790 =head2 CONVERSION FUNCTIONS
794 =item C<tab, description, target, %PARAMS>
796 Creates a tab for C<tabbed>. The description will be used as displayed name.
797 The target should be a block or template that can be processed. C<tab> supports
798 a C<method> parameter, which can override the process method to apply target.
799 C<method => 'raw'> will just include the given text as is. I was too lazy to
800 implement C<include> properly.
802 Also an C<if> attribute is supported, so that tabs can be suppressed based on
803 some occasion. In this case the supplied block won't even get processed, and
804 the resulting tab will get ignored by C<tabbed>:
806 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
808 =item C<truncate $text, [%params]>
810 See L<SL::Presenter::Text/truncate>.
812 =item C<simple_format $text>
814 See L<SL::Presenter::Text/simple_format>.
818 =head1 MODULE AUTHORS
820 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
822 L<http://linet-services.de>