1 package SL::Template::Plugin::L;
3 use base qw( Template::Plugin );
5 use List::MoreUtils qw(apply);
6 use List::Util qw(max);
10 { # This will give you an id for identifying html tags and such.
11 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
12 # Do not use these id's to store information across requests.
13 my $_id_sequence = int rand 1e7;
15 return $_id_sequence = ($_id_sequence + 1) % 1e7;
21 return $::locale->quote_special_chars('HTML', $string);
25 my $string = "" . shift;
26 $string =~ s/\"/\\\"/g;
31 return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
35 my ($class, $context, @args) = @_;
43 die 'not an accessor' if @_ > 1;
44 return $_[0]->{CONTEXT};
51 $name =~ s/[^\w_]/_/g;
58 my ($self, @slurp) = @_;
59 my %options = _hashify(@slurp);
62 while (my ($name, $value) = each %options) {
64 next if $name eq 'disabled' && !$value;
65 $value = '' if !defined($value);
66 push @result, _H($name) . '="' . _H($value) . '"';
69 return @result ? ' ' . join(' ', @result) : '';
73 my ($self, $tag, $content, @slurp) = @_;
74 my $attributes = $self->attributes(@slurp);
76 return "<${tag}${attributes}/>" unless defined($content);
77 return "<${tag}${attributes}>${content}</${tag}>";
83 my $options_str = shift;
84 my %attributes = _hashify(@_);
86 $attributes{id} ||= $self->name_to_id($name);
87 $options_str = $self->options_for_select($options_str) if ref $options_str;
89 return $self->html_tag('select', $options_str, %attributes, name => $name);
93 my ($self, $name, $content, @slurp) = @_;
94 my %attributes = _hashify(@slurp);
96 $attributes{id} ||= $self->name_to_id($name);
97 $content = $content ? _H($content) : '';
99 return $self->html_tag('textarea', $content, %attributes, name => $name);
103 my ($self, $name, @slurp) = @_;
104 my %attributes = _hashify(@slurp);
106 $attributes{id} ||= $self->name_to_id($name);
107 $attributes{value} = 1 unless defined $attributes{value};
108 my $label = delete $attributes{label};
110 if ($attributes{checked}) {
111 $attributes{checked} = 'checked';
113 delete $attributes{checked};
116 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
117 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
122 sub radio_button_tag {
125 my %attributes = _hashify(@_);
127 $attributes{value} = 1 unless defined $attributes{value};
128 $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
129 my $label = delete $attributes{label};
131 if ($attributes{checked}) {
132 $attributes{checked} = 'checked';
134 delete $attributes{checked};
137 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
138 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
144 my ($self, $name, $value, @slurp) = @_;
145 my %attributes = _hashify(@slurp);
147 $attributes{id} ||= $self->name_to_id($name);
148 $attributes{type} ||= 'text';
150 return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
154 return shift->input_tag(@_, type => 'hidden');
158 my ($self, $content, @slurp) = @_;
159 return $self->html_tag('div', $content, @slurp);
163 my ($self, $content, @slurp) = @_;
164 return $self->html_tag('ul', $content, @slurp);
168 my ($self, $content, @slurp) = @_;
169 return $self->html_tag('li', $content, @slurp);
173 my ($self, $href, $content, @slurp) = @_;
174 my %params = _hashify(@slurp);
178 return $self->html_tag('a', $content, %params, href => $href);
182 my ($self, $name, $value, @slurp) = @_;
183 my %attributes = _hashify(@slurp);
185 $attributes{onclick} = "if (confirm('" . delete($attributes{confirm}) . "')) return true; else return false;" if $attributes{confirm};
187 return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
191 my ($self, $onclick, $value, @slurp) = @_;
192 my %attributes = _hashify(@slurp);
194 return $self->input_tag(undef, $value, %attributes, type => 'button', onclick => $onclick);
197 sub options_for_select {
199 my $collection = shift;
200 my %options = _hashify(@_);
202 my $value_key = $options{value} || 'id';
203 my $title_key = $options{title} || $value_key;
205 my $value_sub = $options{value_sub};
206 my $title_sub = $options{title_sub};
208 my $value_title_sub = $options{value_title_sub};
210 my %selected = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : $options{default} ? [ $options{default} ] : [] };
213 my ($element, $index, $key, $sub) = @_;
214 my $ref = ref $element;
215 return $sub ? $sub->($element)
217 : $ref eq 'ARRAY' ? $element->[$index]
218 : $ref eq 'HASH' ? $element->{$key}
223 push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
224 push @elements, map [
225 $value_title_sub ? $value_title_sub->($_) : (
226 $access->($_, 0, $value_key, $value_sub),
227 $access->($_, 1, $title_key, $title_sub),
229 ], @{ $collection } if $collection && ref $collection eq 'ARRAY';
232 foreach my $result (@elements) {
233 my %attributes = ( value => $result->[0] );
234 $attributes{selected} = 'selected' if $selected{ $result->[0] || '' };
236 $code .= $self->html_tag('option', _H($result->[1]), %attributes);
243 my ($self, $data) = @_;
244 return $self->html_tag('script', $data, type => 'text/javascript');
251 foreach my $file (@_) {
252 $file .= '.css' unless $file =~ m/\.css$/;
253 $file = "css/${file}" unless $file =~ m|/|;
255 $code .= qq|<link rel="stylesheet" href="${file}" type="text/css" media="screen" />|;
262 my ($self, $name, $value, @slurp) = @_;
263 my %params = _hashify(@slurp);
264 my $name_e = _H($name);
266 my $datefmt = apply {
270 } $::myconfig{"dateformat"};
272 $params{cal_align} ||= 'BR';
274 $self->input_tag($name, $value,
277 title => _H($::myconfig{dateformat}),
278 onBlur => 'check_right_date_format(this)',
280 ) . ((!$params{no_cal}) ?
281 $self->html_tag('img', undef,
282 src => 'image/calendar.png',
284 title => _H($::myconfig{dateformat}),
288 "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });"
296 foreach my $file (@_) {
297 $file .= '.js' unless $file =~ m/\.js$/;
298 $file = "js/${file}" unless $file =~ m|/|;
300 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
307 my ($self, $tabs, @slurp) = @_;
308 my %params = _hashify(@slurp);
309 my $id = $params{id} || 'tab_' . _tag_id();
311 $params{selected} *= 1;
313 die 'L.tabbed needs an arrayred of tabs for first argument'
314 unless ref $tabs eq 'ARRAY';
316 my (@header, @blocks);
317 for my $i (0..$#$tabs) {
318 my $tab = $tabs->[$i];
322 my $selected = $params{selected} == $i;
323 my $tab_id = "__tab_id_$i";
324 push @header, $self->li_tag(
325 $self->link('', $tab->{name}, rel => $tab_id),
326 ($selected ? (class => 'selected') : ())
328 push @blocks, $self->div_tag($tab->{data},
329 id => $tab_id, class => 'tabcontent');
332 return '' unless @header;
333 return $self->ul_tag(
334 join('', @header), id => $id, class => 'shadetabs'
337 join('', @blocks), class => 'tabcontentstyle'
340 qq|var $id = new ddtabcontent("$id");$id.setpersist(true);| .
341 qq|$id.setselectedClassTarget("link");$id.init();|
346 my ($self, $name, $src, @slurp) = @_;
347 my %params = _hashify(@slurp);
349 $params{method} ||= 'process';
351 return () if defined $params{if} && !$params{if};
354 if ($params{method} eq 'raw') {
356 } elsif ($params{method} eq 'process') {
357 $data = $self->_context->process($src, %{ $params{args} || {} });
359 die "unknown tag method '$params{method}'";
362 return () unless $data;
364 return +{ name => $name, data => $data };
368 my ($self, $name, $value, @slurp) = @_;
369 my %attributes = _hashify(@slurp);
371 my $rows = delete $attributes{rows} || 1;
372 my $min = delete $attributes{min_rows} || 1;
375 ? $self->textarea_tag($name, $value, %attributes, rows => max $rows, $min)
376 : $self->input_tag($name, $value, %attributes);
379 sub multiselect2side {
380 my ($self, $id, @slurp) = @_;
381 my %params = _hashify(@slurp);
383 $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
384 $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
385 $params{moveOptions} = 'false';
387 my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
389 <script type="text/javascript">
390 \$().ready(function() {
391 \$('#${id}').multiselect2side({ ${vars} });
401 require Data::Dumper;
402 return '<pre>' . Data::Dumper::Dumper(@_) . '</pre>';
411 SL::Templates::Plugin::L -- Layouting / tag generation
415 Usage from a template:
419 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
421 [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' },
422 { direction => 'right', display => 'To the right' } ],
423 value => 'direction', title => 'display', default => 'right')) %]
427 A module modeled a bit after Rails' ActionView helpers. Several small
428 functions that create HTML tags from various kinds of data sources.
432 =head2 LOW-LEVEL FUNCTIONS
436 =item C<name_to_id $name>
438 Converts a name to a HTML id by replacing various characters.
440 =item C<attributes %items>
442 Creates a string from all elements in C<%items> suitable for usage as
443 HTML tag attributes. Keys and values are HTML escaped even though keys
444 must not contain non-ASCII characters for browsers to accept them.
446 =item C<html_tag $tag_name, $content_string, %attributes>
448 Creates an opening and closing HTML tag for C<$tag_name> and puts
449 C<$content_string> between the two. If C<$content_string> is undefined
450 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
451 are key/value pairs added to the opening tag.
453 C<$content_string> is not HTML escaped.
457 =head2 HIGH-LEVEL FUNCTIONS
461 =item C<select_tag $name, $options_string, %attributes>
463 Creates a HTML 'select' tag named C<$name> with the contents
464 C<$options_string> and with arbitrary HTML attributes from
465 C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
467 The C<$options_string> is usually created by the
468 L</options_for_select> function. If C<$options_string> is an array
469 reference then it will be passed to L</options_for_select>
472 =item C<input_tag $name, $value, %attributes>
474 Creates a HTML 'input type=text' tag named C<$name> with the value
475 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
476 tag's C<id> defaults to C<name_to_id($name)>.
478 =item C<hidden_tag $name, $value, %attributes>
480 Creates a HTML 'input type=hidden' tag named C<$name> with the value
481 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
482 tag's C<id> defaults to C<name_to_id($name)>.
484 =item C<submit_tag $name, $value, %attributes>
486 Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
487 value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
488 tag's C<id> defaults to C<name_to_id($name)>.
490 If C<$attributes{confirm}> is set then a JavaScript popup dialog will
491 be added via the C<onclick> handler asking the question given with
492 C<$attributes{confirm}>. If request is only submitted if the user
493 clicks the dialog's ok/yes button.
495 =item C<textarea_tag $name, $value, %attributes>
497 Creates a HTML 'textarea' tag named C<$name> with the content
498 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
499 tag's C<id> defaults to C<name_to_id($name)>.
501 =item C<checkbox_tag $name, %attributes>
503 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
504 HTML attributes from C<%attributes>. The tag's C<id> defaults to
505 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
507 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
508 created with said C<label>. No attribute named C<label> is created in
511 =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
513 Creates a date input field, with an attached javascript that will open a
514 calendar on click. The javascript ist by default anchoered at the bottom right
515 sight. This can be overridden with C<cal_align>, see Calendar documentation for
516 the details, usually you'll want a two letter abbreviation of the alignment.
517 Right + Bottom becomes C<BL>.
519 =item C<radio_button_tag $name, %attributes>
521 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
522 HTML attributes from C<%attributes>. The tag's C<value> defaults to
523 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
525 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
526 created with said C<label>. No attribute named C<label> is created in
529 =item C<javascript_tag $file1, $file2, $file3...>
531 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
532 tag for each file name parameter passed. Each file name will be
533 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
534 doesn't contain a slash.
536 =item C<stylesheet_tag $file1, $file2, $file3...>
538 Creates a HTML 'E<lt>link rel="text/stylesheet" href="..."E<gt>' tag
539 for each file name parameter passed. Each file name will be postfixed
540 with '.css' if it isn't already and prefixed with 'css/' if it doesn't
543 =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
545 Creates a date input field, with an attached javascript that will open a
546 calendar on click. The javascript ist by default anchoered at the bottom right
547 sight. This can be overridden with C<cal_align>, see Calendar documentation for
548 the details, usually you'll want a two letter abbreviation of the alignment.
549 Right + Bottom becomes C<BL>.
551 =item C<tabbed \@tab, %attributes>
553 Will create a tabbed area. The tabs should be created with the helper function
557 L.tab(LxERP.t8('Basic Data'), 'part/_main_tab.html'),
558 L.tab(LxERP.t8('Custom Variables'), 'part/_cvar_tab.html', if => SELF.display_cvar_tab),
561 An optional attribute is C<selected>, which accepts the ordinal of a tab which
562 should be selected by default.
564 =item C<areainput_tag $name, $content, %PARAMS>
566 Creates a generic input tag or textarea tag, depending on content size. The
567 mount of desired rows must be given with C<rows> parameter, Accpeted parameters
568 include C<min_rows> for rendering a minimum of rows if a textarea is displayed.
570 You can force input by setting rows to 1, and you can force textarea by setting
573 =item C<multiselect2side $id, %params>
575 Creates a JavaScript snippet calling the jQuery function
576 C<multiselect2side> on the select control with the ID C<$id>. The
577 select itself is not created. C<%params> can contain the following
584 The label of the list of available options. Defaults to the
585 translation of 'Available'.
589 The label of the list of selected options. Defaults to the
590 translation of 'Selected'.
596 Dumps the Argument using L<Data::Dumper> into a E<lt>preE<gt> block.
600 =head2 CONVERSION FUNCTIONS
604 =item C<options_for_select \@collection, %options>
606 Creates a string suitable for a HTML 'select' tag consisting of one
607 'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
608 to use and the title to display are extracted from the elements in
609 C<\@collection>. Each element can be one of four things:
613 =item 1. An array reference with at least two elements. The first element is
614 the value, the second element is its title.
616 =item 2. A scalar. The scalar is both the value and the title.
618 =item 3. A hash reference. In this case C<%options> must contain
619 I<value> and I<title> keys that name the keys in the element to use
620 for the value and title respectively.
622 =item 4. A blessed reference. In this case C<%options> must contain
623 I<value> and I<title> keys that name functions called on the blessed
624 reference whose return values are used as the value and title
629 For cases 3 and 4 C<$options{value}> defaults to C<id> and
630 C<$options{title}> defaults to C<$options{value}>.
632 In addition to pure keys/method you can also provide coderefs as I<value_sub>
633 and/or I<title_sub>. If present, these take precedence over keys or methods,
634 and are called with the element as first argument. It must return the value or
637 Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes
638 precedence over each individual sub. It will only be called once for each
639 element and must return a list of value and title.
641 If the option C<with_empty> is set then an empty element (value
642 C<undef>) will be used as the first element. The title to display for
643 this element can be set with the option C<empty_title> and defaults to
646 The option C<default> can be either a scalar or an array reference
647 containing the values of the options which should be set to be
650 =item C<tab, description, target, %PARAMS>
652 Creates a tab for C<tabbed>. The description will be used as displayed name.
653 The target should be a block or template that can be processed. C<tab> supports
654 a C<method> parameter, which can override the process method to apply target.
655 C<method => 'raw'> will just include the given text as is. I was too lazy to
656 implement C<include> properly.
658 Also an C<if> attribute is supported, so that tabs can be suppressed based on
659 some occasion. In this case the supplied block won't even get processed, and
660 the resulting tab will get ignored by C<tabbed>:
662 L.tab('Awesome tab wih much info', '_much_info.html', if => SELF.wants_all)
666 =head1 MODULE AUTHORS
668 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
670 L<http://linet-services.de>