1 package SL::Template::Plugin::L;
3 use base qw( Template::Plugin );
8 { # This will give you an id for identifying html tags and such.
9 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
10 # Do not use these id's to store information across requests.
11 my $_id_sequence = int rand 1e7;
13 return $_id_sequence = ($_id_sequence + 1) % 1e7;
19 return $::locale->quote_special_chars('HTML', $string);
23 return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
30 return bless { }, $class;
37 $name =~ s/[^\w_]/_/g;
45 my %options = _hashify(@_);
48 while (my ($name, $value) = each %options) {
51 push @result, _H($name) . '="' . _H($value) . '"';
54 return @result ? ' ' . join(' ', @result) : '';
61 my $attributes = $self->attributes(@_);
63 return "<${tag}${attributes}/>" unless $content;
64 return "<${tag}${attributes}>${content}</${tag}>";
70 my $options_str = shift;
71 my %attributes = _hashify(@_);
73 $attributes{id} ||= $self->name_to_id($name);
75 return $self->html_tag('select', $options_str, %attributes, name => $name);
81 my %attributes = _hashify(@_);
83 $attributes{id} ||= $self->name_to_id($name);
84 $attributes{value} = 1 unless defined $attributes{value};
85 my $label = delete $attributes{label};
87 if ($attributes{checked}) {
88 $attributes{checked} = 'checked';
90 delete $attributes{checked};
93 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
94 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
103 my %attributes = _hashify(@_);
105 $attributes{id} ||= $self->name_to_id($name);
106 $attributes{type} ||= 'text';
108 return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
111 sub options_for_select {
113 my $collection = shift;
114 my %options = _hashify(@_);
116 my $value_key = $options{value} || 'id';
117 my $title_key = $options{title} || $value_key;
120 push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
122 if ($collection && (ref $collection eq 'ARRAY')) {
123 foreach my $element (@{ $collection }) {
124 my @result = !ref $element ? ( $element, $element )
125 : ref $element eq 'ARRAY' ? ( $element->[0], $element->[1] )
126 : ref $element eq 'HASH' ? ( $element->{$value_key}, $element->{$title_key} )
127 : ( $element->$value_key, $element->$title_key );
129 push @elements, \@result;
134 foreach my $result (@elements) {
135 my %attributes = ( value => $result->[0] );
136 $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || ''));
138 $code .= $self->html_tag('option', _H($result->[1]), %attributes);
145 my ($self, $data) = @_;
146 return $self->html_tag('script', $data, type => 'text/javascript');
150 my ($self, $name, $value, @slurp) = @_;
151 my %params = _hashify(@slurp);
152 my $name_e = _H($name);
155 $params{cal_align} ||= 'BR';
157 $self->input_tag($name, $value,
159 title => _H($::myconfig{dateformat}),
160 onBlur => 'check_right_date_format(this)',
162 ) . ((!$params{no_cal}) ?
163 $self->html_tag('img', undef,
164 src => 'image/calendar.png',
166 title => _H($::myconfig{dateformat}),
170 "Calendar.setup({ inputField: '$name_e', ifFormat: '$::myconfig{jsc_dateformat}', align: '$params{cal_align}', button: 'trigger$seq' });"
180 SL::Templates::Plugin::L -- Layouting / tag generation
184 Usage from a template:
188 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
190 [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' },
191 { direction => 'right', display => 'To the right' } ],
192 value => 'direction', title => 'display', default => 'right')) %]
196 A module modeled a bit after Rails' ActionView helpers. Several small
197 functions that create HTML tags from various kinds of data sources.
201 =head2 LOW-LEVEL FUNCTIONS
205 =item C<name_to_id $name>
207 Converts a name to a HTML id by replacing various characters.
209 =item C<attributes %items>
211 Creates a string from all elements in C<%items> suitable for usage as
212 HTML tag attributes. Keys and values are HTML escaped even though keys
213 must not contain non-ASCII characters for browsers to accept them.
215 =item C<html_tag $tag_name, $content_string, %attributes>
217 Creates an opening and closing HTML tag for C<$tag_name> and puts
218 C<$content_string> between the two. If C<$content_string> is undefined
219 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
220 are key/value pairs added to the opening tag.
222 C<$content_string> is not HTML escaped.
226 =head2 HIGH-LEVEL FUNCTIONS
230 =item C<select_tag $name, $options_string, %attributes>
232 Creates a HTML 'select' tag named C<$name> with the contents
233 C<$options_string> and with arbitrary HTML attributes from
234 C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
236 The $options_string is usually created by the C<options_for_select>
239 =item C<input_tag $name, $value, %attributes>
241 Creates a HTML 'input type=text' tag named C<$name> with the value
242 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
243 tag's C<id> defaults to C<name_to_id($name)>.
245 =item C<checkbox_tag $name, %attributes>
247 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
248 HTML attributes from C<%attributes>. The tag's C<id> defaults to
249 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
251 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
252 created with said C<label>. No attribute named C<label> is created in
255 =item C<date_tag $name, $value, %attributes>
257 =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
259 Creates a date input field, with an attached javascript that will open a
260 calendar on click. The javascript ist by default anchoered at the bottom right
261 sight. This can be overridden with C<cal_align>, see Calendar documentation for
262 the details, usually you'll want a two letter abbreviation of the alignment.
263 Right + Bottom becomes C<BL>.
267 =head2 CONVERSION FUNCTIONS
271 =item C<options_for_select \@collection, %options>
273 Creates a string suitable for a HTML 'select' tag consisting of one
274 'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
275 to use and the title to display are extracted from the elements in
276 C<\@collection>. Each element can be one of four things:
280 =item 1. An array reference with at least two elements. The first element is
281 the value, the second element is its title.
283 =item 2. A scalar. The scalar is both the value and the title.
285 =item 3. A hash reference. In this case C<%options> must contain
286 I<value> and I<title> keys that name the keys in the element to use
287 for the value and title respectively.
289 =item 4. A blessed reference. In this case C<%options> must contain
290 I<value> and I<title> keys that name functions called on the blessed
291 reference whose return values are used as the value and title
296 For cases 3 and 4 C<$options{value}> defaults to C<id> and
297 C<$options{title}> defaults to C<$options{value}>.
299 If the option C<with_empty> is set then an empty element (value
300 C<undef>) will be used as the first element. The title to display for
301 this element can be set with the option C<empty_title> and defaults to
306 =head1 MODULE AUTHORS
308 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
310 L<http://linet-services.de>