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 @class = $params{no_cal} || $params{readonly} ? () : (class => 'datepicker');
226 return $self->input_tag(
227 $name, blessed($value) ? $value->to_lxoffice : $value,
229 onblur => "check_right_date_format(this);",
235 sub customer_picker {
236 my ($self, $name, $value, %params) = @_;
237 my $name_e = _H($name);
239 $::request->{layout}->add_javascripts('autocomplete_customer.js');
241 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
242 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
245 # simple version with select_tag
246 sub vendor_selector {
247 my ($self, $name, $value, %params) = @_;
249 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
250 (ref $value && $value->can('id')) ? $value->id : '';
252 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
253 default => $actual_vendor_id,
254 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
260 # simple version with select_tag
262 my ($self, $name, $value, %params) = @_;
264 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
265 (ref $value && $value->can('id')) ? $value->id : '';
267 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
268 default => $actual_part_id,
269 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
279 foreach my $file (@_) {
280 $file .= '.js' unless $file =~ m/\.js$/;
281 $file = "js/${file}" unless $file =~ m|/|;
283 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
290 my ($self, $tabs, %params) = _hashify(2, @_);
291 my $id = $params{id} || 'tab_' . _tag_id();
293 $params{selected} *= 1;
295 die 'L.tabbed needs an arrayred of tabs for first argument'
296 unless ref $tabs eq 'ARRAY';
298 my (@header, @blocks);
299 for my $i (0..$#$tabs) {
300 my $tab = $tabs->[$i];
304 my $tab_id = "__tab_id_$i";
305 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
306 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
309 return '' unless @header;
311 my $ul = $self->ul_tag(join('', @header), id => $id);
312 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
316 my ($self, $name, $src, %params) = _hashify(3, @_);
318 $params{method} ||= 'process';
320 return () if defined $params{if} && !$params{if};
323 if ($params{method} eq 'raw') {
325 } elsif ($params{method} eq 'process') {
326 $data = $self->_context->process($src, %{ $params{args} || {} });
328 die "unknown tag method '$params{method}'";
331 return () unless $data;
333 return +{ name => $name, data => $data };
337 my ($self, $name, $value, %attributes) = _hashify(3, @_);
340 my $min = delete $attributes{min_rows} || 1;
342 if (exists $attributes{cols}) {
343 $cols = delete $attributes{cols};
344 $rows = $::form->numtextrows($value, $cols);
346 $rows = delete $attributes{rows} || 1;
350 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
351 : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
354 sub multiselect2side {
355 my ($self, $id, %params) = _hashify(2, @_);
357 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
358 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
359 $params{moveOptions} = 'false';
361 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
363 <script type="text/javascript">
364 \$().ready(function() {
365 \$('#${id}').multiselect2side({ ${vars} });
373 sub sortable_element {
374 my ($self, $selector, %params) = _hashify(2, @_);
376 my %attributes = ( distance => 5,
377 helper => <<'JAVASCRIPT' );
378 function(event, ui) {
379 ui.children().each(function() {
380 $(this).width($(this).width());
388 if ($params{url} && $params{with}) {
389 my $as = $params{as} || $params{with};
390 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
391 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
393 my $params_js = $params{params} ? qq| + ($params{params})| : '';
395 $stop_event = <<JAVASCRIPT;
396 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
400 if (!$params{dont_recolor}) {
401 $stop_event .= <<JAVASCRIPT;
402 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
403 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
408 $attributes{stop} = <<JAVASCRIPT;
409 function(event, ui) {
416 $params{handle} = '.dragdrop' unless exists $params{handle};
417 $attributes{handle} = "'$params{handle}'" if $params{handle};
419 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
421 my $code = <<JAVASCRIPT;
422 <script type="text/javascript">
424 \$( "${selector}" ).sortable({ ${attr_str} })
432 sub online_help_tag {
433 my ($self, $tag, %params) = _hashify(2, @_);
434 my $cc = $::myconfig{countrycode};
435 my $file = "doc/online/$cc/$tag.html";
436 my $text = $params{text} || $::locale->text('Help');
438 die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
439 return unless -f $file;
440 return $self->html_tag('a', $text, href => $file, class => 'jqModal')
445 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
448 sub sortable_table_header {
449 my ($self, $by, %params) = _hashify(2, @_);
451 my $controller = $self->{CONTEXT}->stash->get('SELF');
452 my $sort_spec = $controller->get_sort_spec;
453 my $by_spec = $sort_spec->{$by};
454 my %current_sort_params = $controller->get_current_sort_params;
455 my ($image, $new_dir) = ('', $current_sort_params{dir});
456 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
458 if ($current_sort_params{by} eq $by) {
459 my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
460 $image = '<img border="0" src="image/' . $current_dir . '.png">';
461 $new_dir = 1 - ($current_sort_params{dir} || 0);
464 $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
465 $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
467 return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
470 sub paginate_controls {
471 my ($self, %params) = _hashify(1, @_);
473 my $controller = $self->{CONTEXT}->stash->get('SELF');
474 my $paginate_spec = $controller->get_paginate_spec;
475 my %paginate_params = $controller->get_current_paginate_params;
477 my %template_params = (
478 pages => \%paginate_params,
480 my %url_params = _hashify(0, @_);
481 $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page};
482 $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
484 return $controller->get_callback(%url_params);
489 return SL::Presenter->get->render('common/paginate', %template_params);
498 SL::Templates::Plugin::L -- Layouting / tag generation
502 Usage from a template:
506 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
508 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
509 { direction => 'right', display => 'To the right' } ],
510 value_key => 'direction', title_key => 'display', default => 'right')) %]
512 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
513 { direction => 'right', display => 'To the right', selected => 1 } ],
514 value_key => 'direction', title_key => 'display')) %]
518 A module modeled a bit after Rails' ActionView helpers. Several small
519 functions that create HTML tags from various kinds of data sources.
521 The C<id> attribute is usually calculated automatically. This can be
522 overridden by either specifying an C<id> attribute or by setting
527 =head2 LOW-LEVEL FUNCTIONS
529 The following items are just forwarded to L<SL::Presenter::Tag>:
533 =item * C<name_to_id $name>
535 =item * C<stringify_attributes %items>
537 =item * C<html_tag $tag_name, $content_string, %attributes>
541 =head2 HIGH-LEVEL FUNCTIONS
543 The following functions are just forwarded to L<SL::Presenter::Tag>:
547 =item * C<input_tag $name, $value, %attributes>
549 =item * C<select_tag $name, \@collection, %attributes>
553 Available high-level functions implemented in this module:
557 =item C<yes_no_tag $name, $value, %attributes>
559 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
560 calling L<select_tag>. C<$value> determines
561 which entry is selected. The C<%attributes> are passed through to
564 =item C<hidden_tag $name, $value, %attributes>
566 Creates a HTML 'input type=hidden' tag named C<$name> with the value
567 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
568 tag's C<id> defaults to C<name_to_id($name)>.
570 =item C<submit_tag $name, $value, %attributes>
572 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
573 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
574 tag's C<id> defaults to C<name_to_id($name)>.
576 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
577 be added via the C<onclick> handler asking the question given with
578 C<$attributes{confirm}>. The request is only submitted if the user
579 clicks the dialog's ok/yes button.
581 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
583 Creates a HTML 'input type="button"' tag with a very specific onclick
584 handler that submits the form given by the jQuery selector
585 C<$form_selector> to the URL C<$url> (the actual JavaScript function
586 called for that is C<kivi.submit_ajax_form()> in
587 C<js/client_js.js>). The button's label will be C<$text>.
589 =item C<button_tag $onclick, $text, %attributes>
591 Creates a HTML 'input type="button"' tag with an onclick handler
592 C<$onclick> and a value of C<$text>. The button does not have a name
593 nor an ID by default.
595 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
596 be prepended to the C<$onclick> handler asking the question given with
597 C<$attributes{confirm}>. The request is only submitted if the user
598 clicks the dialog's "ok/yes" button.
600 =item C<textarea_tag $name, $value, %attributes>
602 Creates a HTML 'textarea' tag named C<$name> with the content
603 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
604 tag's C<id> defaults to C<name_to_id($name)>.
606 =item C<checkbox_tag $name, %attributes>
608 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
609 HTML attributes from C<%attributes>. The tag's C<id> defaults to
610 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
612 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
613 created with said C<label>. No attribute named C<label> is created in
616 If C<%attributes> contains a key C<checkall> then the value is taken as a
617 JQuery selector and clicking this checkbox will also toggle all checkboxes
618 matching the selector.
620 =item C<date_tag $name, $value, %attributes>
622 Creates a date input field, with an attached javascript that will open a
625 =item C<radio_button_tag $name, %attributes>
627 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
628 HTML attributes from C<%attributes>. The tag's C<value> defaults to
629 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
631 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
632 created with said C<label>. No attribute named C<label> is created in
635 =item C<javascript_tag $file1, $file2, $file3...>
637 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
638 tag for each file name parameter passed. Each file name will be
639 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
640 doesn't contain a slash.
642 =item C<stylesheet_tag $file1, $file2, $file3...>
644 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
645 for each file name parameter passed. Each file name will be postfixed
646 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
649 =item C<tabbed \@tab, %attributes>
651 Will create a tabbed area. The tabs should be created with the helper function
655 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
656 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
659 =item C<areainput_tag $name, $content, %PARAMS>
661 Creates a generic input tag or textarea tag, depending on content size. The
662 amount of desired rows must be either given with the C<rows> parameter or can
663 be computed from the value and the C<cols> paramter, Accepted parameters
664 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
666 You can force input by setting rows to 1, and you can force textarea by setting
669 =item C<multiselect2side $id, %params>
671 Creates a JavaScript snippet calling the jQuery function
672 C<multiselect2side> on the select control with the ID C<$id>. The
673 select itself is not created. C<%params> can contain the following
680 The label of the list of available options. Defaults to the
681 translation of 'Available'.
685 The label of the list of selected options. Defaults to the
686 translation of 'Selected'.
690 =item C<sortable_element $selector, %params>
692 Makes the children of the DOM element C<$selector> (a jQuery selector)
693 sortable with the I<jQuery UI Selectable> library. The children can be
694 dragged & dropped around. After dropping an element an URL can be
695 postet to with the element IDs of the sorted children.
697 If this is used then the JavaScript file C<js/jquery-ui.js> must be
698 included manually as well as it isn't loaded via C<$::form-gt;header>.
700 C<%params> can contain the following entries:
706 The URL to POST an AJAX request to after a dragged element has been
707 dropped. The AJAX request's return value is ignored. If given then
708 C<$params{with}> must be given as well.
712 A string that is interpreted as the prefix of the children's ID. Upon
713 POSTing the result each child whose ID starts with C<$params{with}> is
714 considered. The prefix and the following "_" is removed from the
715 ID. The remaining parts of the IDs of those children are posted as a
716 single array parameter. The array parameter's name is either
717 C<$params{as}> or, missing that, C<$params{with}>.
721 Sets the POST parameter name for AJAX request after dropping an
722 element (see C<$params{with}>).
726 An optional jQuery selector specifying which part of the child element
727 is dragable. If the parameter is not given then it defaults to
728 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
729 parameter is set and empty then the whole child element is dragable,
730 and clicks through to underlying elements like inputs or links might
733 =item C<dont_recolor>
735 If trueish then the children will not be recolored. The default is to
736 recolor the children by setting the class C<listrow0> on odd and
737 C<listrow1> on even entries.
741 An optional JavaScript string that is evaluated before sending the
742 POST request. The result must be a string that is appended to the URL.
748 <script type="text/javascript" src="js/jquery-ui.js"></script>
750 <table id="thing_list">
752 <tr><td>This</td><td>That</td></tr>
755 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
756 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
757 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
761 [% L.sortable_element('#thing_list tbody',
762 url => 'controller.pl?action=SystemThings/reorder',
765 recolor_rows => 1) %]
767 After dropping e.g. the third element at the top of the list a POST
768 request would be made to the C<reorder> action of the C<SystemThings>
769 controller with a single parameter called C<thing_ids> -- an array
770 containing the values C<[ 6, 2, 15 ]>.
774 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
776 =item C<sortable_table_header $by, %params>
778 Create a link and image suitable for placement in a table
779 header. C<$by> must be an index set up by the controller with
780 L<SL::Controller::Helper::make_sorted>.
782 The optional parameter C<$params{title}> can override the column title
783 displayed to the user. Otherwise the column title from the
784 controller's sort spec is used.
786 The other parameters in C<%params> are passed unmodified to the
787 underlying call to L<SL::Controller::Base::url_for>.
789 See the documentation of L<SL::Controller::Helper::Sorted> for an
790 overview and further usage instructions.
792 =item C<paginate_controls>
794 Create a set of links used to paginate a list view.
796 See the documentation of L<SL::Controller::Helper::Paginated> for an
797 overview and further usage instructions.
801 =head2 CONVERSION FUNCTIONS
805 =item C<tab, description, target, %PARAMS>
807 Creates a tab for C<tabbed>. The description will be used as displayed name.
808 The target should be a block or template that can be processed. C<tab> supports
809 a C<method> parameter, which can override the process method to apply target.
810 C<method => 'raw'> will just include the given text as is. I was too lazy to
811 implement C<include> properly.
813 Also an C<if> attribute is supported, so that tabs can be suppressed based on
814 some occasion. In this case the supplied block won't even get processed, and
815 the resulting tab will get ignored by C<tabbed>:
817 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
819 =item C<truncate $text, [%params]>
821 See L<SL::Presenter::Text/truncate>.
823 =item C<simple_format $text>
825 See L<SL::Presenter::Text/simple_format>.
829 =head1 MODULE AUTHORS
831 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
833 L<http://linet-services.de>