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 defined($content);
64 return "<${tag}${attributes}>${content}</${tag}>";
70 my $options_str = shift;
71 my %attributes = _hashify(@_);
73 $attributes{id} ||= $self->name_to_id($name);
74 $options_str = $self->options_for_select($options_str) if ref $options_str;
76 return $self->html_tag('select', $options_str, %attributes, name => $name);
83 my %attributes = _hashify(@_);
85 $attributes{id} ||= $self->name_to_id($name);
86 $content = $content ? '' : _H($content);
88 return $self->html_tag('textarea', $content, %attributes, name => $name);
94 my %attributes = _hashify(@_);
96 $attributes{id} ||= $self->name_to_id($name);
97 $attributes{value} = 1 unless defined $attributes{value};
98 my $label = delete $attributes{label};
100 if ($attributes{checked}) {
101 $attributes{checked} = 'checked';
103 delete $attributes{checked};
106 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
107 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
112 sub radio_button_tag {
115 my %attributes = _hashify(@_);
117 $attributes{value} = 1 unless defined $attributes{value};
118 $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
119 my $label = delete $attributes{label};
121 if ($attributes{checked}) {
122 $attributes{checked} = 'checked';
124 delete $attributes{checked};
127 my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
128 $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
137 my %attributes = _hashify(@_);
139 $attributes{id} ||= $self->name_to_id($name);
140 $attributes{type} ||= 'text';
142 return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
146 return shift->input_tag(@_, type => 'hidden');
150 return shift->input_tag(@_, type => 'submit', class => 'submit');
153 sub options_for_select {
155 my $collection = shift;
156 my %options = _hashify(@_);
158 my $value_key = $options{value} || 'id';
159 my $title_key = $options{title} || $value_key;
162 push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
164 if ($collection && (ref $collection eq 'ARRAY')) {
165 foreach my $element (@{ $collection }) {
166 my @result = !ref $element ? ( $element, $element )
167 : ref $element eq 'ARRAY' ? ( $element->[0], $element->[1] )
168 : ref $element eq 'HASH' ? ( $element->{$value_key}, $element->{$title_key} )
169 : ( $element->$value_key, $element->$title_key );
171 push @elements, \@result;
176 foreach my $result (@elements) {
177 my %attributes = ( value => $result->[0] );
178 $attributes{selected} = 'selected' if $options{default} && ($options{default} eq ($result->[0] || ''));
180 $code .= $self->html_tag('option', _H($result->[1]), %attributes);
187 my ($self, $data) = @_;
188 return $self->html_tag('script', $data, type => 'text/javascript');
192 my ($self, $name, $value, @slurp) = @_;
193 my %params = _hashify(@slurp);
194 my $name_e = _H($name);
197 $params{cal_align} ||= 'BR';
199 $self->input_tag($name, $value,
202 title => _H($::myconfig{dateformat}),
203 onBlur => 'check_right_date_format(this)',
205 ) . ((!$params{no_cal}) ?
206 $self->html_tag('img', undef,
207 src => 'image/calendar.png',
209 title => _H($::myconfig{dateformat}),
213 "Calendar.setup({ inputField: '$name_e', ifFormat: '$::myconfig{jsc_dateformat}', align: '$params{cal_align}', button: 'trigger$seq' });"
220 foreach my $file (@_) {
221 $file .= '.js' unless $file =~ m/\.js$/;
222 $file = "js/${file}" unless $file =~ m|/|;
224 $code .= qq|<script type="text/javascript" src="${file}"></script>|;
236 SL::Templates::Plugin::L -- Layouting / tag generation
240 Usage from a template:
244 [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %]
246 [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' },
247 { direction => 'right', display => 'To the right' } ],
248 value => 'direction', title => 'display', default => 'right')) %]
252 A module modeled a bit after Rails' ActionView helpers. Several small
253 functions that create HTML tags from various kinds of data sources.
257 =head2 LOW-LEVEL FUNCTIONS
261 =item C<name_to_id $name>
263 Converts a name to a HTML id by replacing various characters.
265 =item C<attributes %items>
267 Creates a string from all elements in C<%items> suitable for usage as
268 HTML tag attributes. Keys and values are HTML escaped even though keys
269 must not contain non-ASCII characters for browsers to accept them.
271 =item C<html_tag $tag_name, $content_string, %attributes>
273 Creates an opening and closing HTML tag for C<$tag_name> and puts
274 C<$content_string> between the two. If C<$content_string> is undefined
275 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
276 are key/value pairs added to the opening tag.
278 C<$content_string> is not HTML escaped.
282 =head2 HIGH-LEVEL FUNCTIONS
286 =item C<select_tag $name, $options_string, %attributes>
288 Creates a HTML 'select' tag named C<$name> with the contents
289 C<$options_string> and with arbitrary HTML attributes from
290 C<%attributes>. The tag's C<id> defaults to C<name_to_id($name)>.
292 The C<$options_string> is usually created by the
293 L</options_for_select> function. If C<$options_string> is an array
294 reference then it will be passed to L</options_for_select>
297 =item C<input_tag $name, $value, %attributes>
299 Creates a HTML 'input type=text' tag named C<$name> with the value
300 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
301 tag's C<id> defaults to C<name_to_id($name)>.
303 =item C<textarea_tag $name, $value, %attributes>
305 Creates a HTML 'textarea' tag named C<$name> with the content
306 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
307 tag's C<id> defaults to C<name_to_id($name)>.
309 =item C<checkbox_tag $name, %attributes>
311 Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
312 HTML attributes from C<%attributes>. The tag's C<id> defaults to
313 C<name_to_id($name)>. The tag's C<value> defaults to C<1>.
315 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
316 created with said C<label>. No attribute named C<label> is created in
319 =item C<date_tag $name, $value, cal_align =E<gt> $align_code, %attributes>
321 Creates a date input field, with an attached javascript that will open a
322 calendar on click. The javascript ist by default anchoered at the bottom right
323 sight. This can be overridden with C<cal_align>, see Calendar documentation for
324 the details, usually you'll want a two letter abbreviation of the alignment.
325 Right + Bottom becomes C<BL>.
327 =item C<radio_button_tag $name, %attributes>
329 Creates a HTML 'input type=radio' tag named C<$name> with arbitrary
330 HTML attributes from C<%attributes>. The tag's C<value> defaults to
331 C<1>. The tag's C<id> defaults to C<name_to_id($name . "_" . $value)>.
333 If C<%attributes> contains a key C<label> then a HTML 'label' tag is
334 created with said C<label>. No attribute named C<label> is created in
337 =item C<javascript_tag $file1, $file2, $file3...>
339 Creates a HTML 'E<lt>script type="text/javascript" src="..."E<gt>'
340 tag for each file name parameter passed. Each file name will be
341 postfixed with '.js' if it isn't already and prefixed with 'js/' if it
342 doesn't contain a slash.
346 =head2 CONVERSION FUNCTIONS
350 =item C<options_for_select \@collection, %options>
352 Creates a string suitable for a HTML 'select' tag consisting of one
353 'E<lt>optionE<gt>' tag for each element in C<\@collection>. The value
354 to use and the title to display are extracted from the elements in
355 C<\@collection>. Each element can be one of four things:
359 =item 1. An array reference with at least two elements. The first element is
360 the value, the second element is its title.
362 =item 2. A scalar. The scalar is both the value and the title.
364 =item 3. A hash reference. In this case C<%options> must contain
365 I<value> and I<title> keys that name the keys in the element to use
366 for the value and title respectively.
368 =item 4. A blessed reference. In this case C<%options> must contain
369 I<value> and I<title> keys that name functions called on the blessed
370 reference whose return values are used as the value and title
375 For cases 3 and 4 C<$options{value}> defaults to C<id> and
376 C<$options{title}> defaults to C<$options{value}>.
378 If the option C<with_empty> is set then an empty element (value
379 C<undef>) will be used as the first element. The title to display for
380 this element can be set with the option C<empty_title> and defaults to
385 =head1 MODULE AUTHORS
387 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
389 L<http://linet-services.de>