1 package SL::Template::Plugin::L;
3 use base qw( Template::Plugin );
5 use List::MoreUtils qw(apply);
6 use List::Util qw(max);
7 use Scalar::Util qw(blessed);
10 use SL::Util qw(_hashify);
14 { # This will give you an id for identifying html tags and such.
15 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
16 # Do not use these id's to store information across requests.
17 my $_id_sequence = int rand 1e7;
19 return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
25 return $::locale->quote_special_chars('HTML', $string);
30 $string =~ s/(\"|\'|\\)/\\$1/g;
35 my ($class, $context, @args) = @_;
43 die 'not an accessor' if @_ > 1;
44 return $_[0]->{CONTEXT};
48 my ($method, $self, @args) = @_;
50 my $presenter = $::request->presenter;
52 if (!$presenter->can($method)) {
53 $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
57 splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
59 $presenter->$method(@args);
62 sub name_to_id { return _call_presenter('name_to_id', @_); }
63 sub html_tag { return _call_presenter('html_tag', @_); }
64 sub select_tag { return _call_presenter('select_tag', @_); }
65 sub input_tag { return _call_presenter('input_tag', @_); }
66 sub truncate { return _call_presenter('truncate', @_); }
67 sub simple_format { return _call_presenter('simple_format', @_); }
69 sub _set_id_attribute {
70 my ($attributes, $name) = @_;
71 SL::Presenter::Tag::_set_id_attribute($attributes, $name);
75 my ($self, %options) = _hashify(1, @_);
79 return $self->html_tag('img', undef, %options);
83 my ($self, $name, $content, %attributes) = _hashify(3, @_);
85 _set_id_attribute(\%attributes, $name);
86 $attributes{rows} *= 1; # required by standard
87 $attributes{cols} *= 1; # required by standard
88 $content = $content ? _H($content) : '';
90 return $self->html_tag('textarea', $content, %attributes, name => $name);
94 my ($self, $name, %attributes) = _hashify(2, @_);
96 _set_id_attribute(\%attributes, $name);
97 $attributes{value} = 1 unless defined $attributes{value};
98 my $label = delete $attributes{label};
99 my $checkall = delete $attributes{checkall};
101 if ($attributes{checked}) {
102 $attributes{checked} = 'checked';
104 delete $attributes{checked};
107 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
108 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
109 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
114 sub radio_button_tag {
115 my ($self, $name, %attributes) = _hashify(2, @_);
117 _set_id_attribute(\%attributes, $name);
118 $attributes{value} = 1 unless defined $attributes{value};
119 my $label = delete $attributes{label};
121 if ($attributes{checked}) {
122 $attributes{checked} = 'checked';
124 delete $attributes{checked};
127 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
128 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
134 my ($self, $name, $value, %attributes) = _hashify(3, @_);
135 return $self->input_tag($name, $value, %attributes, type => 'hidden');
139 my ($self, $content, @slurp) = @_;
140 return $self->html_tag('div', $content, @slurp);
144 my ($self, $content, @slurp) = @_;
145 return $self->html_tag('ul', $content, @slurp);
149 my ($self, $content, @slurp) = @_;
150 return $self->html_tag('li', $content, @slurp);
154 my ($self, $href, $content, %params) = _hashify(3, @_);
158 return $self->html_tag('a', $content, %params, href => $href);
162 my ($self, $name, $value, %attributes) = _hashify(3, @_);
164 if ( $attributes{confirm} ) {
165 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
168 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
172 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
174 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
175 $attributes{type} ||= 'button';
177 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
179 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
182 sub ajax_submit_tag {
183 my ($self, $url, $form_selector, $text, @slurp) = @_;
186 $form_selector = _J($form_selector);
187 my $onclick = qq|submit_ajax_form('${url}', '${form_selector}')|;
189 return $self->button_tag($onclick, $text, @slurp);
193 my ($self, $name, $value, %attributes) = _hashify(3, @_);
195 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
199 my ($self, $data) = @_;
200 return $self->html_tag('script', $data, type => 'text/javascript');
207 foreach my $file (@_) {
208 $file .= '.css' unless $file =~ m/\.css$/;
209 $file = "css/${file}" unless $file =~ m|/|;
211 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
217 my $date_tag_id_idx = 0;
219 my ($self, $name, $value, %params) = _hashify(3, @_);
221 _set_id_attribute(\%params, $name);
222 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
223 my @class = $params{no_cal} || $params{readonly} ? () : (class => 'datepicker');
225 return $self->input_tag(
226 $name, blessed($value) ? $value->to_lxoffice : $value,
228 onblur => "check_right_date_format(this);",
234 sub customer_picker {
235 my ($self, $name, $value, %params) = @_;
236 my $name_e = _H($name);
238 $::request->{layout}->add_javascripts('autocomplete_customer.js');
240 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
241 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
244 # simple version with select_tag
245 sub vendor_selector {
246 my ($self, $name, $value, %params) = @_;
248 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
249 (ref $value && $value->can('id')) ? $value->id : '';
251 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
252 default => $actual_vendor_id,
253 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
259 # simple version with select_tag
261 my ($self, $name, $value, %params) = @_;
263 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
264 (ref $value && $value->can('id')) ? $value->id : '';
266 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
267 default => $actual_part_id,
268 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
278 foreach my $file (@_) {
279 $file .= '.js' unless $file =~ m/\.js$/;
280 $file = "js/${file}" unless $file =~ m|/|;
282 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
289 my ($self, $tabs, %params) = _hashify(2, @_);
290 my $id = $params{id} || 'tab_' . _tag_id();
292 $params{selected} *= 1;
294 die 'L.tabbed needs an arrayred of tabs for first argument'
295 unless ref $tabs eq 'ARRAY';
297 my (@header, @blocks);
298 for my $i (0..$#$tabs) {
299 my $tab = $tabs->[$i];
303 my $tab_id = "__tab_id_$i";
304 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
305 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
308 return '' unless @header;
310 my $ul = $self->ul_tag(join('', @header), id => $id);
311 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
315 my ($self, $name, $src, %params) = _hashify(3, @_);
317 $params{method} ||= 'process';
319 return () if defined $params{if} && !$params{if};
322 if ($params{method} eq 'raw') {
324 } elsif ($params{method} eq 'process') {
325 $data = $self->_context->process($src, %{ $params{args} || {} });
327 die "unknown tag method '$params{method}'";
330 return () unless $data;
332 return +{ name => $name, data => $data };
336 my ($self, $name, $value, %attributes) = _hashify(3, @_);
339 my $min = delete $attributes{min_rows} || 1;
341 if (exists $attributes{cols}) {
342 $cols = delete $attributes{cols};
343 $rows = $::form->numtextrows($value, $cols);
345 $rows = delete $attributes{rows} || 1;
349 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
350 : $self->input_tag($name, $value, %attributes, ($cols ? (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 $stop_event = <<JAVASCRIPT;
393 \$.post('$params{url}', { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
397 if (!$params{dont_recolor}) {
398 $stop_event .= <<JAVASCRIPT;
399 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
400 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
405 $attributes{stop} = <<JAVASCRIPT;
406 function(event, ui) {
413 $params{handle} = '.dragdrop' unless exists $params{handle};
414 $attributes{handle} = "'$params{handle}'" if $params{handle};
416 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
418 my $code = <<JAVASCRIPT;
419 <script type="text/javascript">
421 \$( "${selector}" ).sortable({ ${attr_str} })
429 sub online_help_tag {
430 my ($self, $tag, %params) = _hashify(2, @_);
431 my $cc = $::myconfig{countrycode};
432 my $file = "doc/online/$cc/$tag.html";
433 my $text = $params{text} || $::locale->text('Help');
435 die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
436 return unless -f $file;
437 return $self->html_tag('a', $text, href => $file, class => 'jqModal')
442 require Data::Dumper;
443 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
446 sub sortable_table_header {
447 my ($self, $by, %params) = _hashify(2, @_);
449 my $controller = $self->{CONTEXT}->stash->get('SELF');
450 my $sort_spec = $controller->get_sort_spec;
451 my $by_spec = $sort_spec->{$by};
452 my %current_sort_params = $controller->get_current_sort_params;
453 my ($image, $new_dir) = ('', $current_sort_params{dir});
454 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
456 if ($current_sort_params{by} eq $by) {
457 my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
458 $image = '<img border="0" src="image/' . $current_dir . '.png">';
459 $new_dir = 1 - ($current_sort_params{dir} || 0);
462 $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
463 $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
465 return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
468 sub paginate_controls {
471 my $controller = $self->{CONTEXT}->stash->get('SELF');
472 my $paginate_spec = $controller->get_paginate_spec;
473 my %paginate_params = $controller->get_current_paginate_params;
475 my %template_params = (
476 pages => \%paginate_params,
478 my %url_params = _hashify(0, @_);
479 $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page};
480 $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
482 return $controller->get_callback(%url_params);
486 return SL::Presenter->get->render('common/paginate', %template_params);
495 SL::Templates::Plugin::L -- Layouting / tag generation
499 Usage from a template:
503 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
505 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
506 { direction => 'right', display => 'To the right' } ],
507 value_key => 'direction', title_key => 'display', default => 'right')) %]
509 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
510 { direction => 'right', display => 'To the right', selected => 1 } ],
511 value_key => 'direction', title_key => 'display')) %]
515 A module modeled a bit after Rails' ActionView helpers. Several small
516 functions that create HTML tags from various kinds of data sources.
518 The C<id> attribute is usually calculated automatically. This can be
519 overridden by either specifying an C<id> attribute or by setting
524 =head2 LOW-LEVEL FUNCTIONS
526 The following items are just forwarded to L<SL::Presenter::Tag>:
530 =item * C<name_to_id $name>
532 =item * C<stringify_attributes %items>
534 =item * C<html_tag $tag_name, $content_string, %attributes>
538 =head2 HIGH-LEVEL FUNCTIONS
540 The following functions are just forwarded to L<SL::Presenter::Tag>:
544 =item * C<input_tag $name, $value, %attributes>
546 =item * C<select_tag $name, \@collection, %attributes>
550 Available high-level functions implemented in this module:
554 =item C<yes_no_tag $name, $value, %attributes>
556 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
557 calling L<select_tag>. C<$value> determines
558 which entry is selected. The C<%attributes> are passed through to
561 =item C<hidden_tag $name, $value, %attributes>
563 Creates a HTML 'input type=hidden' tag named C<$name> with the value
564 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
565 tag's C<id> defaults to C<name_to_id($name)>.
567 =item C<submit_tag $name, $value, %attributes>
569 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
570 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
571 tag's C<id> defaults to C<name_to_id($name)>.
573 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
574 be added via the C<onclick> handler asking the question given with
575 C<$attributes{confirm}>. The request is only submitted if the user
576 clicks the dialog's ok/yes button.
578 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
580 Creates a HTML 'input type="button"' tag with a very specific onclick
581 handler that submits the form given by the jQuery selector
582 C<$form_selector> to the URL C<$url> (the actual JavaScript function
583 called for that is C<submit_ajax_form()> in C<js/client_js.js>). The
584 button's label will be C<$text>.
586 =item C<button_tag $onclick, $text, %attributes>
588 Creates a HTML 'input type="button"' tag with an onclick handler
589 C<$onclick> and a value of C<$text>. The button does not have a name
590 nor an ID by default.
592 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
593 be prepended to the C<$onclick> handler asking the question given with
594 C<$attributes{confirm}>. The request is only submitted if the user
595 clicks the dialog's "ok/yes" button.
597 =item C<textarea_tag $name, $value, %attributes>
599 Creates a HTML 'textarea' tag named C<$name> with the content
600 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
601 tag's C<id> defaults to C<name_to_id($name)>.
603 =item C<checkbox_tag $name, %attributes>
605 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
606 HTML attributes from C<%attributes>. The tag's C<id> defaults to
607 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
609 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
610 created with said C<label>. No attribute named C<label> is created in
613 If C<%attributes> contains a key C<checkall> then the value is taken as a
614 JQuery selector and clicking this checkbox will also toggle all checkboxes
615 matching the selector.
617 =item C<date_tag $name, $value, %attributes>
619 Creates a date input field, with an attached javascript that will open a
622 =item C<radio_button_tag $name, %attributes>
624 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
625 HTML attributes from C<%attributes>. The tag's C<value> defaults to
626 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
628 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
629 created with said C<label>. No attribute named C<label> is created in
632 =item C<javascript_tag $file1, $file2, $file3...>
634 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
635 tag for each file name parameter passed. Each file name will be
636 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
637 doesn't contain a slash.
639 =item C<stylesheet_tag $file1, $file2, $file3...>
641 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
642 for each file name parameter passed. Each file name will be postfixed
643 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
646 =item C<tabbed \@tab, %attributes>
648 Will create a tabbed area. The tabs should be created with the helper function
652 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
653 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
656 =item C<areainput_tag $name, $content, %PARAMS>
658 Creates a generic input tag or textarea tag, depending on content size. The
659 amount of desired rows must be either given with the C<rows> parameter or can
660 be computed from the value and the C<cols> paramter, Accepted parameters
661 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
663 You can force input by setting rows to 1, and you can force textarea by setting
666 =item C<multiselect2side $id, %params>
668 Creates a JavaScript snippet calling the jQuery function
669 C<multiselect2side> on the select control with the ID C<$id>. The
670 select itself is not created. C<%params> can contain the following
677 The label of the list of available options. Defaults to the
678 translation of 'Available'.
682 The label of the list of selected options. Defaults to the
683 translation of 'Selected'.
687 =item C<sortable_element $selector, %params>
689 Makes the children of the DOM element C<$selector> (a jQuery selector)
690 sortable with the I<jQuery UI Selectable> library. The children can be
691 dragged & dropped around. After dropping an element an URL can be
692 postet to with the element IDs of the sorted children.
694 If this is used then the JavaScript file C<js/jquery-ui.js> must be
695 included manually as well as it isn't loaded via C<$::form-gt;header>.
697 C<%params> can contain the following entries:
703 The URL to POST an AJAX request to after a dragged element has been
704 dropped. The AJAX request's return value is ignored. If given then
705 C<$params{with}> must be given as well.
709 A string that is interpreted as the prefix of the children's ID. Upon
710 POSTing the result each child whose ID starts with C<$params{with}> is
711 considered. The prefix and the following "_" is removed from the
712 ID. The remaining parts of the IDs of those children are posted as a
713 single array parameter. The array parameter's name is either
714 C<$params{as}> or, missing that, C<$params{with}>.
718 Sets the POST parameter name for AJAX request after dropping an
719 element (see C<$params{with}>).
723 An optional jQuery selector specifying which part of the child element
724 is dragable. If the parameter is not given then it defaults to
725 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
726 parameter is set and empty then the whole child element is dragable,
727 and clicks through to underlying elements like inputs or links might
730 =item C<dont_recolor>
732 If trueish then the children will not be recolored. The default is to
733 recolor the children by setting the class C<listrow0> on odd and
734 C<listrow1> on even entries.
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>