kivitendo/SL/Template/Plugin/L.pm @ c4e27e00
| 8177c150 | Moritz Bunkus | package SL::Template::Plugin::L;
|
||
use base qw( Template::Plugin );
|
||||
use Template::Plugin;
|
||||
| e3f1b7c3 | Sven Schöling | use List::MoreUtils qw(apply);
|
||
| 8177c150 | Moritz Bunkus | |||
use strict;
|
||||
| 22ae0bf0 | Sven Schöling | { # This will give you an id for identifying html tags and such.
|
||
# It's guaranteed to be unique unless you exceed 10 mio calls per request.
|
||||
# Do not use these id's to store information across requests.
|
||||
my $_id_sequence = int rand 1e7;
|
||||
sub _tag_id {
|
||||
return $_id_sequence = ($_id_sequence + 1) % 1e7;
|
||||
}
|
||||
}
|
||||
| 47978b5b | Moritz Bunkus | sub _H {
|
||
my $string = shift;
|
||||
return $::locale->quote_special_chars('HTML', $string);
|
||||
}
|
||||
| 3cc77e53 | Moritz Bunkus | sub _hashify {
|
||
return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
|
||||
}
|
||||
| 8177c150 | Moritz Bunkus | sub new {
|
||
my $class = shift;
|
||||
my $context = shift;
|
||||
return bless { }, $class;
|
||||
}
|
||||
| 71f55f78 | Moritz Bunkus | sub name_to_id {
|
||
my $self = shift;
|
||||
my $name = shift;
|
||||
$name =~ s/[^\w_]/_/g;
|
||||
$name =~ s/_+/_/g;
|
||||
return $name;
|
||||
}
|
||||
| 8177c150 | Moritz Bunkus | sub attributes {
|
||
my $self = shift;
|
||||
| 3cc77e53 | Moritz Bunkus | my %options = _hashify(@_);
|
||
| 8177c150 | Moritz Bunkus | |||
my @result = ();
|
||||
| 3cc77e53 | Moritz Bunkus | while (my ($name, $value) = each %options) {
|
||
| 8177c150 | Moritz Bunkus | next unless $name;
|
||
| c4e27e00 | Moritz Bunkus | $value = '' if !defined($value);
|
||
| 47978b5b | Moritz Bunkus | push @result, _H($name) . '="' . _H($value) . '"';
|
||
| 8177c150 | Moritz Bunkus | }
|
||
return @result ? ' ' . join(' ', @result) : '';
|
||||
}
|
||||
sub html_tag {
|
||||
my $self = shift;
|
||||
my $tag = shift;
|
||||
my $content = shift;
|
||||
| 3cc77e53 | Moritz Bunkus | my $attributes = $self->attributes(@_);
|
||
| 8177c150 | Moritz Bunkus | |||
| 11e4b8f3 | Moritz Bunkus | return "<${tag}${attributes}/>" unless defined($content);
|
||
| 8177c150 | Moritz Bunkus | return "<${tag}${attributes}>${content}</${tag}>";
|
||
}
|
||||
sub select_tag {
|
||||
| 3cc77e53 | Moritz Bunkus | my $self = shift;
|
||
my $name = shift;
|
||||
my $options_str = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{id} ||= $self->name_to_id($name);
|
||||
| 368f9611 | Moritz Bunkus | $options_str = $self->options_for_select($options_str) if ref $options_str;
|
||
| 3cc77e53 | Moritz Bunkus | |||
return $self->html_tag('select', $options_str, %attributes, name => $name);
|
||||
}
|
||||
| 11e4b8f3 | Moritz Bunkus | sub textarea_tag {
|
||
my $self = shift;
|
||||
my $name = shift;
|
||||
my $content = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{id} ||= $self->name_to_id($name);
|
||||
| 1a8f5fe0 | Moritz Bunkus | $content = $content ? _H($content) : '';
|
||
| 11e4b8f3 | Moritz Bunkus | |||
return $self->html_tag('textarea', $content, %attributes, name => $name);
|
||||
}
|
||||
| 3cc77e53 | Moritz Bunkus | sub checkbox_tag {
|
||
my $self = shift;
|
||||
my $name = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{id} ||= $self->name_to_id($name);
|
||||
$attributes{value} = 1 unless defined $attributes{value};
|
||||
my $label = delete $attributes{label};
|
||||
if ($attributes{checked}) {
|
||||
$attributes{checked} = 'checked';
|
||||
} else {
|
||||
delete $attributes{checked};
|
||||
}
|
||||
| 8177c150 | Moritz Bunkus | |||
| 3cc77e53 | Moritz Bunkus | my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
|
||
$code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
|
||||
| 8177c150 | Moritz Bunkus | |||
| 3cc77e53 | Moritz Bunkus | return $code;
|
||
}
|
||||
| 11e4b8f3 | Moritz Bunkus | sub radio_button_tag {
|
||
my $self = shift;
|
||||
my $name = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{value} = 1 unless defined $attributes{value};
|
||||
$attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
|
||||
my $label = delete $attributes{label};
|
||||
if ($attributes{checked}) {
|
||||
$attributes{checked} = 'checked';
|
||||
} else {
|
||||
delete $attributes{checked};
|
||||
}
|
||||
my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
|
||||
$code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
|
||||
return $code;
|
||||
}
|
||||
| 3cc77e53 | Moritz Bunkus | sub input_tag {
|
||
my $self = shift;
|
||||
my $name = shift;
|
||||
my $value = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{id} ||= $self->name_to_id($name);
|
||||
$attributes{type} ||= 'text';
|
||||
return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
|
||||
| 8177c150 | Moritz Bunkus | }
|
||
| 9f75fa25 | Sven Schöling | sub hidden_tag {
|
||
return shift->input_tag(@_, type => 'hidden');
|
||||
}
|
||||
sub submit_tag {
|
||||
| a30ad33e | Moritz Bunkus | my $self = shift;
|
||
my $name = shift;
|
||||
my $value = shift;
|
||||
my %attributes = _hashify(@_);
|
||||
$attributes{onclick} = "if (confirm('" . delete($attributes{confirm}) . "')) return true; else return false;" if $attributes{confirm};
|
||||
return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
|
||||
| 9f75fa25 | Sven Schöling | }
|
||
| 8177c150 | Moritz Bunkus | sub options_for_select {
|
||
| 93bae7aa | Sven Schöling | my $self = shift;
|
||
my $collection = shift;
|
||||
my %options = _hashify(@_);
|
||||
| 8177c150 | Moritz Bunkus | |||
| 93bae7aa | Sven Schöling | my $value_key = $options{value} || 'id';
|
||
my $title_key = $options{title} || $value_key;
|
||||
| 8177c150 | Moritz Bunkus | |||
| 93bae7aa | Sven Schöling | my $value_sub = $options{value_sub};
|
||
my $title_sub = $options{title_sub};
|
||||
| ee61dd2b | Moritz Bunkus | |||
| 93bae7aa | Sven Schöling | my $value_title_sub = $options{value_title_sub};
|
||
| 8177c150 | Moritz Bunkus | |||
| 93bae7aa | Sven Schöling | my $access = sub {
|
||
my ($element, $index, $key, $sub) = @_;
|
||||
my $ref = ref $element;
|
||||
return $sub ? $sub->($element)
|
||||
: !$ref ? $element
|
||||
: $ref eq 'ARRAY' ? $element->[$index]
|
||||
: $ref eq 'HASH' ? $element->{$key}
|
||||
: $element->$key;
|
||||
};
|
||||
my @elements = ();
|
||||
push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
|
||||
push @elements, map [
|
||||
$value_title_sub ? $value_title_sub->($_) : (
|
||||
$access->($_, 0, $value_key, $value_sub),
|
||||
$access->($_, 1, $title_key, $title_sub),
|
||||
)
|
||||
], @{ $collection } if $collection && ref $collection eq 'ARRAY';
|
||||
| 8177c150 | Moritz Bunkus | |||
| ee61dd2b | Moritz Bunkus | my $code = '';
|
||
foreach my $result (@elements) {
|
||||
my %attributes = ( value => $result->[0] );
|
||||
$attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || ''));
|
||||
$code .= $self->html_tag('option', _H($result->[1]), %attributes);
|
||||
}
|
||||
return $code;
|
||||
| 8177c150 | Moritz Bunkus | }
|
||
| 22ae0bf0 | Sven Schöling | sub javascript {
|
||
my ($self, $data) = @_;
|
||||
return $self->html_tag('script', $data, type => 'text/javascript');
|
||||
}
|
||||
sub date_tag {
|
||||
my ($self, $name, $value, @slurp) = @_;
|
||||
my %params = _hashify(@slurp);
|
||||
my $name_e = _H($name);
|
||||
my $seq = _tag_id();
|
||||
| e3f1b7c3 | Sven Schöling | my $datefmt = apply {
|
||
s/d+/\%d/gi;
|
||||
s/m+/\%m/gi;
|
||||
s/y+/\%Y/gi;
|
||||
} $::myconfig{"dateformat"};
|
||||
| 22ae0bf0 | Sven Schöling | |||
$params{cal_align} ||= 'BR';
|
||||
$self->input_tag($name, $value,
|
||||
| 094aaf62 | Sven Schöling | id => $name_e,
|
||
| 22ae0bf0 | Sven Schöling | size => 11,
|
||
title => _H($::myconfig{dateformat}),
|
||||
onBlur => 'check_right_date_format(this)',
|
||||
%params,
|
||||
) . ((!$params{no_cal}) ?
|
||||
$self->html_tag('img', undef,
|
||||
src => 'image/calendar.png',
|
||||
id => "trigger$seq",
|
||||
title => _H($::myconfig{dateformat}),
|
||||
%params,
|
||||
) .
|
||||
$self->javascript(
|
||||
| e3f1b7c3 | Sven Schöling | "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$params{cal_align}', button: 'trigger$seq' });"
|
||
| 22ae0bf0 | Sven Schöling | ) : '');
|
||
| 62ba378c | Moritz Bunkus | |||
sub javascript_tag {
|
||||
my $self = shift;
|
||||
my $code = '';
|
||||
foreach my $file (@_) {
|
||||
$file .= '.js' unless $file =~ m/\.js$/;
|
||||
$file = "js/${file}" unless $file =~ m|/|;
|
||||
$code .= qq|<script type="text/javascript" src="${file}"></script>|;
|
||||
}
|
||||
return $code;
|
||||
| 22ae0bf0 | Sven Schöling | }
|
||
| 8177c150 | Moritz Bunkus | 1;
|
||
__END__
|
||||
=head1 NAME
|
||||
SL::Templates::Plugin::L -- Layouting / tag generation
|
||||
=head1 SYNOPSIS
|
||||
Usage from a template:
|
||||
[% USE L %]
|
||||
[% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
|
||||
[% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' },
|
||||
{ direction => 'right', display => 'To the right' } ],
|
||||
value => 'direction', title => 'display', default => 'right')) %]
|
||||
=head1 DESCRIPTION
|
||||
A module modeled a bit after Rails' ActionView helpers. Several small
|
||||
functions that create HTML tags from various kinds of data sources.
|
||||
=head1 FUNCTIONS
|
||||
| 71f55f78 | Moritz Bunkus | =head2 LOW-LEVEL FUNCTIONS
|
||
| 8177c150 | Moritz Bunkus | =over 4
|
||
| 71f55f78 | Moritz Bunkus | =item C<name_to_id $name>
|
||
Converts a name to a HTML id by replacing various characters.
|
||||
| 3cc77e53 | Moritz Bunkus | =item C<attributes %items>
|
||
| 8177c150 | Moritz Bunkus | |||
| 3cc77e53 | Moritz Bunkus | Creates a string from all elements in C<%items> suitable for usage as
|
||
| 8177c150 | Moritz Bunkus | HTML tag attributes. Keys and values are HTML escaped even though keys
|
||
must not contain non-ASCII characters for browsers to accept them.
|
||||
| 3cc77e53 | Moritz Bunkus | =item C<html_tag $tag_name, $content_string, %attributes>
|
||
| 8177c150 | Moritz Bunkus | |||
Creates an opening and closing HTML tag for C<$tag_name> and puts
|
||||
C<$content_string> between the two. If C<$content_string> is undefined
|
||||
or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
|
||||
are key/value pairs added to the opening tag.
|
||||
| 71f55f78 | Moritz Bunkus | C<$content_string> is not HTML escaped.
|
||
=back
|
||||
=head2 HIGH-LEVEL FUNCTIONS
|
||||
=over 4
|
||||
| 3cc77e53 | Moritz Bunkus | =item C<select_tag $name, $options_string, %attributes>
|
||
| 71f55f78 | Moritz Bunkus | |||
| 3cc77e53 | Moritz Bunkus | Creates a HTML 'select' tag named C<$name> with the contents
|
||
C<$options_string> and with arbitrary HTML attributes from
|
||||
C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
|
||||
| 71f55f78 | Moritz Bunkus | |||
| 368f9611 | Moritz Bunkus | The C<$options_string> is usually created by the
|
||
L</options_for_select> function. If C<$options_string> is an array
|
||||
reference then it will be passed to L</options_for_select>
|
||||
automatically.
|
||||
| 71f55f78 | Moritz Bunkus | |||
| 3cc77e53 | Moritz Bunkus | =item C<input_tag $name, $value, %attributes>
|
||
Creates a HTML 'input type=text' tag named C<$name> with the value
|
||||
C<$value> and with arbitrary HTML attributes from C<%attributes>. The
|
||||
tag's C<id> defaults to C<name_to_id($name)>.
|
||||
| 93bae7aa | Sven Schöling | =item C<hidden_tag $name, $value, %attributes>
|
||
Creates a HTML 'input type=hidden' tag named C<$name> with the value
|
||||
C<$value> and with arbitrary HTML attributes from C<%attributes>. The
|
||||
tag's C<id> defaults to C<name_to_id($name)>.
|
||||
=item C<submit_tag $name, $value, %attributes>
|
||||
Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
|
||||
value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
|
||||
tag's C<id> defaults to C<name_to_id($name)>.
|
||||
| a30ad33e | Moritz Bunkus | If C<$attributes{confirm}> is set then a JavaScript popup dialog will
|
||
be added via the C<onclick> handler asking the question given with
|
||||
C<$attributes{confirm}>. If request is only submitted if the user
|
||||
clicks the dialog's ok/yes button.
|
||||
| 11e4b8f3 | Moritz Bunkus | =item C<textarea_tag $name, $value, %attributes>
|
||
Creates a HTML 'textarea' tag named C<$name> with the content
|
||||
C<$value> and with arbitrary HTML attributes from C<%attributes>. The
|
||||
tag's C<id> defaults to C<name_to_id($name)>.
|
||||
| 3cc77e53 | Moritz Bunkus | =item C<checkbox_tag $name, %attributes>
|
||
Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
|
||||
HTML attributes from C<%attributes>. The tag's C<id> defaults to
|
||||
C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
|
||||
If C<%attributes> contains a key C<label> then a HTML 'label' tag is
|
||||
created with said C<label>. No attribute named C<label> is created in
|
||||
that case.
|
||||
| 22ae0bf0 | Sven Schöling | =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
|
||
Creates a date input field, with an attached javascript that will open a
|
||||
calendar on click. The javascript ist by default anchoered at the bottom right
|
||||
sight. This can be overridden with C<cal_align>, see Calendar documentation for
|
||||
the details, usually you'll want a two letter abbreviation of the alignment.
|
||||
Right + Bottom becomes C<BL>.
|
||||
| 11e4b8f3 | Moritz Bunkus | =item C<radio_button_tag $name, %attributes>
|
||
Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
|
||||
HTML attributes from C<%attributes>. The tag's C<value> defaults to
|
||||
C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
|
||||
If C<%attributes> contains a key C<label> then a HTML 'label' tag is
|
||||
created with said C<label>. No attribute named C<label> is created in
|
||||
that case.
|
||||
| 62ba378c | Moritz Bunkus | =item C<javascript_tag $file1, $file2, $file3...>
|
||
Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
|
||||
tag for each file name parameter passed. Each file name will be
|
||||
postfixed with '.js' if it isn't already and prefixed with 'js/' if it
|
||||
doesn't contain a slash.
|
||||
| 71f55f78 | Moritz Bunkus | =back
|
||
=head2 CONVERSION FUNCTIONS
|
||||
=over 4
|
||||
| 3cc77e53 | Moritz Bunkus | =item C<options_for_select \@collection, %options>
|
||
| 8177c150 | Moritz Bunkus | |||
Creates a string suitable for a HTML 'select' tag consisting of one
|
||||
'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
|
||||
to use and the title to display are extracted from the elements in
|
||||
C<\@collection>. Each element can be one of four things:
|
||||
=over 12
|
||||
=item 1. An array reference with at least two elements. The first element is
|
||||
the value, the second element is its title.
|
||||
=item 2. A scalar. The scalar is both the value and the title.
|
||||
| 3cc77e53 | Moritz Bunkus | =item 3. A hash reference. In this case C<%options> must contain
|
||
| 8177c150 | Moritz Bunkus | I<value> and I<title> keys that name the keys in the element to use
|
||
for the value and title respectively.
|
||||
| 3cc77e53 | Moritz Bunkus | =item 4. A blessed reference. In this case C<%options> must contain
|
||
| 8177c150 | Moritz Bunkus | I<value> and I<title> keys that name functions called on the blessed
|
||
reference whose return values are used as the value and title
|
||||
respectively.
|
||||
=back
|
||||
For cases 3 and 4 C<$options{value}> defaults to C<id> and
|
||||
C<$options{title}> defaults to C<$options{value}>.
|
||||
| 93bae7aa | Sven Schöling | In addition to pure keys/method you can also provide coderefs as I<value_sub>
|
||
and/or I<title_sub>. If present, these take precedence over keys or methods,
|
||||
and are called with the element as first argument. It must return the value or
|
||||
title.
|
||||
Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes
|
||||
precedence over each individual sub. It will only be called once for each
|
||||
element and must return a list of value and title.
|
||||
| ee61dd2b | Moritz Bunkus | If the option C<with_empty> is set then an empty element (value
|
||
C<undef>) will be used as the first element. The title to display for
|
||||
this element can be set with the option C<empty_title> and defaults to
|
||||
an empty string.
|
||||
| 8177c150 | Moritz Bunkus | =back
|
||
=head1 MODULE AUTHORS
|
||||
Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
|
||||
L<http://linet-services.de>
|