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::Presenter::ALL;
12 use SL::Presenter::Simple;
13 use SL::Util qw(_hashify);
17 { # This will give you an id for identifying html tags and such.
18 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
19 # Do not use these id's to store information across requests.
20 my $_id_sequence = int rand 1e7;
22 return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
28 return $::locale->quote_special_chars('HTML', $string);
33 $string =~ s/(\"|\'|\\)/\\$1/g;
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 splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH');
57 if (my $sub = SL::Presenter::Simple->can($method)) {
61 if ($presenter->can($method)) {
62 return $presenter->$method(@args);
65 $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!");
69 sub name_to_id { return _call_presenter('name_to_id', @_); }
70 sub html_tag { return _call_presenter('html_tag', @_); }
71 sub hidden_tag { return _call_presenter('hidden_tag', @_); }
72 sub select_tag { return _call_presenter('select_tag', @_); }
73 sub checkbox_tag { return _call_presenter('checkbox_tag', @_); }
74 sub input_tag { return _call_presenter('input_tag', @_); }
75 sub javascript { return _call_presenter('javascript', @_); }
76 sub truncate { return _call_presenter('truncate', @_); }
77 sub simple_format { return _call_presenter('simple_format', @_); }
78 sub button_tag { return _call_presenter('button_tag', @_); }
79 sub submit_tag { return _call_presenter('submit_tag', @_); }
80 sub ajax_submit_tag { return _call_presenter('ajax_submit_tag', @_); }
81 sub link { return _call_presenter('link_tag', @_); }
82 sub input_number_tag { return _call_presenter('input_number_tag', @_); }
83 sub textarea_tag { return _call_presenter('textarea_tag', @_); }
84 sub date_tag { return _call_presenter('date_tag', @_); }
85 sub div_tag { return _call_presenter('div_tag', @_); }
86 sub radio_button_tag { return _call_presenter('radio_button_tag', @_); }
87 sub img_tag { return _call_presenter('img_tag', @_); }
88 sub restricted_html { return _call_presenter('restricted_html', @_); }
90 sub _set_id_attribute {
91 my ($attributes, $name, $unique) = @_;
92 SL::Presenter::Tag::_set_id_attribute($attributes, $name, $unique);
96 my ($self, $content, @slurp) = @_;
97 return $self->html_tag('ul', $content, @slurp);
101 my ($self, $content, @slurp) = @_;
102 return $self->html_tag('li', $content, @slurp);
106 my ($self, $name, $value, %attributes) = _hashify(3, @_);
108 return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes);
115 foreach my $file (@_) {
116 $file .= '.css' unless $file =~ m/\.css$/;
117 $file = "css/${file}" unless $file =~ m|/|;
119 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
126 # simple version with select_tag
127 sub vendor_selector {
128 my ($self, $name, $value, %params) = _hashify(3, @_);
130 my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) :
131 (ref $value && $value->can('id')) ? $value->id : '';
133 return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(),
134 default => $actual_vendor_id,
135 title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name },
141 # simple version with select_tag
143 my ($self, $name, $value, %params) = _hashify(3, @_);
145 my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) :
146 (ref $value && $value->can('id')) ? $value->id : '';
148 return $self->select_tag($name, SL::DB::Manager::Part->get_all(),
149 default => $actual_part_id,
150 title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description },
160 foreach my $file (@_) {
161 $file .= '.js' unless $file =~ m/\.js$/;
162 $file = "js/${file}" unless $file =~ m|/|;
164 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
171 my ($self, $tabs, %params) = _hashify(2, @_);
172 my $id = $params{id} || 'tab_' . _tag_id();
174 $params{selected} *= 1;
176 die 'L.tabbed needs an arrayred of tabs for first argument'
177 unless ref $tabs eq 'ARRAY';
179 my (@header, @blocks);
180 for my $i (0..$#$tabs) {
181 my $tab = $tabs->[$i];
185 my $tab_id = "__tab_id_$i";
186 push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name}));
187 push @blocks, $self->div_tag($tab->{data}, id => $tab_id);
190 return '' unless @header;
192 my $ul = $self->ul_tag(join('', @header), id => $id);
193 return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget');
197 my ($self, $name, $src, %params) = _hashify(3, @_);
199 $params{method} ||= 'process';
201 return () if defined $params{if} && !$params{if};
204 if ($params{method} eq 'raw') {
206 } elsif ($params{method} eq 'process') {
207 $data = $self->_context->process($src, %{ $params{args} || {} });
209 die "unknown tag method '$params{method}'";
212 return () unless $data;
214 return +{ name => $name, data => $data };
218 my ($self, $name, $value, %attributes) = _hashify(3, @_);
220 my $cols = delete $attributes{cols} || delete $attributes{size};
221 my $minrows = delete $attributes{min_rows} || 1;
222 my $maxrows = delete $attributes{max_rows};
223 my $rows = $::form->numtextrows($value, $cols, $maxrows, $minrows);
225 $attributes{id} ||= _tag_id();
226 my $id = $attributes{id};
228 return $self->textarea_tag($name, $value, %attributes, rows => $rows, cols => $cols) if $rows > 1;
231 . $self->input_tag($name, $value, %attributes, size => $cols)
232 . "<img src=\"image/edit-entry.png\" onclick=\"kivi.switch_areainput_to_textarea('${id}')\" style=\"margin-left: 2px;\">"
236 sub multiselect2side {
237 my ($self, $id, %params) = _hashify(2, @_);
239 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
240 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
241 $params{moveOptions} = 'false';
243 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
245 <script type="text/javascript">
246 \$().ready(function() {
247 \$('#${id}').multiselect2side({ ${vars} });
255 sub sortable_element {
256 my ($self, $selector, %params) = _hashify(2, @_);
258 my %attributes = ( distance => 5,
259 helper => <<'JAVASCRIPT' );
260 function(event, ui) {
261 ui.children().each(function() {
262 $(this).width($(this).width());
270 if ($params{url} && $params{with}) {
271 my $as = $params{as} || $params{with};
272 my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
273 $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
275 my $params_js = $params{params} ? qq| + ($params{params})| : '';
276 my $ajax_return = '';
277 if ($params{ajax_return}) {
278 $ajax_return = 'kivi.eval_json_result';
281 $stop_event = <<JAVASCRIPT;
282 \$.post('$params{url}'${params_js}, { '${as}[]': \$(\$('${selector}').sortable('toArray'))${filter}.toArray() }, $ajax_return);
286 if (!$params{dont_recolor}) {
287 $stop_event .= <<JAVASCRIPT;
288 \$('${selector}>*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
289 \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
294 $attributes{stop} = <<JAVASCRIPT;
295 function(event, ui) {
302 $params{handle} = '.dragdrop' unless exists $params{handle};
303 $attributes{handle} = "'$params{handle}'" if $params{handle};
305 my $attr_str = join(', ', map { "${_}: $attributes{$_}" } keys %attributes);
307 my $code = <<JAVASCRIPT;
308 <script type="text/javascript">
310 \$( "${selector}" ).sortable({ ${attr_str} })
320 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
323 sub sortable_table_header {
324 my ($self, $by, %params) = _hashify(2, @_);
326 my $controller = $self->{CONTEXT}->stash->get('SELF');
327 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
328 my $sort_spec = $models->get_sort_spec;
329 my $by_spec = $sort_spec->{$by};
330 my %current_sort_params = $models->get_current_sort_params;
331 my ($image, $new_dir) = ('', $current_sort_params{dir});
332 my $title = delete($params{title}) || $::locale->text($by_spec->{title});
334 if ($current_sort_params{sort_by} eq $by) {
335 my $current_dir = $current_sort_params{sort_dir} ? 'up' : 'down';
336 $image = '<img border="0" src="image/' . $current_dir . '.png">';
337 $new_dir = 1 - ($current_sort_params{sort_dir} || 0);
340 $params{ $models->sorted->form_params->[0] } = $by;
341 $params{ $models->sorted->form_params->[1] } = ($new_dir ? '1' : '0');
343 return '<a href="' . $models->get_callback(%params) . '">' . _H($title) . $image . '</a>';
346 sub paginate_controls {
347 my ($self, %params) = _hashify(1, @_);
349 my $controller = $self->{CONTEXT}->stash->get('SELF');
350 my $models = $params{models} || $self->{CONTEXT}->stash->get('MODELS');
351 my $pager = $models->paginated;
352 # my $paginate_spec = $controller->get_paginate_spec;
354 my %paginate_params = $models->get_paginate_args;
356 my %template_params = (
357 pages => \%paginate_params,
359 my %url_params = _hashify(0, @_);
360 $url_params{ $pager->form_params->[0] } = delete $url_params{page};
361 $url_params{ $pager->form_params->[1] } = delete $url_params{per_page} if exists $url_params{per_page};
363 return $models->get_callback(%url_params);
368 return SL::Presenter->get->render('common/paginate', %template_params);
377 SL::Templates::Plugin::L -- Layouting / tag generation
381 Usage from a template:
385 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
387 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
388 { direction => 'right', display => 'To the right' } ],
389 value_key => 'direction', title_key => 'display', default => 'right')) %]
391 [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' },
392 { direction => 'right', display => 'To the right', selected => 1 } ],
393 value_key => 'direction', title_key => 'display')) %]
397 A module modeled a bit after Rails' ActionView helpers. Several small
398 functions that create HTML tags from various kinds of data sources.
400 The C<id> attribute is usually calculated automatically. This can be
401 overridden by either specifying an C<id> attribute or by setting
406 =head2 LOW-LEVEL FUNCTIONS
408 The following items are just forwarded to L<SL::Presenter::Tag>:
412 =item * C<name_to_id $name>
414 =item * C<stringify_attributes %items>
416 =item * C<html_tag $tag_name, $content_string, %attributes>
420 =head2 HIGH-LEVEL FUNCTIONS
422 The following functions are just forwarded to L<SL::Presenter::Tag>:
426 =item * C<input_tag $name, $value, %attributes>
428 =item * C<hidden_tag $name, $value, %attributes>
430 =item * C<checkbox_tag $name, %attributes>
432 =item * C<select_tag $name, \@collection, %attributes>
434 =item * C<link $href, $content, %attributes>
438 Available high-level functions implemented in this module:
442 =item C<yes_no_tag $name, $value, %attributes>
444 Creates a HTML 'select' tag with the two entries C<yes> and C<no> by
445 calling L<select_tag>. C<$value> determines
446 which entry is selected. The C<%attributes> are passed through to
449 =item C<textarea_tag $name, $value, %attributes>
451 Creates a HTML 'textarea' tag named C<$name> with the content
452 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
453 tag's C<id> defaults to C<name_to_id($name)>.
455 =item C<date_tag $name, $value, %attributes>
457 Creates a date input field, with an attached javascript that will open a
460 =item C<javascript_tag $file1, $file2, $file3...>
462 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
463 tag for each file name parameter passed. Each file name will be
464 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
465 doesn't contain a slash.
467 =item C<stylesheet_tag $file1, $file2, $file3...>
469 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
470 for each file name parameter passed. Each file name will be postfixed
471 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
474 =item C<tabbed \@tab, %attributes>
476 Will create a tabbed area. The tabs should be created with the helper function
480 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
481 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
484 =item C<areainput_tag $name, $content, %PARAMS>
486 Creates a generic input tag or textarea tag, depending on content size. The
487 amount of desired rows must be either given with the C<rows> parameter or can
488 be computed from the value and the C<cols> paramter, Accepted parameters
489 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
491 You can force input by setting rows to 1, and you can force textarea by setting
494 =item C<multiselect2side $id, %params>
496 Creates a JavaScript snippet calling the jQuery function
497 C<multiselect2side> on the select control with the ID C<$id>. The
498 select itself is not created. C<%params> can contain the following
505 The label of the list of available options. Defaults to the
506 translation of 'Available'.
510 The label of the list of selected options. Defaults to the
511 translation of 'Selected'.
515 =item C<sortable_element $selector, %params>
517 Makes the children of the DOM element C<$selector> (a jQuery selector)
518 sortable with the I<jQuery UI Selectable> library. The children can be
519 dragged & dropped around. After dropping an element an URL can be
520 postet to with the element IDs of the sorted children.
522 If this is used then the JavaScript file C<js/jquery-ui.js> must be
523 included manually as well as it isn't loaded via C<$::form-gt;header>.
525 C<%params> can contain the following entries:
531 The URL to POST an AJAX request to after a dragged element has been
532 dropped. The AJAX request's return value is ignored by default. If given then
533 C<$params{with}> must be given as well.
537 If trueish then the AJAX request's return is accepted.
541 A string that is interpreted as the prefix of the children's ID. Upon
542 POSTing the result each child whose ID starts with C<$params{with}> is
543 considered. The prefix and the following "_" is removed from the
544 ID. The remaining parts of the IDs of those children are posted as a
545 single array parameter. The array parameter's name is either
546 C<$params{as}> or, missing that, C<$params{with}>.
550 Sets the POST parameter name for AJAX request after dropping an
551 element (see C<$params{with}>).
555 An optional jQuery selector specifying which part of the child element
556 is dragable. If the parameter is not given then it defaults to
557 C<.dragdrop> matching DOM elements with the class C<dragdrop>. If the
558 parameter is set and empty then the whole child element is dragable,
559 and clicks through to underlying elements like inputs or links might
562 =item C<dont_recolor>
564 If trueish then the children will not be recolored. The default is to
565 recolor the children by setting the class C<listrow0> on odd and
566 C<listrow1> on even entries.
570 An optional JavaScript string that is evaluated before sending the
571 POST request. The result must be a string that is appended to the URL.
577 <script type="text/javascript" src="js/jquery-ui.js"></script>
579 <table id="thing_list">
581 <tr><td>This</td><td>That</td></tr>
584 <tr id="thingy_2"><td>stuff</td><td>more stuff</td></tr>
585 <tr id="thingy_15"><td>stuff</td><td>more stuff</td></tr>
586 <tr id="thingy_6"><td>stuff</td><td>more stuff</td></tr>
590 [% L.sortable_element('#thing_list tbody',
591 url => 'controller.pl?action=SystemThings/reorder',
594 recolor_rows => 1) %]
596 After dropping e.g. the third element at the top of the list a POST
597 request would be made to the C<reorder> action of the C<SystemThings>
598 controller with a single parameter called C<thing_ids> -- an array
599 containing the values C<[ 6, 2, 15 ]>.
603 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
605 =item C<sortable_table_header $by, %params>
607 Create a link and image suitable for placement in a table
608 header. C<$by> must be an index set up by the controller with
609 L<SL::Controller::Helper::make_sorted>.
611 The optional parameter C<$params{title}> can override the column title
612 displayed to the user. Otherwise the column title from the
613 controller's sort spec is used.
615 The other parameters in C<%params> are passed unmodified to the
616 underlying call to L<SL::Controller::Base::url_for>.
618 See the documentation of L<SL::Controller::Helper::Sorted> for an
619 overview and further usage instructions.
621 =item C<paginate_controls>
623 Create a set of links used to paginate a list view.
625 See the documentation of L<SL::Controller::Helper::Paginated> for an
626 overview and further usage instructions.
630 =head2 CONVERSION FUNCTIONS
634 =item C<tab, description, target, %PARAMS>
636 Creates a tab for C<tabbed>. The description will be used as displayed name.
637 The target should be a block or template that can be processed. C<tab> supports
638 a C<method> parameter, which can override the process method to apply target.
639 C<method => 'raw'> will just include the given text as is. I was too lazy to
640 implement C<include> properly.
642 Also an C<if> attribute is supported, so that tabs can be suppressed based on
643 some occasion. In this case the supplied block won't even get processed, and
644 the resulting tab will get ignored by C<tabbed>:
646 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
648 =item C<truncate $text, [%params]>
650 See L<SL::Presenter::Text/truncate>.
652 =item C<simple_format $text>
654 See L<SL::Presenter::Text/simple_format>.
658 =head1 MODULE AUTHORS
660 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
662 L<http://linet-services.de>