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);
13 { # This will give you an id for identifying html tags and such.
14 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
15 # Do not use these id's to store information across requests.
16 my $_id_sequence = int rand 1e7;
18 return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
24 return $::locale->quote_special_chars('HTML', $string);
29 $string =~ s/(\"|\'|\\)/\\$1/g;
34 return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
38 my ($class, $context, @args) = @_;
46 die 'not an accessor' if @_ > 1;
47 return $_[0]->{CONTEXT};
51 my ($method, $self, @args) = @_;
53 my $presenter = $::request->presenter;
55 if (!$presenter->can($method)) {
56 $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
60 splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
62 $presenter->$method(@args);
65 sub name_to_id { return _call_presenter('name_to_id', @_); }
66 sub html_tag { return _call_presenter('html_tag', @_); }
67 sub select_tag { return _call_presenter('select_tag', @_); }
68 sub input_tag { return _call_presenter('input_tag', @_); }
69 sub truncate { return _call_presenter('truncate', @_); }
70 sub simple_format { return _call_presenter('simple_format', @_); }
73 my ($self, @slurp) = @_;
74 my %options = _hashify(@slurp);
78 return $self->html_tag('img', undef, %options);
82 my ($self, $name, $content, @slurp) = @_;
83 my %attributes = _hashify(@slurp);
85 $attributes{id} ||= $self->name_to_id($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, @slurp) = @_;
95 my %attributes = _hashify(@slurp);
97 $attributes{id} ||= $self->name_to_id($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 {
118 my %attributes = _hashify(@_);
120 $attributes{value} = 1 unless defined $attributes{value};
121 $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
122 my $label = delete $attributes{label};
124 if ($attributes{checked}) {
125 $attributes{checked} = 'checked';
127 delete $attributes{checked};
130 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
131 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
137 my ($self, $name, $value, @slurp) = @_;
138 return $self->input_tag($name, $value, _hashify(@slurp), type => 'hidden');
142 my ($self, $content, @slurp) = @_;
143 return $self->html_tag('div', $content, @slurp);
147 my ($self, $content, @slurp) = @_;
148 return $self->html_tag('ul', $content, @slurp);
152 my ($self, $content, @slurp) = @_;
153 return $self->html_tag('li', $content, @slurp);
157 my ($self, $href, $content, @slurp) = @_;
158 my %params = _hashify(@slurp);
162 return $self->html_tag('a', $content, %params, href => $href);
166 my ($self, $name, $value, @slurp) = @_;
167 my %attributes = _hashify(@slurp);
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, @slurp) = @_;
178 my %attributes = _hashify(@slurp);
180 $attributes{id} ||= $self->name_to_id($attributes{name}) if $attributes{name};
181 $attributes{type} ||= 'button';
183 $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
185 return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
189 my ($self, $name, $value) = splice @_, 0, 3;
190 my %attributes = _hashify(@_);
192 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
196 my ($self, $data) = @_;
197 return $self->html_tag('script', $data, type => 'text/javascript');
204 foreach my $file (@_) {
205 $file .= '.css' unless $file =~ m/\.css$/;
206 $file = "css/${file}" unless $file =~ m|/|;
208 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
214 my $date_tag_id_idx = 0;
216 my ($self, $name, $value, @slurp) = @_;
218 my %params = _hashify(@slurp);
219 my $id = $self->name_to_id($name) . _tag_id();
220 my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
221 my @class = $params{no_cal} || $params{readonly} ? () : (class => 'datepicker');
223 return $self->input_tag(
224 $name, blessed($value) ? $value->to_lxoffice : $value,
227 onblur => "check_right_date_format(this);",
233 sub customer_picker {
234 my ($self, $name, $value, %params) = @_;
235 my $name_e = _H($name);
237 $::request->{layout}->add_javascripts('autocomplete_customer.js');
239 $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') .
240 $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params);
243 # simple version with select_tag
244 sub vendor_selector {
245 my ($self, $name, $value, %params) = @_;
247 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
248 (ref $value && $value->can('id')) ? $value->id : '';
250 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
251 default => $actual_vendor_id,
252 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
258 # simple version with select_tag
260 my ($self, $name, $value, %params) = @_;
262 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
263 (ref $value && $value->can('id')) ? $value->id : '';
265 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
266 default => $actual_part_id,
267 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
277 foreach my $file (@_) {
278 $file .= '.js' unless $file =~ m/\.js$/;
279 $file = "js/${file}" unless $file =~ m|/|;
281 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
288 my ($self, $tabs, @slurp) = @_;
289 my %params = _hashify(@slurp);
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, @slurp) = @_;
316 my %params = _hashify(@slurp);
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, @slurp) = @_;
338 my %attributes = _hashify(@slurp);
341 my $min = delete $attributes{min_rows} || 1;
343 if (exists $attributes{cols}) {
344 $cols = delete $attributes{cols};
345 $rows = $::form->numtextrows($value, $cols);
347 $rows = delete $attributes{rows} || 1;
351 ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
352 : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
355 sub multiselect2side {
356 my ($self, $id, @slurp) = @_;
357 my %params = _hashify(@slurp);
359 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
360 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
361 $params{moveOptions} = 'false';
363 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
365 <script type="text/javascript">
366 \$().ready(function() {
367 \$('#${id}').multiselect2side({ ${vars} });
375 sub sortable_element {
376 my ($self, $selector, @slurp) = @_;
377 my %params = _hashify(@slurp);
379 my %attributes = ( distance => 5,
380 helper => <<'JAVASCRIPT' );
381 function(event, ui) {
382 ui.children().each(function() {
383 $(this).width($(this).width());
391 if ($params{url} && $params{with}) {
392 my $as = $params{as} || $params{with};
393 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
394 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
396 $stop_event = <<JAVASCRIPT;
397 \$.post('$params{url}', { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() });
401 if (!$params{dont_recolor}) {
402 $stop_event .= <<JAVASCRIPT;
403 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
404 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
409 $attributes{stop} = <<JAVASCRIPT;
410 function(event, ui) {
417 $params{handle} = '.dragdrop' unless exists $params{handle};
418 $attributes{handle} = "'$params{handle}'" if $params{handle};
420 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
422 my $code = <<JAVASCRIPT;
423 <script type="text/javascript">
425 \$( "${selector}" ).sortable({ ${attr_str} })
433 sub online_help_tag {
434 my ($self, $tag, @slurp) = @_;
435 my %params = _hashify(@slurp);
436 my $cc = $::myconfig{countrycode};
437 my $file = "doc/online/$cc/$tag.html";
438 my $text = $params{text} || $::locale->text('Help');
440 die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
441 return unless -f $file;
442 return $self->html_tag('a', $text, href => $file, class => 'jqModal')
447 require Data::Dumper;
448 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
451 sub sortable_table_header {
452 my ($self, $by, @slurp) = @_;
453 my %params = _hashify(@slurp);
455 my $controller = $self->{CONTEXT}->stash->get('SELF');
456 my $sort_spec = $controller->get_sort_spec;
457 my $by_spec = $sort_spec->{$by};
458 my %current_sort_params = $controller->get_current_sort_params;
459 my ($image, $new_dir) = ('', $current_sort_params{dir});
460 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
462 if ($current_sort_params{by} eq $by) {
463 my $current_dir = $current_sort_params{dir} ? 'up' : 'down';
464 $image = '<img border="0" src="image/' . $current_dir . '.png">';
465 $new_dir = 1 - ($current_sort_params{dir} || 0);
468 $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by;
469 $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0');
471 return '<a href="' . $controller->get_callback(%params) . '">' . _H($title) . $image . '</a>';
474 sub paginate_controls {
477 my $controller = $self->{CONTEXT}->stash->get('SELF');
478 my $paginate_spec = $controller->get_paginate_spec;
479 my %paginate_params = $controller->get_current_paginate_params;
481 my %template_params = (
482 pages => \%paginate_params,
484 my %url_params = _hashify(@_);
485 $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page};
486 $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
488 return $controller->get_callback(%url_params);
492 return SL::Presenter->get->render('common/paginate', %template_params);
501 SL::Templates::Plugin::L -- Layouting / tag generation
505 Usage from a template:
509 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
511 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
512 { direction => 'right', display => 'To the right' } ],
513 value_key => 'direction', title_key => 'display', default => 'right')) %]
515 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
516 { direction => 'right', display => 'To the right', selected => 1 } ],
517 value_key => 'direction', title_key => 'display')) %]
521 A module modeled a bit after Rails' ActionView helpers. Several small
522 functions that create HTML tags from various kinds of data sources.
526 =head2 LOW-LEVEL FUNCTIONS
528 The following items are just forwarded to L<SL::Presenter::Tag>:
532 =item * C<name_to_id $name>
534 =item * C<stringify_attributes %items>
536 =item * C<html_tag $tag_name, $content_string, %attributes>
540 =head2 HIGH-LEVEL FUNCTIONS
542 The following functions are just forwarded to L<SL::Presenter::Tag>:
546 =item * C<input_tag $name, $value, %attributes>
548 =item * C<select_tag $name, \@collection, %attributes>
552 Available high-level functions implemented in this module:
556 =item C<yes_no_tag $name, $value, %attributes>
558 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
559 calling L<select_tag>. C<$value> determines
560 which entry is selected. The C<%attributes> are passed through to
563 =item C<hidden_tag $name, $value, %attributes>
565 Creates a HTML 'input type=hidden' tag named C<$name> with the value
566 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
567 tag's C<id> defaults to C<name_to_id($name)>.
569 =item C<submit_tag $name, $value, %attributes>
571 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
572 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
573 tag's C<id> defaults to C<name_to_id($name)>.
575 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
576 be added via the C<onclick> handler asking the question given with
577 C<$attributes{confirm}>. The request is only submitted if the user
578 clicks the dialog's ok/yes button.
580 =item C<button_tag $onclick, $text, %attributes>
582 Creates a HTML 'input type="button"' tag with an onclick handler
583 C<$onclick> and a value of C<$text>. The button does not have a name
584 nor an ID by default.
586 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
587 be prepended to the C<$onclick> handler asking the question given with
588 C<$attributes{confirm}>. The request is only submitted if the user
589 clicks the dialog's "ok/yes" button.
591 =item C<textarea_tag $name, $value, %attributes>
593 Creates a HTML 'textarea' tag named C<$name> with the content
594 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
595 tag's C<id> defaults to C<name_to_id($name)>.
597 =item C<checkbox_tag $name, %attributes>
599 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
600 HTML attributes from C<%attributes>. The tag's C<id> defaults to
601 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
603 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
604 created with said C<label>. No attribute named C<label> is created in
607 If C<%attributes> contains a key C<checkall> then the value is taken as a
608 JQuery selector and clicking this checkbox will also toggle all checkboxes
609 matching the selector.
611 =item C<date_tag $name, $value, %attributes>
613 Creates a date input field, with an attached javascript that will open a
616 =item C<radio_button_tag $name, %attributes>
618 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
619 HTML attributes from C<%attributes>. The tag's C<value> defaults to
620 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
622 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
623 created with said C<label>. No attribute named C<label> is created in
626 =item C<javascript_tag $file1, $file2, $file3...>
628 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
629 tag for each file name parameter passed. Each file name will be
630 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
631 doesn't contain a slash.
633 =item C<stylesheet_tag $file1, $file2, $file3...>
635 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
636 for each file name parameter passed. Each file name will be postfixed
637 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
640 =item C<tabbed \@tab, %attributes>
642 Will create a tabbed area. The tabs should be created with the helper function
646 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
647 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
650 =item C<areainput_tag $name, $content, %PARAMS>
652 Creates a generic input tag or textarea tag, depending on content size. The
653 amount of desired rows must be either given with the C<rows> parameter or can
654 be computed from the value and the C<cols> paramter, Accepted parameters
655 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
657 You can force input by setting rows to 1, and you can force textarea by setting
660 =item C<multiselect2side $id, %params>
662 Creates a JavaScript snippet calling the jQuery function
663 C<multiselect2side> on the select control with the ID C<$id>. The
664 select itself is not created. C<%params> can contain the following
671 The label of the list of available options. Defaults to the
672 translation of 'Available'.
676 The label of the list of selected options. Defaults to the
677 translation of 'Selected'.
681 =item C<sortable_element $selector, %params>
683 Makes the children of the DOM element C<$selector> (a jQuery selector)
684 sortable with the I<jQuery UI Selectable> library. The children can be
685 dragged & dropped around. After dropping an element an URL can be
686 postet to with the element IDs of the sorted children.
688 If this is used then the JavaScript file C<js/jquery-ui.js> must be
689 included manually as well as it isn't loaded via C<$::form-gt;header>.
691 C<%params> can contain the following entries:
697 The URL to POST an AJAX request to after a dragged element has been
698 dropped. The AJAX request's return value is ignored. If given then
699 C<$params{with}> must be given as well.
703 A string that is interpreted as the prefix of the children's ID. Upon
704 POSTing the result each child whose ID starts with C<$params{with}> is
705 considered. The prefix and the following "_" is removed from the
706 ID. The remaining parts of the IDs of those children are posted as a
707 single array parameter. The array parameter's name is either
708 C<$params{as}> or, missing that, C<$params{with}>.
712 Sets the POST parameter name for AJAX request after dropping an
713 element (see C<$params{with}>).
717 An optional jQuery selector specifying which part of the child element
718 is dragable. If the parameter is not given then it defaults to
719 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
720 parameter is set and empty then the whole child element is dragable,
721 and clicks through to underlying elements like inputs or links might
724 =item C<dont_recolor>
726 If trueish then the children will not be recolored. The default is to
727 recolor the children by setting the class C<listrow0> on odd and
728 C<listrow1> on even entries.
734 <script type="text/javascript" src="js/jquery-ui.js"></script>
736 <table id="thing_list">
738 <tr><td>This</td><td>That</td></tr>
741 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
742 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
743 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
747 [% L.sortable_element('#thing_list tbody',
748 url => 'controller.pl?action=SystemThings/reorder',
751 recolor_rows => 1) %]
753 After dropping e.g. the third element at the top of the list a POST
754 request would be made to the C<reorder> action of the C<SystemThings>
755 controller with a single parameter called C<thing_ids> -- an array
756 containing the values C<[ 6, 2, 15 ]>.
760 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
762 =item C<sortable_table_header $by, %params>
764 Create a link and image suitable for placement in a table
765 header. C<$by> must be an index set up by the controller with
766 L<SL::Controller::Helper::make_sorted>.
768 The optional parameter C<$params{title}> can override the column title
769 displayed to the user. Otherwise the column title from the
770 controller's sort spec is used.
772 The other parameters in C<%params> are passed unmodified to the
773 underlying call to L<SL::Controller::Base::url_for>.
775 See the documentation of L<SL::Controller::Helper::Sorted> for an
776 overview and further usage instructions.
778 =item C<paginate_controls>
780 Create a set of links used to paginate a list view.
782 See the documentation of L<SL::Controller::Helper::Paginated> for an
783 overview and further usage instructions.
787 =head2 CONVERSION FUNCTIONS
791 =item C<tab, description, target, %PARAMS>
793 Creates a tab for C<tabbed>. The description will be used as displayed name.
794 The target should be a block or template that can be processed. C<tab> supports
795 a C<method> parameter, which can override the process method to apply target.
796 C<method => 'raw'> will just include the given text as is. I was too lazy to
797 implement C<include> properly.
799 Also an C<if> attribute is supported, so that tabs can be suppressed based on
800 some occasion. In this case the supplied block won't even get processed, and
801 the resulting tab will get ignored by C<tabbed>:
803 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
805 =item C<truncate $text, [%params]>
807 See L<SL::Presenter::Text/truncate>.
809 =item C<simple_format $text>
811 See L<SL::Presenter::Text/simple_format>.
815 =head1 MODULE AUTHORS
817 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
819 L<http://linet-services.de>