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', @_); }
72 sub project_picker { return _call_presenter('project_picker', @_); }
74 sub _set_id_attribute {
75 my ($attributes, $name, $unique) = @_;
76 SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique);
80 my ($self, %options) = _hashify(1, @_);
84 return $self->html_tag('img', undef, %options);
88 my ($self, $name, $content, %attributes) = _hashify(3, @_);
90 _set_id_attribute(\%attributes, $name);
91 $attributes{rows} *= 1; # required by standard
92 $attributes{cols} *= 1; # required by standard
93 $content = $content ? _H($content) : '';
95 return $self->html_tag('textarea', $content, %attributes, name => $name);
99 my ($self, $name, %attributes) = _hashify(2, @_);
101 _set_id_attribute(\%attributes, $name);
102 $attributes{value} = 1 unless defined $attributes{value};
103 my $label = delete $attributes{label};
104 my $checkall = delete $attributes{checkall};
105 my $for_submit = delete $attributes{for_submit};
107 if ($attributes{checked}) {
108 $attributes{checked} = 'checked';
110 delete $attributes{checked};
114 $code .= $self->hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit;
115 $code .= $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
116 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
117 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
122 sub radio_button_tag {
123 my ($self, $name, %attributes) = _hashify(2, @_);
125 $attributes{value} = 1 unless exists $attributes{value};
127 _set_id_attribute(\%attributes, $name, 1);
128 my $label = delete $attributes{label};
130 _set_id_attribute(\%attributes, $name . '_' . $attributes{value});
132 if ($attributes{checked}) {
133 $attributes{checked} = 'checked';
135 delete $attributes{checked};
138 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
139 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
145 my ($self, $name, $value, %attributes) = _hashify(3, @_);
146 return $self->input_tag($name, $value, %attributes, type => 'hidden');
150 my ($self, $content, @slurp) = @_;
151 return $self->html_tag('div', $content, @slurp);
155 my ($self, $content, @slurp) = @_;
156 return $self->html_tag('ul', $content, @slurp);
160 my ($self, $content, @slurp) = @_;
161 return $self->html_tag('li', $content, @slurp);
165 my ($self, $href, $content, %params) = _hashify(3, @_);
169 return $self->html_tag('a', $content, %params, href => $href);
173 my ($self, $name, $value, %attributes) = _hashify(3, @_);
175 if ( $attributes{confirm} ) {
176 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
179 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
183 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
185 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
186 $attributes{type} ||= 'button';
188 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
190 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
193 sub ajax_submit_tag {
194 my ($self, $url, $form_selector, $text, @slurp) = @_;
197 $form_selector = _J($form_selector);
198 my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
200 return $self->button_tag($onclick, $text, @slurp);
204 my ($self, $name, $value, %attributes) = _hashify(3, @_);
206 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
210 my ($self, $data) = @_;
211 return $self->html_tag('script', $data, type => 'text/javascript');
218 foreach my $file (@_) {
219 $file .= '.css' unless $file =~ m/\.css$/;
220 $file = "css/${file}" unless $file =~ m|/|;
222 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
228 my $date_tag_id_idx = 0;
230 my ($self, $name, $value, %params) = _hashify(3, @_);
232 _set_id_attribute(\%params, $name);
233 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
234 my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker');
235 push @classes, delete($params{class}) if $params{class};
236 my %class = @classes ? (class => join(' ', @classes)) : ();
238 $::request->presenter->need_reinit_widgets($params{id});
240 return $self->input_tag(
241 $name, blessed($value) ? $value->to_lxoffice : $value,
243 onblur => "check_right_date_format(this);",
249 # simple version with select_tag
250 sub vendor_selector {
251 my ($self, $name, $value, %params) = _hashify(3, @_);
253 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
254 (ref $value && $value->can('id')) ? $value->id : '';
256 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
257 default => $actual_vendor_id,
258 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
264 # simple version with select_tag
266 my ($self, $name, $value, %params) = _hashify(3, @_);
268 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
269 (ref $value && $value->can('id')) ? $value->id : '';
271 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
272 default => $actual_part_id,
273 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
283 foreach my $file (@_) {
284 $file .= '.js' unless $file =~ m/\.js$/;
285 $file = "js/${file}" unless $file =~ m|/|;
287 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
294 my ($self, $tabs, %params) = _hashify(2, @_);
295 my $id = $params{id} || 'tab_' . _tag_id();
297 $params{selected} *= 1;
299 die 'L.tabbed needs an arrayred of tabs for first argument'
300 unless ref $tabs eq 'ARRAY';
302 my (@header, @blocks);
303 for my $i (0..$#$tabs) {
304 my $tab = $tabs->[$i];
308 my $tab_id = "__tab_id_$i";
309 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
310 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
313 return '' unless @header;
315 my $ul = $self->ul_tag(join('', @header), id => $id);
316 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
320 my ($self, $name, $src, %params) = _hashify(3, @_);
322 $params{method} ||= 'process';
324 return () if defined $params{if} && !$params{if};
327 if ($params{method} eq 'raw') {
329 } elsif ($params{method} eq 'process') {
330 $data = $self->_context->process($src, %{ $params{args} || {} });
332 die "unknown tag method '$params{method}'";
335 return () unless $data;
337 return +{ name => $name, data => $data };
341 my ($self, $name, $value, %attributes) = _hashify(3, @_);
343 my $cols = delete $attributes{cols} || delete $attributes{size};
344 my $minrows = delete $attributes{min_rows} || 1;
345 my $maxrows = delete $attributes{max_rows};
346 my $rows = $::form->numtextrows($value, $cols, $maxrows, $minrows);
349 ? $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols)
350 : $self->input_tag($name, $value, %attributes, size => $cols);
353 sub multiselect2side {
354 my ($self, $id, %params) = _hashify(2, @_);
356 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
357 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
358 $params{moveOptions} = 'false';
360 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
362 <script type="text/javascript">
363 \$().ready(function() {
364 \$('#${id}').multiselect2side({ ${vars} });
372 sub sortable_element {
373 my ($self, $selector, %params) = _hashify(2, @_);
375 my %attributes = ( distance => 5,
376 helper => <<'JAVASCRIPT' );
377 function(event, ui) {
378 ui.children().each(function() {
379 $(this).width($(this).width());
387 if ($params{url} && $params{with}) {
388 my $as = $params{as} || $params{with};
389 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
390 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
392 my $params_js = $params{params} ? qq| + ($params{params})| : '';
394 $stop_event = <<JAVASCRIPT;
395 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
399 if (!$params{dont_recolor}) {
400 $stop_event .= <<JAVASCRIPT;
401 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
402 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
407 $attributes{stop} = <<JAVASCRIPT;
408 function(event, ui) {
415 $params{handle} = '.dragdrop' unless exists $params{handle};
416 $attributes{handle} = "'$params{handle}'" if $params{handle};
418 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
420 my $code = <<JAVASCRIPT;
421 <script type="text/javascript">
423 \$( "${selector}" ).sortable({ ${attr_str} })
433 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
436 sub sortable_table_header {
437 my ($self, $by, %params) = _hashify(2, @_);
439 my $controller = $self->{CONTEXT}->stash->get('SELF');
440 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
441 my $sort_spec = $models->get_sort_spec;
442 my $by_spec = $sort_spec->{$by};
443 my %current_sort_params = $models->get_current_sort_params;
444 my ($image, $new_dir) = ('', $current_sort_params{dir});
445 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
447 if ($current_sort_params{sort_by} eq $by) {
448 my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
449 $image = '<img border="0" src="image/' . $current_dir . '.png">';
450 $new_dir = 1 - ($current_sort_params{sort_dir} || 0);
453 $params{ $models->sorted->form_params->[0] } = $by;
454 $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
456 return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
459 sub paginate_controls {
460 my ($self, %params) = _hashify(1, @_);
462 my $controller = $self->{CONTEXT}->stash->get('SELF');
463 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
464 my $pager = $models->paginated;
465 # my $paginate_spec = $controller->get_paginate_spec;
467 my %paginate_params = $models->get_paginate_args;
469 my %template_params = (
470 pages => \%paginate_params,
472 my %url_params = _hashify(0, @_);
473 $url_params{ $pager->form_params->[0] } = delete $url_params{page};
474 $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
476 return $models->get_callback(%url_params);
481 return SL::Presenter->get->render('common/paginate', %template_params);
490 SL::Templates::Plugin::L -- Layouting / tag generation
494 Usage from a template:
498 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
500 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
501 { direction => 'right', display => 'To the right' } ],
502 value_key => 'direction', title_key => 'display', default => 'right')) %]
504 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
505 { direction => 'right', display => 'To the right', selected => 1 } ],
506 value_key => 'direction', title_key => 'display')) %]
510 A module modeled a bit after Rails' ActionView helpers. Several small
511 functions that create HTML tags from various kinds of data sources.
513 The C<id> attribute is usually calculated automatically. This can be
514 overridden by either specifying an C<id> attribute or by setting
519 =head2 LOW-LEVEL FUNCTIONS
521 The following items are just forwarded to L<SL::Presenter::Tag>:
525 =item * C<name_to_id $name>
527 =item * C<stringify_attributes %items>
529 =item * C<html_tag $tag_name, $content_string, %attributes>
533 =head2 HIGH-LEVEL FUNCTIONS
535 The following functions are just forwarded to L<SL::Presenter::Tag>:
539 =item * C<input_tag $name, $value, %attributes>
541 =item * C<select_tag $name, \@collection, %attributes>
545 Available high-level functions implemented in this module:
549 =item C<yes_no_tag $name, $value, %attributes>
551 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
552 calling L<select_tag>. C<$value> determines
553 which entry is selected. The C<%attributes> are passed through to
556 =item C<hidden_tag $name, $value, %attributes>
558 Creates a HTML 'input type=hidden' tag named C<$name> with the value
559 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
560 tag's C<id> defaults to C<name_to_id($name)>.
562 =item C<submit_tag $name, $value, %attributes>
564 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
565 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
566 tag's C<id> defaults to C<name_to_id($name)>.
568 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
569 be added via the C<onclick> handler asking the question given with
570 C<$attributes{confirm}>. The request is only submitted if the user
571 clicks the dialog's ok/yes button.
573 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
575 Creates a HTML 'input type="button"' tag with a very specific onclick
576 handler that submits the form given by the jQuery selector
577 C<$form_selector> to the URL C<$url> (the actual JavaScript function
578 called for that is C<kivi.submit_ajax_form()> in
579 C<js/client_js.js>). The button's label will be C<$text>.
581 =item C<button_tag $onclick, $text, %attributes>
583 Creates a HTML 'input type="button"' tag with an onclick handler
584 C<$onclick> and a value of C<$text>. The button does not have a name
585 nor an ID by default.
587 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
588 be prepended to the C<$onclick> handler asking the question given with
589 C<$attributes{confirm}>. The request is only submitted if the user
590 clicks the dialog's "ok/yes" button.
592 =item C<textarea_tag $name, $value, %attributes>
594 Creates a HTML 'textarea' tag named C<$name> with the content
595 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
596 tag's C<id> defaults to C<name_to_id($name)>.
598 =item C<checkbox_tag $name, %attributes>
600 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
601 HTML attributes from C<%attributes>. The tag's C<id> defaults to
602 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
604 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
605 created with said C<label>. No attribute named C<label> is created in
608 If C<%attributes> contains a key C<checkall> then the value is taken as a
609 JQuery selector and clicking this checkbox will also toggle all checkboxes
610 matching the selector.
612 =item C<date_tag $name, $value, %attributes>
614 Creates a date input field, with an attached javascript that will open a
617 =item C<radio_button_tag $name, %attributes>
619 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
620 HTML attributes from C<%attributes>. The tag's C<value> defaults to
621 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
623 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
624 created with said C<label>. No attribute named C<label> is created in
627 =item C<javascript_tag $file1, $file2, $file3...>
629 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
630 tag for each file name parameter passed. Each file name will be
631 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
632 doesn't contain a slash.
634 =item C<stylesheet_tag $file1, $file2, $file3...>
636 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
637 for each file name parameter passed. Each file name will be postfixed
638 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
641 =item C<tabbed \@tab, %attributes>
643 Will create a tabbed area. The tabs should be created with the helper function
647 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
648 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
651 =item C<areainput_tag $name, $content, %PARAMS>
653 Creates a generic input tag or textarea tag, depending on content size. The
654 amount of desired rows must be either given with the C<rows> parameter or can
655 be computed from the value and the C<cols> paramter, Accepted parameters
656 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
658 You can force input by setting rows to 1, and you can force textarea by setting
661 =item C<multiselect2side $id, %params>
663 Creates a JavaScript snippet calling the jQuery function
664 C<multiselect2side> on the select control with the ID C<$id>. The
665 select itself is not created. C<%params> can contain the following
672 The label of the list of available options. Defaults to the
673 translation of 'Available'.
677 The label of the list of selected options. Defaults to the
678 translation of 'Selected'.
682 =item C<sortable_element $selector, %params>
684 Makes the children of the DOM element C<$selector> (a jQuery selector)
685 sortable with the I<jQuery UI Selectable> library. The children can be
686 dragged & dropped around. After dropping an element an URL can be
687 postet to with the element IDs of the sorted children.
689 If this is used then the JavaScript file C<js/jquery-ui.js> must be
690 included manually as well as it isn't loaded via C<$::form-gt;header>.
692 C<%params> can contain the following entries:
698 The URL to POST an AJAX request to after a dragged element has been
699 dropped. The AJAX request's return value is ignored. If given then
700 C<$params{with}> must be given as well.
704 A string that is interpreted as the prefix of the children's ID. Upon
705 POSTing the result each child whose ID starts with C<$params{with}> is
706 considered. The prefix and the following "_" is removed from the
707 ID. The remaining parts of the IDs of those children are posted as a
708 single array parameter. The array parameter's name is either
709 C<$params{as}> or, missing that, C<$params{with}>.
713 Sets the POST parameter name for AJAX request after dropping an
714 element (see C<$params{with}>).
718 An optional jQuery selector specifying which part of the child element
719 is dragable. If the parameter is not given then it defaults to
720 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
721 parameter is set and empty then the whole child element is dragable,
722 and clicks through to underlying elements like inputs or links might
725 =item C<dont_recolor>
727 If trueish then the children will not be recolored. The default is to
728 recolor the children by setting the class C<listrow0> on odd and
729 C<listrow1> on even entries.
733 An optional JavaScript string that is evaluated before sending the
734 POST request. The result must be a string that is appended to the URL.
740 <script type="text/javascript" src="js/jquery-ui.js"></script>
742 <table id="thing_list">
744 <tr><td>This</td><td>That</td></tr>
747 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
748 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
749 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
753 [% L.sortable_element('#thing_list tbody',
754 url => 'controller.pl?action=SystemThings/reorder',
757 recolor_rows => 1) %]
759 After dropping e.g. the third element at the top of the list a POST
760 request would be made to the C<reorder> action of the C<SystemThings>
761 controller with a single parameter called C<thing_ids> -- an array
762 containing the values C<[ 6, 2, 15 ]>.
766 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
768 =item C<sortable_table_header $by, %params>
770 Create a link and image suitable for placement in a table
771 header. C<$by> must be an index set up by the controller with
772 L<SL::Controller::Helper::make_sorted>.
774 The optional parameter C<$params{title}> can override the column title
775 displayed to the user. Otherwise the column title from the
776 controller's sort spec is used.
778 The other parameters in C<%params> are passed unmodified to the
779 underlying call to L<SL::Controller::Base::url_for>.
781 See the documentation of L<SL::Controller::Helper::Sorted> for an
782 overview and further usage instructions.
784 =item C<paginate_controls>
786 Create a set of links used to paginate a list view.
788 See the documentation of L<SL::Controller::Helper::Paginated> for an
789 overview and further usage instructions.
793 =head2 CONVERSION FUNCTIONS
797 =item C<tab, description, target, %PARAMS>
799 Creates a tab for C<tabbed>. The description will be used as displayed name.
800 The target should be a block or template that can be processed. C<tab> supports
801 a C<method> parameter, which can override the process method to apply target.
802 C<method => 'raw'> will just include the given text as is. I was too lazy to
803 implement C<include> properly.
805 Also an C<if> attribute is supported, so that tabs can be suppressed based on
806 some occasion. In this case the supplied block won't even get processed, and
807 the resulting tab will get ignored by C<tabbed>:
809 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
811 =item C<truncate $text, [%params]>
813 See L<SL::Presenter::Text/truncate>.
815 =item C<simple_format $text>
817 See L<SL::Presenter::Text/simple_format>.
821 =head1 MODULE AUTHORS
823 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
825 L<http://linet-services.de>