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};
103 if ($attributes{checked}) {
104 $attributes{checked} = 'checked';
106 delete $attributes{checked};
109 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
110 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
111 $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
116 sub radio_button_tag {
117 my ($self, $name, %attributes) = _hashify(2, @_);
119 _set_id_attribute(\%attributes, $name);
120 $attributes{value} = 1 unless exists $attributes{value};
121 my $label = delete $attributes{label};
123 if ($attributes{checked}) {
124 $attributes{checked} = 'checked';
126 delete $attributes{checked};
129 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
130 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
136 my ($self, $name, $value, %attributes) = _hashify(3, @_);
137 return $self->input_tag($name, $value, %attributes, type => 'hidden');
141 my ($self, $content, @slurp) = @_;
142 return $self->html_tag('div', $content, @slurp);
146 my ($self, $content, @slurp) = @_;
147 return $self->html_tag('ul', $content, @slurp);
151 my ($self, $content, @slurp) = @_;
152 return $self->html_tag('li', $content, @slurp);
156 my ($self, $href, $content, %params) = _hashify(3, @_);
160 return $self->html_tag('a', $content, %params, href => $href);
164 my ($self, $name, $value, %attributes) = _hashify(3, @_);
166 if ( $attributes{confirm} ) {
167 $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
170 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
174 my ($self, $onclick, $value, %attributes) = _hashify(3, @_);
176 _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
177 $attributes{type} ||= 'button';
179 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
181 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
184 sub ajax_submit_tag {
185 my ($self, $url, $form_selector, $text, @slurp) = @_;
188 $form_selector = _J($form_selector);
189 my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
191 return $self->button_tag($onclick, $text, @slurp);
195 my ($self, $name, $value, %attributes) = _hashify(3, @_);
197 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
201 my ($self, $data) = @_;
202 return $self->html_tag('script', $data, type => 'text/javascript');
209 foreach my $file (@_) {
210 $file .= '.css' unless $file =~ m/\.css$/;
211 $file = "css/${file}" unless $file =~ m|/|;
213 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
219 my $date_tag_id_idx = 0;
221 my ($self, $name, $value, %params) = _hashify(3, @_);
223 _set_id_attribute(\%params, $name);
224 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
225 my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker');
226 push @classes, delete($params{class}) if $params{class};
227 my %class = @classes ? (class => join(' ', @classes)) : ();
229 $::request->presenter->need_reinit_widgets($params{id});
231 return $self->input_tag(
232 $name, blessed($value) ? $value->to_lxoffice : $value,
234 onblur => "check_right_date_format(this);",
240 sub customer_picker {
241 my ($self, $name, $value, %params) = @_;
242 my $name_e = _H($name);
244 $::request->{layout}->add_javascripts('autocomplete_customer.js');
246 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
247 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
250 # simple version with select_tag
251 sub vendor_selector {
252 my ($self, $name, $value, %params) = @_;
254 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
255 (ref $value && $value->can('id')) ? $value->id : '';
257 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
258 default => $actual_vendor_id,
259 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
265 # simple version with select_tag
267 my ($self, $name, $value, %params) = @_;
269 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
270 (ref $value && $value->can('id')) ? $value->id : '';
272 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
273 default => $actual_part_id,
274 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
284 foreach my $file (@_) {
285 $file .= '.js' unless $file =~ m/\.js$/;
286 $file = "js/${file}" unless $file =~ m|/|;
288 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
295 my ($self, $tabs, %params) = _hashify(2, @_);
296 my $id = $params{id} || 'tab_' . _tag_id();
298 $params{selected} *= 1;
300 die 'L.tabbed needs an arrayred of tabs for first argument'
301 unless ref $tabs eq 'ARRAY';
303 my (@header, @blocks);
304 for my $i (0..$#$tabs) {
305 my $tab = $tabs->[$i];
309 my $tab_id = "__tab_id_$i";
310 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
311 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
314 return '' unless @header;
316 my $ul = $self->ul_tag(join('', @header), id => $id);
317 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
321 my ($self, $name, $src, %params) = _hashify(3, @_);
323 $params{method} ||= 'process';
325 return () if defined $params{if} && !$params{if};
328 if ($params{method} eq 'raw') {
330 } elsif ($params{method} eq 'process') {
331 $data = $self->_context->process($src, %{ $params{args} || {} });
333 die "unknown tag method '$params{method}'";
336 return () unless $data;
338 return +{ name => $name, data => $data };
342 my ($self, $name, $value, %attributes) = _hashify(3, @_);
345 my $min = delete $attributes{min_rows} || 1;
347 if (exists $attributes{cols}) {
348 $cols = delete $attributes{cols};
349 $rows = $::form->numtextrows($value, $cols);
351 $rows = delete $attributes{rows} || 1;
355 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
356 : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
359 sub multiselect2side {
360 my ($self, $id, %params) = _hashify(2, @_);
362 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
363 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
364 $params{moveOptions} = 'false';
366 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
368 <script type="text/javascript">
369 \$().ready(function() {
370 \$('#${id}').multiselect2side({ ${vars} });
378 sub sortable_element {
379 my ($self, $selector, %params) = _hashify(2, @_);
381 my %attributes = ( distance => 5,
382 helper => <<'JAVASCRIPT' );
383 function(event, ui) {
384 ui.children().each(function() {
385 $(this).width($(this).width());
393 if ($params{url} && $params{with}) {
394 my $as = $params{as} || $params{with};
395 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
396 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
398 my $params_js = $params{params} ? qq| + ($params{params})| : '';
400 $stop_event = <<JAVASCRIPT;
401 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
405 if (!$params{dont_recolor}) {
406 $stop_event .= <<JAVASCRIPT;
407 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
408 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
413 $attributes{stop} = <<JAVASCRIPT;
414 function(event, ui) {
421 $params{handle} = '.dragdrop' unless exists $params{handle};
422 $attributes{handle} = "'$params{handle}'" if $params{handle};
424 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
426 my $code = <<JAVASCRIPT;
427 <script type="text/javascript">
429 \$( "${selector}" ).sortable({ ${attr_str} })
439 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
442 sub sortable_table_header {
443 my ($self, $by, %params) = _hashify(2, @_);
445 my $controller = $self->{CONTEXT}->stash->get('SELF');
446 my $sort_spec = $controller->get_sort_spec;
447 my $by_spec = $sort_spec->{$by};
448 my %current_sort_params = $controller->get_current_sort_params;
449 my ($image, $new_dir) = ('', $current_sort_params{dir});
450 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
452 if ($current_sort_params{by} eq $by) {
453 my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
454 $image = '<img border="0" src="image/' . $current_dir . '.png">';
455 $new_dir = 1 - ($current_sort_params{dir} || 0);
458 $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
459 $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
461 return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
464 sub paginate_controls {
465 my ($self, %params) = _hashify(1, @_);
467 my $controller = $self->{CONTEXT}->stash->get('SELF');
468 my $paginate_spec = $controller->get_paginate_spec;
469 my %paginate_params = $controller->get_current_paginate_params;
471 my %template_params = (
472 pages => \%paginate_params,
474 my %url_params = _hashify(0, @_);
475 $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page};
476 $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
478 return $controller->get_callback(%url_params);
483 return SL::Presenter->get->render('common/paginate', %template_params);
492 SL::Templates::Plugin::L -- Layouting / tag generation
496 Usage from a template:
500 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
502 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
503 { direction => 'right', display => 'To the right' } ],
504 value_key => 'direction', title_key => 'display', default => 'right')) %]
506 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
507 { direction => 'right', display => 'To the right', selected => 1 } ],
508 value_key => 'direction', title_key => 'display')) %]
512 A module modeled a bit after Rails' ActionView helpers. Several small
513 functions that create HTML tags from various kinds of data sources.
515 The C<id> attribute is usually calculated automatically. This can be
516 overridden by either specifying an C<id> attribute or by setting
521 =head2 LOW-LEVEL FUNCTIONS
523 The following items are just forwarded to L<SL::Presenter::Tag>:
527 =item * C<name_to_id $name>
529 =item * C<stringify_attributes %items>
531 =item * C<html_tag $tag_name, $content_string, %attributes>
535 =head2 HIGH-LEVEL FUNCTIONS
537 The following functions are just forwarded to L<SL::Presenter::Tag>:
541 =item * C<input_tag $name, $value, %attributes>
543 =item * C<select_tag $name, \@collection, %attributes>
547 Available high-level functions implemented in this module:
551 =item C<yes_no_tag $name, $value, %attributes>
553 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
554 calling L<select_tag>. C<$value> determines
555 which entry is selected. The C<%attributes> are passed through to
558 =item C<hidden_tag $name, $value, %attributes>
560 Creates a HTML 'input type=hidden' tag named C<$name> with the value
561 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
562 tag's C<id> defaults to C<name_to_id($name)>.
564 =item C<submit_tag $name, $value, %attributes>
566 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
567 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
568 tag's C<id> defaults to C<name_to_id($name)>.
570 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
571 be added via the C<onclick> handler asking the question given with
572 C<$attributes{confirm}>. The request is only submitted if the user
573 clicks the dialog's ok/yes button.
575 =item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
577 Creates a HTML 'input type="button"' tag with a very specific onclick
578 handler that submits the form given by the jQuery selector
579 C<$form_selector> to the URL C<$url> (the actual JavaScript function
580 called for that is C<kivi.submit_ajax_form()> in
581 C<js/client_js.js>). The button's label will be C<$text>.
583 =item C<button_tag $onclick, $text, %attributes>
585 Creates a HTML 'input type="button"' tag with an onclick handler
586 C<$onclick> and a value of C<$text>. The button does not have a name
587 nor an ID by default.
589 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
590 be prepended to the C<$onclick> handler asking the question given with
591 C<$attributes{confirm}>. The request is only submitted if the user
592 clicks the dialog's "ok/yes" button.
594 =item C<textarea_tag $name, $value, %attributes>
596 Creates a HTML 'textarea' tag named C<$name> with the content
597 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
598 tag's C<id> defaults to C<name_to_id($name)>.
600 =item C<checkbox_tag $name, %attributes>
602 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
603 HTML attributes from C<%attributes>. The tag's C<id> defaults to
604 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
606 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
607 created with said C<label>. No attribute named C<label> is created in
610 If C<%attributes> contains a key C<checkall> then the value is taken as a
611 JQuery selector and clicking this checkbox will also toggle all checkboxes
612 matching the selector.
614 =item C<date_tag $name, $value, %attributes>
616 Creates a date input field, with an attached javascript that will open a
619 =item C<radio_button_tag $name, %attributes>
621 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
622 HTML attributes from C<%attributes>. The tag's C<value> defaults to
623 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
625 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
626 created with said C<label>. No attribute named C<label> is created in
629 =item C<javascript_tag $file1, $file2, $file3...>
631 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
632 tag for each file name parameter passed. Each file name will be
633 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
634 doesn't contain a slash.
636 =item C<stylesheet_tag $file1, $file2, $file3...>
638 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
639 for each file name parameter passed. Each file name will be postfixed
640 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
643 =item C<tabbed \@tab, %attributes>
645 Will create a tabbed area. The tabs should be created with the helper function
649 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
650 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
653 =item C<areainput_tag $name, $content, %PARAMS>
655 Creates a generic input tag or textarea tag, depending on content size. The
656 amount of desired rows must be either given with the C<rows> parameter or can
657 be computed from the value and the C<cols> paramter, Accepted parameters
658 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
660 You can force input by setting rows to 1, and you can force textarea by setting
663 =item C<multiselect2side $id, %params>
665 Creates a JavaScript snippet calling the jQuery function
666 C<multiselect2side> on the select control with the ID C<$id>. The
667 select itself is not created. C<%params> can contain the following
674 The label of the list of available options. Defaults to the
675 translation of 'Available'.
679 The label of the list of selected options. Defaults to the
680 translation of 'Selected'.
684 =item C<sortable_element $selector, %params>
686 Makes the children of the DOM element C<$selector> (a jQuery selector)
687 sortable with the I<jQuery UI Selectable> library. The children can be
688 dragged & dropped around. After dropping an element an URL can be
689 postet to with the element IDs of the sorted children.
691 If this is used then the JavaScript file C<js/jquery-ui.js> must be
692 included manually as well as it isn't loaded via C<$::form-gt;header>.
694 C<%params> can contain the following entries:
700 The URL to POST an AJAX request to after a dragged element has been
701 dropped. The AJAX request's return value is ignored. If given then
702 C<$params{with}> must be given as well.
706 A string that is interpreted as the prefix of the children's ID. Upon
707 POSTing the result each child whose ID starts with C<$params{with}> is
708 considered. The prefix and the following "_" is removed from the
709 ID. The remaining parts of the IDs of those children are posted as a
710 single array parameter. The array parameter's name is either
711 C<$params{as}> or, missing that, C<$params{with}>.
715 Sets the POST parameter name for AJAX request after dropping an
716 element (see C<$params{with}>).
720 An optional jQuery selector specifying which part of the child element
721 is dragable. If the parameter is not given then it defaults to
722 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
723 parameter is set and empty then the whole child element is dragable,
724 and clicks through to underlying elements like inputs or links might
727 =item C<dont_recolor>
729 If trueish then the children will not be recolored. The default is to
730 recolor the children by setting the class C<listrow0> on odd and
731 C<listrow1> on even entries.
735 An optional JavaScript string that is evaluated before sending the
736 POST request. The result must be a string that is appended to the URL.
742 <script type="text/javascript" src="js/jquery-ui.js"></script>
744 <table id="thing_list">
746 <tr><td>This</td><td>That</td></tr>
749 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
750 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
751 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
755 [% L.sortable_element('#thing_list tbody',
756 url => 'controller.pl?action=SystemThings/reorder',
759 recolor_rows => 1) %]
761 After dropping e.g. the third element at the top of the list a POST
762 request would be made to the C<reorder> action of the C<SystemThings>
763 controller with a single parameter called C<thing_ids> -- an array
764 containing the values C<[ 6, 2, 15 ]>.
768 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
770 =item C<sortable_table_header $by, %params>
772 Create a link and image suitable for placement in a table
773 header. C<$by> must be an index set up by the controller with
774 L<SL::Controller::Helper::make_sorted>.
776 The optional parameter C<$params{title}> can override the column title
777 displayed to the user. Otherwise the column title from the
778 controller's sort spec is used.
780 The other parameters in C<%params> are passed unmodified to the
781 underlying call to L<SL::Controller::Base::url_for>.
783 See the documentation of L<SL::Controller::Helper::Sorted> for an
784 overview and further usage instructions.
786 =item C<paginate_controls>
788 Create a set of links used to paginate a list view.
790 See the documentation of L<SL::Controller::Helper::Paginated> for an
791 overview and further usage instructions.
795 =head2 CONVERSION FUNCTIONS
799 =item C<tab, description, target, %PARAMS>
801 Creates a tab for C<tabbed>. The description will be used as displayed name.
802 The target should be a block or template that can be processed. C<tab> supports
803 a C<method> parameter, which can override the process method to apply target.
804 C<method => 'raw'> will just include the given text as is. I was too lazy to
805 implement C<include> properly.
807 Also an C<if> attribute is supported, so that tabs can be suppressed based on
808 some occasion. In this case the supplied block won't even get processed, and
809 the resulting tab will get ignored by C<tabbed>:
811 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
813 =item C<truncate $text, [%params]>
815 See L<SL::Presenter::Text/truncate>.
817 =item C<simple_format $text>
819 See L<SL::Presenter::Text/simple_format>.
823 =head1 MODULE AUTHORS
825 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
827 L<http://linet-services.de>