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', @_); }
70 sub _set_id_attribute {
71 my ($attributes, $name) = @_;
72 SL::Presenter::Tag::_set_id_attribute($attributes, $name);
76 my ($self, %options) = _hashify(1, @_);
80 return $self->html_tag('img', undef, %options);
84 my ($self, $name, $content, %attributes) = _hashify(3, @_);
86 _set_id_attribute(\%attributes, $name);
87 $attributes{rows} *= 1; # required by standard
88 $attributes{cols} *= 1; # required by standard
89 $content = $content ? _H($content) : '';
91 return $self->html_tag('textarea', $content, %attributes, name => $name);
95 my ($self, $name, %attributes) = _hashify(2, @_);
97 _set_id_attribute(\%attributes, $name);
98 $attributes{value} = 1 unless defined $attributes{value};
99 my $label = delete $attributes{label};
100 my $checkall = delete $attributes{checkall};
102 if ($attributes{checked}) {
103 $attributes{checked} = 'checked';
105 delete $attributes{checked};
108 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
109 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
110 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
115 sub radio_button_tag {
116 my ($self, $name, %attributes) = _hashify(2, @_);
118 _set_id_attribute(\%attributes, $name);
119 $attributes{value} = 1 unless exists $attributes{value};
120 my $label = delete $attributes{label};
122 if ($attributes{checked}) {
123 $attributes{checked} = 'checked';
125 delete $attributes{checked};
128 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
129 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
135 my ($self, $name, $value, %attributes) = _hashify(3, @_);
136 return $self->input_tag($name, $value, %attributes, type => 'hidden');
140 my ($self, $content, @slurp) = @_;
141 return $self->html_tag('div', $content, @slurp);
145 my ($self, $content, @slurp) = @_;
146 return $self->html_tag('ul', $content, @slurp);
150 my ($self, $content, @slurp) = @_;
151 return $self->html_tag('li', $content, @slurp);
155 my ($self, $href, $content, %params) = _hashify(3, @_);
159 return $self->html_tag('a', $content, %params, href => $href);
163 my ($self, $name, $value, %attributes) = _hashify(3, @_);
165 if ( $attributes{confirm} ) {
166 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
169 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
173 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
175 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
176 $attributes{type} ||= 'button';
178 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
180 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
183 sub ajax_submit_tag {
184 my ($self, $url, $form_selector, $text, @slurp) = @_;
187 $form_selector = _J($form_selector);
188 my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
190 return $self->button_tag($onclick, $text, @slurp);
194 my ($self, $name, $value, %attributes) = _hashify(3, @_);
196 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
200 my ($self, $data) = @_;
201 return $self->html_tag('script', $data, type => 'text/javascript');
208 foreach my $file (@_) {
209 $file .= '.css' unless $file =~ m/\.css$/;
210 $file = "css/${file}" unless $file =~ m|/|;
212 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
218 my $date_tag_id_idx = 0;
220 my ($self, $name, $value, %params) = _hashify(3, @_);
222 _set_id_attribute(\%params, $name);
223 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
224 my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker');
225 push @classes, delete($params{class}) if $params{class};
226 my %class = @classes ? (class => join(' ', @classes)) : ();
228 return $self->input_tag(
229 $name, blessed($value) ? $value->to_lxoffice : $value,
231 onblur => "check_right_date_format(this);",
237 sub customer_picker {
238 my ($self, $name, $value, %params) = @_;
239 my $name_e = _H($name);
241 $::request->{layout}->add_javascripts('autocomplete_customer.js');
243 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
244 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
247 # simple version with select_tag
248 sub vendor_selector {
249 my ($self, $name, $value, %params) = @_;
251 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
252 (ref $value && $value->can('id')) ? $value->id : '';
254 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
255 default => $actual_vendor_id,
256 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
262 # simple version with select_tag
264 my ($self, $name, $value, %params) = @_;
266 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
267 (ref $value && $value->can('id')) ? $value->id : '';
269 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
270 default => $actual_part_id,
271 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
281 foreach my $file (@_) {
282 $file .= '.js' unless $file =~ m/\.js$/;
283 $file = "js/${file}" unless $file =~ m|/|;
285 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
292 my ($self, $tabs, %params) = _hashify(2, @_);
293 my $id = $params{id} || 'tab_' . _tag_id();
295 $params{selected} *= 1;
297 die 'L.tabbed needs an arrayred of tabs for first argument'
298 unless ref $tabs eq 'ARRAY';
300 my (@header, @blocks);
301 for my $i (0..$#$tabs) {
302 my $tab = $tabs->[$i];
306 my $tab_id = "__tab_id_$i";
307 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
308 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
311 return '' unless @header;
313 my $ul = $self->ul_tag(join('', @header), id => $id);
314 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
318 my ($self, $name, $src, %params) = _hashify(3, @_);
320 $params{method} ||= 'process';
322 return () if defined $params{if} && !$params{if};
325 if ($params{method} eq 'raw') {
327 } elsif ($params{method} eq 'process') {
328 $data = $self->_context->process($src, %{ $params{args} || {} });
330 die "unknown tag method '$params{method}'";
333 return () unless $data;
335 return +{ name => $name, data => $data };
339 my ($self, $name, $value, %attributes) = _hashify(3, @_);
342 my $min = delete $attributes{min_rows} || 1;
344 if (exists $attributes{cols}) {
345 $cols = delete $attributes{cols};
346 $rows = $::form->numtextrows($value, $cols);
348 $rows = delete $attributes{rows} || 1;
352 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
353 : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
356 sub multiselect2side {
357 my ($self, $id, %params) = _hashify(2, @_);
359 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
360 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
361 $params{moveOptions} = 'false';
363 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
365 <script type="text/javascript">
366 \$().ready(function() {
367 \$('#${id}').multiselect2side({ ${vars} });
375 sub sortable_element {
376 my ($self, $selector, %params) = _hashify(2, @_);
378 my %attributes = ( distance => 5,
379 helper => <<'JAVASCRIPT' );
380 function(event, ui) {
381 ui.children().each(function() {
382 $(this).width($(this).width());
390 if ($params{url} && $params{with}) {
391 my $as = $params{as} || $params{with};
392 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
393 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
395 my $params_js = $params{params} ? qq| + ($params{params})| : '';
397 $stop_event = <<JAVASCRIPT;
398 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
402 if (!$params{dont_recolor}) {
403 $stop_event .= <<JAVASCRIPT;
404 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
405 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
410 $attributes{stop} = <<JAVASCRIPT;
411 function(event, ui) {
418 $params{handle} = '.dragdrop' unless exists $params{handle};
419 $attributes{handle} = "'$params{handle}'" if $params{handle};
421 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
423 my $code = <<JAVASCRIPT;
424 <script type="text/javascript">
426 \$( "${selector}" ).sortable({ ${attr_str} })
434 sub online_help_tag {
435 my ($self, $tag, %params) = _hashify(2, @_);
436 my $cc = $::myconfig{countrycode};
437 my $file = "doc/online/$cc/$tag.html";
438 my $text = $params{text} || $::locale->text('Help');
440 die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
441 return unless -f $file;
442 return $self->html_tag('a', $text, href => $file, class => 'jqModal')
447 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
450 sub sortable_table_header {
451 my ($self, $by, %params) = _hashify(2, @_);
453 my $controller = $self->{CONTEXT}->stash->get('SELF');
454 my $sort_spec = $controller->get_sort_spec;
455 my $by_spec = $sort_spec->{$by};
456 my %current_sort_params = $controller->get_current_sort_params;
457 my ($image, $new_dir) = ('', $current_sort_params{dir});
458 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
460 if ($current_sort_params{by} eq $by) {
461 my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
462 $image = '<img border="0" src="image/' . $current_dir . '.png">';
463 $new_dir = 1 - ($current_sort_params{dir} || 0);
466 $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
467 $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
469 return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
472 sub paginate_controls {
473 my ($self, %params) = _hashify(1, @_);
475 my $controller = $self->{CONTEXT}->stash->get('SELF');
476 my $paginate_spec = $controller->get_paginate_spec;
477 my %paginate_params = $controller->get_current_paginate_params;
479 my %template_params = (
480 pages => \%paginate_params,
482 my %url_params = _hashify(0, @_);
483 $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page};
484 $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
486 return $controller->get_callback(%url_params);
491 return SL::Presenter->get->render('common/paginate', %template_params);
500 SL::Templates::Plugin::L -- Layouting / tag generation
504 Usage from a template:
508 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
510 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
511 { direction => 'right', display => 'To the right' } ],
512 value_key => 'direction', title_key => 'display', default => 'right')) %]
514 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
515 { direction => 'right', display => 'To the right', selected => 1 } ],
516 value_key => 'direction', title_key => 'display')) %]
520 A module modeled a bit after Rails' ActionView helpers. Several small
521 functions that create HTML tags from various kinds of data sources.
523 The C<id> attribute is usually calculated automatically. This can be
524 overridden by either specifying an C<id> attribute or by setting
529 =head2 LOW-LEVEL FUNCTIONS
531 The following items are just forwarded to L<SL::Presenter::Tag>:
535 =item * C<name_to_id $name>
537 =item * C<stringify_attributes %items>
539 =item * C<html_tag $tag_name, $content_string, %attributes>
543 =head2 HIGH-LEVEL FUNCTIONS
545 The following functions are just forwarded to L<SL::Presenter::Tag>:
549 =item * C<input_tag $name, $value, %attributes>
551 =item * C<select_tag $name, \@collection, %attributes>
555 Available high-level functions implemented in this module:
559 =item C<yes_no_tag $name, $value, %attributes>
561 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
562 calling L<select_tag>. C<$value> determines
563 which entry is selected. The C<%attributes> are passed through to
566 =item C<hidden_tag $name, $value, %attributes>
568 Creates a HTML 'input type=hidden' tag named C<$name> with the value
569 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
570 tag's C<id> defaults to C<name_to_id($name)>.
572 =item C<submit_tag $name, $value, %attributes>
574 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
575 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
576 tag's C<id> defaults to C<name_to_id($name)>.
578 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
579 be added via the C<onclick> handler asking the question given with
580 C<$attributes{confirm}>. The request is only submitted if the user
581 clicks the dialog's ok/yes button.
583 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
585 Creates a HTML 'input type="button"' tag with a very specific onclick
586 handler that submits the form given by the jQuery selector
587 C<$form_selector> to the URL C<$url> (the actual JavaScript function
588 called for that is C<kivi.submit_ajax_form()> in
589 C<js/client_js.js>). The button's label will be C<$text>.
591 =item C<button_tag $onclick, $text, %attributes>
593 Creates a HTML 'input type="button"' tag with an onclick handler
594 C<$onclick> and a value of C<$text>. The button does not have a name
595 nor an ID by default.
597 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
598 be prepended to the C<$onclick> handler asking the question given with
599 C<$attributes{confirm}>. The request is only submitted if the user
600 clicks the dialog's "ok/yes" button.
602 =item C<textarea_tag $name, $value, %attributes>
604 Creates a HTML 'textarea' tag named C<$name> with the content
605 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
606 tag's C<id> defaults to C<name_to_id($name)>.
608 =item C<checkbox_tag $name, %attributes>
610 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
611 HTML attributes from C<%attributes>. The tag's C<id> defaults to
612 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
614 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
615 created with said C<label>. No attribute named C<label> is created in
618 If C<%attributes> contains a key C<checkall> then the value is taken as a
619 JQuery selector and clicking this checkbox will also toggle all checkboxes
620 matching the selector.
622 =item C<date_tag $name, $value, %attributes>
624 Creates a date input field, with an attached javascript that will open a
627 =item C<radio_button_tag $name, %attributes>
629 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
630 HTML attributes from C<%attributes>. The tag's C<value> defaults to
631 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
633 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
634 created with said C<label>. No attribute named C<label> is created in
637 =item C<javascript_tag $file1, $file2, $file3...>
639 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
640 tag for each file name parameter passed. Each file name will be
641 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
642 doesn't contain a slash.
644 =item C<stylesheet_tag $file1, $file2, $file3...>
646 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
647 for each file name parameter passed. Each file name will be postfixed
648 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
651 =item C<tabbed \@tab, %attributes>
653 Will create a tabbed area. The tabs should be created with the helper function
657 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
658 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
661 =item C<areainput_tag $name, $content, %PARAMS>
663 Creates a generic input tag or textarea tag, depending on content size. The
664 amount of desired rows must be either given with the C<rows> parameter or can
665 be computed from the value and the C<cols> paramter, Accepted parameters
666 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
668 You can force input by setting rows to 1, and you can force textarea by setting
671 =item C<multiselect2side $id, %params>
673 Creates a JavaScript snippet calling the jQuery function
674 C<multiselect2side> on the select control with the ID C<$id>. The
675 select itself is not created. C<%params> can contain the following
682 The label of the list of available options. Defaults to the
683 translation of 'Available'.
687 The label of the list of selected options. Defaults to the
688 translation of 'Selected'.
692 =item C<sortable_element $selector, %params>
694 Makes the children of the DOM element C<$selector> (a jQuery selector)
695 sortable with the I<jQuery UI Selectable> library. The children can be
696 dragged & dropped around. After dropping an element an URL can be
697 postet to with the element IDs of the sorted children.
699 If this is used then the JavaScript file C<js/jquery-ui.js> must be
700 included manually as well as it isn't loaded via C<$::form-gt;header>.
702 C<%params> can contain the following entries:
708 The URL to POST an AJAX request to after a dragged element has been
709 dropped. The AJAX request's return value is ignored. If given then
710 C<$params{with}> must be given as well.
714 A string that is interpreted as the prefix of the children's ID. Upon
715 POSTing the result each child whose ID starts with C<$params{with}> is
716 considered. The prefix and the following "_" is removed from the
717 ID. The remaining parts of the IDs of those children are posted as a
718 single array parameter. The array parameter's name is either
719 C<$params{as}> or, missing that, C<$params{with}>.
723 Sets the POST parameter name for AJAX request after dropping an
724 element (see C<$params{with}>).
728 An optional jQuery selector specifying which part of the child element
729 is dragable. If the parameter is not given then it defaults to
730 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
731 parameter is set and empty then the whole child element is dragable,
732 and clicks through to underlying elements like inputs or links might
735 =item C<dont_recolor>
737 If trueish then the children will not be recolored. The default is to
738 recolor the children by setting the class C<listrow0> on odd and
739 C<listrow1> on even entries.
743 An optional JavaScript string that is evaluated before sending the
744 POST request. The result must be a string that is appended to the URL.
750 <script type="text/javascript" src="js/jquery-ui.js"></script>
752 <table id="thing_list">
754 <tr><td>This</td><td>That</td></tr>
757 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
758 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
759 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
763 [% L.sortable_element('#thing_list tbody',
764 url => 'controller.pl?action=SystemThings/reorder',
767 recolor_rows => 1) %]
769 After dropping e.g. the third element at the top of the list a POST
770 request would be made to the C<reorder> action of the C<SystemThings>
771 controller with a single parameter called C<thing_ids> -- an array
772 containing the values C<[ 6, 2, 15 ]>.
776 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
778 =item C<sortable_table_header $by, %params>
780 Create a link and image suitable for placement in a table
781 header. C<$by> must be an index set up by the controller with
782 L<SL::Controller::Helper::make_sorted>.
784 The optional parameter C<$params{title}> can override the column title
785 displayed to the user. Otherwise the column title from the
786 controller's sort spec is used.
788 The other parameters in C<%params> are passed unmodified to the
789 underlying call to L<SL::Controller::Base::url_for>.
791 See the documentation of L<SL::Controller::Helper::Sorted> for an
792 overview and further usage instructions.
794 =item C<paginate_controls>
796 Create a set of links used to paginate a list view.
798 See the documentation of L<SL::Controller::Helper::Paginated> for an
799 overview and further usage instructions.
803 =head2 CONVERSION FUNCTIONS
807 =item C<tab, description, target, %PARAMS>
809 Creates a tab for C<tabbed>. The description will be used as displayed name.
810 The target should be a block or template that can be processed. C<tab> supports
811 a C<method> parameter, which can override the process method to apply target.
812 C<method => 'raw'> will just include the given text as is. I was too lazy to
813 implement C<include> properly.
815 Also an C<if> attribute is supported, so that tabs can be suppressed based on
816 some occasion. In this case the supplied block won't even get processed, and
817 the resulting tab will get ignored by C<tabbed>:
819 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
821 =item C<truncate $text, [%params]>
823 See L<SL::Presenter::Text/truncate>.
825 =item C<simple_format $text>
827 See L<SL::Presenter::Text/simple_format>.
831 =head1 MODULE AUTHORS
833 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
835 L<http://linet-services.de>