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', @_); }
71 sub _set_id_attribute {
72 my ($attributes, $name) = @_;
73 SL::Presenter::Tag::_set_id_attribute($attributes, $name);
77 my ($self, %options) = _hashify(1, @_);
81 return $self->html_tag('img', undef, %options);
85 my ($self, $name, $content, %attributes) = _hashify(3, @_);
87 _set_id_attribute(\%attributes, $name);
88 $attributes{rows} *= 1; # required by standard
89 $attributes{cols} *= 1; # required by standard
90 $content = $content ? _H($content) : '';
92 return $self->html_tag('textarea', $content, %attributes, name => $name);
96 my ($self, $name, %attributes) = _hashify(2, @_);
98 _set_id_attribute(\%attributes, $name);
99 $attributes{value} = 1 unless defined $attributes{value};
100 my $label = delete $attributes{label};
101 my $checkall = delete $attributes{checkall};
102 my $for_submit = delete $attributes{for_submit};
104 if ($attributes{checked}) {
105 $attributes{checked} = 'checked';
107 delete $attributes{checked};
111 $code .= $self->hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit;
112 $code .= $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
113 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
114 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
119 sub radio_button_tag {
120 my ($self, $name, %attributes) = _hashify(2, @_);
122 _set_id_attribute(\%attributes, $name);
123 $attributes{value} = 1 unless exists $attributes{value};
124 my $label = delete $attributes{label};
126 if ($attributes{checked}) {
127 $attributes{checked} = 'checked';
129 delete $attributes{checked};
132 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
133 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
139 my ($self, $name, $value, %attributes) = _hashify(3, @_);
140 return $self->input_tag($name, $value, %attributes, type => 'hidden');
144 my ($self, $content, @slurp) = @_;
145 return $self->html_tag('div', $content, @slurp);
149 my ($self, $content, @slurp) = @_;
150 return $self->html_tag('ul', $content, @slurp);
154 my ($self, $content, @slurp) = @_;
155 return $self->html_tag('li', $content, @slurp);
159 my ($self, $href, $content, %params) = _hashify(3, @_);
163 return $self->html_tag('a', $content, %params, href => $href);
167 my ($self, $name, $value, %attributes) = _hashify(3, @_);
169 if ( $attributes{confirm} ) {
170 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
173 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
177 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
179 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
180 $attributes{type} ||= 'button';
182 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
184 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
187 sub ajax_submit_tag {
188 my ($self, $url, $form_selector, $text, @slurp) = @_;
191 $form_selector = _J($form_selector);
192 my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
194 return $self->button_tag($onclick, $text, @slurp);
198 my ($self, $name, $value, %attributes) = _hashify(3, @_);
200 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
204 my ($self, $data) = @_;
205 return $self->html_tag('script', $data, type => 'text/javascript');
212 foreach my $file (@_) {
213 $file .= '.css' unless $file =~ m/\.css$/;
214 $file = "css/${file}" unless $file =~ m|/|;
216 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
222 my $date_tag_id_idx = 0;
224 my ($self, $name, $value, %params) = _hashify(3, @_);
226 _set_id_attribute(\%params, $name);
227 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
228 my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker');
229 push @classes, delete($params{class}) if $params{class};
230 my %class = @classes ? (class => join(' ', @classes)) : ();
232 $::request->presenter->need_reinit_widgets($params{id});
234 return $self->input_tag(
235 $name, blessed($value) ? $value->to_lxoffice : $value,
237 onblur => "check_right_date_format(this);",
243 sub customer_picker {
244 my ($self, $name, $value, %params) = @_;
245 my $name_e = _H($name);
247 $::request->{layout}->add_javascripts('autocomplete_customer.js');
249 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
250 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
253 # simple version with select_tag
254 sub vendor_selector {
255 my ($self, $name, $value, %params) = @_;
257 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
258 (ref $value && $value->can('id')) ? $value->id : '';
260 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
261 default => $actual_vendor_id,
262 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
268 # simple version with select_tag
270 my ($self, $name, $value, %params) = @_;
272 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
273 (ref $value && $value->can('id')) ? $value->id : '';
275 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
276 default => $actual_part_id,
277 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
287 foreach my $file (@_) {
288 $file .= '.js' unless $file =~ m/\.js$/;
289 $file = "js/${file}" unless $file =~ m|/|;
291 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
298 my ($self, $tabs, %params) = _hashify(2, @_);
299 my $id = $params{id} || 'tab_' . _tag_id();
301 $params{selected} *= 1;
303 die 'L.tabbed needs an arrayred of tabs for first argument'
304 unless ref $tabs eq 'ARRAY';
306 my (@header, @blocks);
307 for my $i (0..$#$tabs) {
308 my $tab = $tabs->[$i];
312 my $tab_id = "__tab_id_$i";
313 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
314 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
317 return '' unless @header;
319 my $ul = $self->ul_tag(join('', @header), id => $id);
320 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
324 my ($self, $name, $src, %params) = _hashify(3, @_);
326 $params{method} ||= 'process';
328 return () if defined $params{if} && !$params{if};
331 if ($params{method} eq 'raw') {
333 } elsif ($params{method} eq 'process') {
334 $data = $self->_context->process($src, %{ $params{args} || {} });
336 die "unknown tag method '$params{method}'";
339 return () unless $data;
341 return +{ name => $name, data => $data };
345 my ($self, $name, $value, %attributes) = _hashify(3, @_);
348 my $min = delete $attributes{min_rows} || 1;
350 if (exists $attributes{cols}) {
351 $cols = delete $attributes{cols};
352 $rows = $::form->numtextrows($value, $cols);
354 $rows = delete $attributes{rows} || 1;
358 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
359 : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
362 sub multiselect2side {
363 my ($self, $id, %params) = _hashify(2, @_);
365 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
366 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
367 $params{moveOptions} = 'false';
369 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
371 <script type="text/javascript">
372 \$().ready(function() {
373 \$('#${id}').multiselect2side({ ${vars} });
381 sub sortable_element {
382 my ($self, $selector, %params) = _hashify(2, @_);
384 my %attributes = ( distance => 5,
385 helper => <<'JAVASCRIPT' );
386 function(event, ui) {
387 ui.children().each(function() {
388 $(this).width($(this).width());
396 if ($params{url} && $params{with}) {
397 my $as = $params{as} || $params{with};
398 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
399 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
401 my $params_js = $params{params} ? qq| + ($params{params})| : '';
403 $stop_event = <<JAVASCRIPT;
404 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
408 if (!$params{dont_recolor}) {
409 $stop_event .= <<JAVASCRIPT;
410 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
411 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
416 $attributes{stop} = <<JAVASCRIPT;
417 function(event, ui) {
424 $params{handle} = '.dragdrop' unless exists $params{handle};
425 $attributes{handle} = "'$params{handle}'" if $params{handle};
427 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
429 my $code = <<JAVASCRIPT;
430 <script type="text/javascript">
432 \$( "${selector}" ).sortable({ ${attr_str} })
442 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
445 sub sortable_table_header {
446 my ($self, $by, %params) = _hashify(2, @_);
448 my $controller = $self->{CONTEXT}->stash->get('SELF');
449 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
450 my $sort_spec = $models->get_sort_spec;
451 my $by_spec = $sort_spec->{$by};
452 my %current_sort_params = $models->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{sort_by} eq $by) {
457 my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
458 $image = '<img border="0" src="image/' . $current_dir . '.png">';
459 $new_dir = 1 - ($current_sort_params{sort_dir} || 0);
462 $params{ $models->sorted->form_params->[0] } = $by;
463 $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
465 return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
468 sub paginate_controls {
469 my ($self, %params) = _hashify(1, @_);
471 my $controller = $self->{CONTEXT}->stash->get('SELF');
472 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
473 my $pager = $models->paginated;
474 # my $paginate_spec = $controller->get_paginate_spec;
476 my %paginate_params = $models->get_paginate_args;
478 my %template_params = (
479 pages => \%paginate_params,
481 my %url_params = _hashify(0, @_);
482 $url_params{ $pager->form_params->[0] } = delete $url_params{page};
483 $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
485 return $models->get_callback(%url_params);
490 return SL::Presenter->get->render('common/paginate', %template_params);
499 SL::Templates::Plugin::L -- Layouting / tag generation
503 Usage from a template:
507 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
509 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
510 { direction => 'right', display => 'To the right' } ],
511 value_key => 'direction', title_key => 'display', default => 'right')) %]
513 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
514 { direction => 'right', display => 'To the right', selected => 1 } ],
515 value_key => 'direction', title_key => 'display')) %]
519 A module modeled a bit after Rails' ActionView helpers. Several small
520 functions that create HTML tags from various kinds of data sources.
522 The C<id> attribute is usually calculated automatically. This can be
523 overridden by either specifying an C<id> attribute or by setting
528 =head2 LOW-LEVEL FUNCTIONS
530 The following items are just forwarded to L<SL::Presenter::Tag>:
534 =item * C<name_to_id $name>
536 =item * C<stringify_attributes %items>
538 =item * C<html_tag $tag_name, $content_string, %attributes>
542 =head2 HIGH-LEVEL FUNCTIONS
544 The following functions are just forwarded to L<SL::Presenter::Tag>:
548 =item * C<input_tag $name, $value, %attributes>
550 =item * C<select_tag $name, \@collection, %attributes>
554 Available high-level functions implemented in this module:
558 =item C<yes_no_tag $name, $value, %attributes>
560 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
561 calling L<select_tag>. C<$value> determines
562 which entry is selected. The C<%attributes> are passed through to
565 =item C<hidden_tag $name, $value, %attributes>
567 Creates a HTML 'input type=hidden' tag named C<$name> with the value
568 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
569 tag's C<id> defaults to C<name_to_id($name)>.
571 =item C<submit_tag $name, $value, %attributes>
573 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
574 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
575 tag's C<id> defaults to C<name_to_id($name)>.
577 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
578 be added via the C<onclick> handler asking the question given with
579 C<$attributes{confirm}>. The request is only submitted if the user
580 clicks the dialog's ok/yes button.
582 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
584 Creates a HTML 'input type="button"' tag with a very specific onclick
585 handler that submits the form given by the jQuery selector
586 C<$form_selector> to the URL C<$url> (the actual JavaScript function
587 called for that is C<kivi.submit_ajax_form()> in
588 C<js/client_js.js>). The button's label will be C<$text>.
590 =item C<button_tag $onclick, $text, %attributes>
592 Creates a HTML 'input type="button"' tag with an onclick handler
593 C<$onclick> and a value of C<$text>. The button does not have a name
594 nor an ID by default.
596 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
597 be prepended to the C<$onclick> handler asking the question given with
598 C<$attributes{confirm}>. The request is only submitted if the user
599 clicks the dialog's "ok/yes" button.
601 =item C<textarea_tag $name, $value, %attributes>
603 Creates a HTML 'textarea' tag named C<$name> with the content
604 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
605 tag's C<id> defaults to C<name_to_id($name)>.
607 =item C<checkbox_tag $name, %attributes>
609 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
610 HTML attributes from C<%attributes>. The tag's C<id> defaults to
611 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
613 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
614 created with said C<label>. No attribute named C<label> is created in
617 If C<%attributes> contains a key C<checkall> then the value is taken as a
618 JQuery selector and clicking this checkbox will also toggle all checkboxes
619 matching the selector.
621 =item C<date_tag $name, $value, %attributes>
623 Creates a date input field, with an attached javascript that will open a
626 =item C<radio_button_tag $name, %attributes>
628 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
629 HTML attributes from C<%attributes>. The tag's C<value> defaults to
630 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
632 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
633 created with said C<label>. No attribute named C<label> is created in
636 =item C<javascript_tag $file1, $file2, $file3...>
638 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
639 tag for each file name parameter passed. Each file name will be
640 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
641 doesn't contain a slash.
643 =item C<stylesheet_tag $file1, $file2, $file3...>
645 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
646 for each file name parameter passed. Each file name will be postfixed
647 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
650 =item C<tabbed \@tab, %attributes>
652 Will create a tabbed area. The tabs should be created with the helper function
656 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
657 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
660 =item C<areainput_tag $name, $content, %PARAMS>
662 Creates a generic input tag or textarea tag, depending on content size. The
663 amount of desired rows must be either given with the C<rows> parameter or can
664 be computed from the value and the C<cols> paramter, Accepted parameters
665 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
667 You can force input by setting rows to 1, and you can force textarea by setting
670 =item C<multiselect2side $id, %params>
672 Creates a JavaScript snippet calling the jQuery function
673 C<multiselect2side> on the select control with the ID C<$id>. The
674 select itself is not created. C<%params> can contain the following
681 The label of the list of available options. Defaults to the
682 translation of 'Available'.
686 The label of the list of selected options. Defaults to the
687 translation of 'Selected'.
691 =item C<sortable_element $selector, %params>
693 Makes the children of the DOM element C<$selector> (a jQuery selector)
694 sortable with the I<jQuery UI Selectable> library. The children can be
695 dragged & dropped around. After dropping an element an URL can be
696 postet to with the element IDs of the sorted children.
698 If this is used then the JavaScript file C<js/jquery-ui.js> must be
699 included manually as well as it isn't loaded via C<$::form-gt;header>.
701 C<%params> can contain the following entries:
707 The URL to POST an AJAX request to after a dragged element has been
708 dropped. The AJAX request's return value is ignored. If given then
709 C<$params{with}> must be given as well.
713 A string that is interpreted as the prefix of the children's ID. Upon
714 POSTing the result each child whose ID starts with C<$params{with}> is
715 considered. The prefix and the following "_" is removed from the
716 ID. The remaining parts of the IDs of those children are posted as a
717 single array parameter. The array parameter's name is either
718 C<$params{as}> or, missing that, C<$params{with}>.
722 Sets the POST parameter name for AJAX request after dropping an
723 element (see C<$params{with}>).
727 An optional jQuery selector specifying which part of the child element
728 is dragable. If the parameter is not given then it defaults to
729 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
730 parameter is set and empty then the whole child element is dragable,
731 and clicks through to underlying elements like inputs or links might
734 =item C<dont_recolor>
736 If trueish then the children will not be recolored. The default is to
737 recolor the children by setting the class C<listrow0> on odd and
738 C<listrow1> on even entries.
742 An optional JavaScript string that is evaluated before sending the
743 POST request. The result must be a string that is appended to the URL.
749 <script type="text/javascript" src="js/jquery-ui.js"></script>
751 <table id="thing_list">
753 <tr><td>This</td><td>That</td></tr>
756 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
757 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
758 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
762 [% L.sortable_element('#thing_list tbody',
763 url => 'controller.pl?action=SystemThings/reorder',
766 recolor_rows => 1) %]
768 After dropping e.g. the third element at the top of the list a POST
769 request would be made to the C<reorder> action of the C<SystemThings>
770 controller with a single parameter called C<thing_ids> -- an array
771 containing the values C<[ 6, 2, 15 ]>.
775 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
777 =item C<sortable_table_header $by, %params>
779 Create a link and image suitable for placement in a table
780 header. C<$by> must be an index set up by the controller with
781 L<SL::Controller::Helper::make_sorted>.
783 The optional parameter C<$params{title}> can override the column title
784 displayed to the user. Otherwise the column title from the
785 controller's sort spec is used.
787 The other parameters in C<%params> are passed unmodified to the
788 underlying call to L<SL::Controller::Base::url_for>.
790 See the documentation of L<SL::Controller::Helper::Sorted> for an
791 overview and further usage instructions.
793 =item C<paginate_controls>
795 Create a set of links used to paginate a list view.
797 See the documentation of L<SL::Controller::Helper::Paginated> for an
798 overview and further usage instructions.
802 =head2 CONVERSION FUNCTIONS
806 =item C<tab, description, target, %PARAMS>
808 Creates a tab for C<tabbed>. The description will be used as displayed name.
809 The target should be a block or template that can be processed. C<tab> supports
810 a C<method> parameter, which can override the process method to apply target.
811 C<method => 'raw'> will just include the given text as is. I was too lazy to
812 implement C<include> properly.
814 Also an C<if> attribute is supported, so that tabs can be suppressed based on
815 some occasion. In this case the supplied block won't even get processed, and
816 the resulting tab will get ignored by C<tabbed>:
818 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
820 =item C<truncate $text, [%params]>
822 See L<SL::Presenter::Text/truncate>.
824 =item C<simple_format $text>
826 See L<SL::Presenter::Text/simple_format>.
830 =head1 MODULE AUTHORS
832 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
834 L<http://linet-services.de>