1 package SL::Presenter::Tag;
5 use SL::HTML::Restrict;
7 use parent qw(Exporter);
9 use Exporter qw(import);
10 our @EXPORT = qw(html_tag input_tag man_days_tag name_to_id select_tag stringify_attributes restricted_html);
14 my %_valueless_attributes = map { $_ => 1 } qw(
15 checked compact declare defer disabled ismap multiple noresize noshade nowrap
20 my ($object, $method, @params) = @_;
21 return $object->$method(@params);
24 { # This will give you an id for identifying html tags and such.
25 # It's guaranteed to be unique unless you exceed 10 mio calls per request.
26 # Do not use these id's to store information across requests.
27 my $_id_sequence = int rand 1e7;
29 return ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
34 sub stringify_attributes {
35 my ($self, %params) = @_;
38 while (my ($name, $value) = each %params) {
40 next if $_valueless_attributes{$name} && !$value;
41 $value = '' if !defined($value);
42 push @result, $_valueless_attributes{$name} ? $self->escape($name) : $self->escape($name) . '="' . $self->escape($value) . '"';
45 return @result ? ' ' . join(' ', @result) : '';
49 my ($self, $tag, $content, %params) = @_;
50 my $attributes = $self->stringify_attributes(%params);
52 return "<${tag}${attributes}>" unless defined($content);
53 return "<${tag}${attributes}>${content}</${tag}>";
57 my ($self, $name, $value, %attributes) = @_;
59 _set_id_attribute(\%attributes, $name);
60 $attributes{type} ||= 'text';
62 return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
66 my ($self, $name, $object, %attributes) = @_;
68 my $size = delete($attributes{size}) || 5;
72 my $time_selection = $self->input_tag( "${name}_as_man_days_string", _call_on($object, "${method}_as_man_days_string"), %attributes, size => $size);
73 my $unit_selection = $self->select_tag("${name}_as_man_days_unit", [[ 'h', $::locale->text('h') ], [ 'man_day', $::locale->text('MD') ]],
74 %attributes, default => _call_on($object, "${method}_as_man_days_unit"));
76 return $time_selection . $unit_selection;
80 my ($self, $name) = @_;
82 $name =~ s/\[\+?\]/ _id() /ge; # give constructs with [] or [+] unique ids
83 $name =~ s/[^\w_]/_/g;
90 my ($self, $name, $collection, %attributes) = @_;
92 _set_id_attribute(\%attributes, $name);
94 my $value_key = delete($attributes{value_key}) || 'id';
95 my $title_key = delete($attributes{title_key}) || $value_key;
96 my $default_key = delete($attributes{default_key}) || 'selected';
97 my $default_val_key = delete($attributes{default_value_key});
98 my $default_coll = delete($attributes{default});
100 my $value_title_sub = delete($attributes{value_title_sub});
102 my $value_sub = delete($attributes{value_sub});
103 my $title_sub = delete($attributes{title_sub});
104 my $default_sub = delete($attributes{default_sub});
106 my $with_empty = delete($attributes{with_empty});
107 my $empty_title = delete($attributes{empty_title});
109 my $with_optgroups = delete($attributes{with_optgroups});
111 undef $default_key if $default_sub || $default_val_key;
113 my $normalize_entry = sub {
114 my ($type, $entry, $sub, $key) = @_;
116 return $sub->($entry) if $sub;
118 my $ref = ref($entry);
121 return $entry if $type eq 'value' || $type eq 'title';
125 if ( $ref eq 'ARRAY' ) {
126 return $entry->[ $type eq 'value' ? 0 : $type eq 'title' ? 1 : 2 ];
129 return $entry->{$key} if $ref eq 'HASH';
130 return $entry->$key if $type ne 'default' || $entry->can($key);
135 if (defined($default_coll) && !ref $default_coll) {
136 %selected = ($default_coll => 1);
138 } elsif (ref($default_coll) eq 'HASH') {
139 %selected = %{ $default_coll };
141 } elsif ($default_coll) {
142 $default_coll = [ $default_coll ] unless 'ARRAY' eq ref $default_coll;
144 %selected = $default_val_key ? map({ ($normalize_entry->('value', $_, undef, $default_val_key) => 1) } @{ $default_coll })
145 : map({ ($_ => 1) } @{ $default_coll });
148 my $list_to_code = sub {
149 my ($sub_collection) = @_;
151 if ('ARRAY' ne ref $sub_collection) {
152 $sub_collection = [ $sub_collection ];
156 foreach my $entry ( @{ $sub_collection } ) {
160 if ( $value_title_sub ) {
161 ($value, $title) = @{ $value_title_sub->($entry) };
164 $value = $normalize_entry->('value', $entry, $value_sub, $value_key);
165 $title = $normalize_entry->('title', $entry, $title_sub, $title_key);
168 my $default = $default_key ? $normalize_entry->('default', $entry, $default_sub, $default_key) : 0;
170 push(@options, [$value, $title, $selected{$value} || $default]);
173 return join '', map { $self->html_tag('option', $self->escape($_->[1]), value => $_->[0], selected => $_->[2]) } @options;
177 $code .= $self->html_tag('option', $self->escape($empty_title || ''), value => '') if $with_empty;
179 if (!$with_optgroups) {
180 $code .= $list_to_code->($collection);
183 $code .= join '', map {
184 my ($optgroup_title, $sub_collection) = @{ $_ };
185 $self->html_tag('optgroup', $list_to_code->($sub_collection), label => $optgroup_title)
189 return $self->html_tag('select', $code, %attributes, name => $name);
192 sub _set_id_attribute {
193 my ($attributes, $name, $unique) = @_;
195 if (!delete($attributes->{no_id}) && !$attributes->{id}) {
196 $attributes->{id} = name_to_id(undef, $name);
197 $attributes->{id} .= '_' . $attributes->{value} if $unique;
200 return %{ $attributes };
205 sub restricted_html {
206 my ($self, $value) = @_;
208 $html_restricter ||= SL::HTML::Restrict->create;
209 return $html_restricter->process($value);
221 SL::Presenter::Tag - Layouting / tag generation
229 [% P.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %]
231 [% P.select_tag('direction', [ { direction => 'left', display => 'To the left' },
232 { direction => 'right', display => 'To the right' } ],
233 value_key => 'direction', title_key => 'display', default => 'right') %]
235 [% P.select_tag('direction', [ { direction => 'left', display => 'To the left' },
236 { direction => 'right', display => 'To the right', selected => 1 } ],
237 value_key => 'direction', title_key => 'display') %]
239 # Use an RDBO object and its n:m relationship as the default
240 # values. For example, a user can be a member of many groups. "All
241 # groups" is therefore the full collection and "$user->groups" is a
242 # list of RDBO AuthGroup objects whose IDs must match the ones in
243 # "All groups". This could look like the following:
244 [% P.select_tag('user.groups[]', SELF.all_groups, multiple=1,
245 default=SELF.user.groups, default_value_key='id' ) %]
249 A module modeled a bit after Rails' ActionView helpers. Several small
250 functions that create HTML tags from various kinds of data sources.
252 The C<id> attribute is usually calculated automatically. This can be
253 overridden by either specifying an C<id> attribute or by setting
258 =head2 LOW-LEVEL FUNCTIONS
262 =item C<html_tag $tag_name, $content_string, %attributes>
264 Creates an opening and closing HTML tag for C<$tag_name> and puts
265 C<$content_string> between the two. If C<$content_string> is undefined
266 or empty then only a E<lt>tag/E<gt> tag will be created. Attributes
267 are key/value pairs added to the opening tag.
269 C<$content_string> is not HTML escaped.
271 =item C<name_to_id $name>
273 Converts a name to a HTML id by replacing various characters.
275 =item C<stringify_attributes %items>
277 Creates a string from all elements in C<%items> suitable for usage as
278 HTML tag attributes. Keys and values are HTML escaped even though keys
279 must not contain non-ASCII characters for browsers to accept them.
281 =item C<restricted_html $html>
283 Returns HTML stripped of unknown tags. See L<SL::HTML::Restrict>.
287 =head2 HIGH-LEVEL FUNCTIONS
291 =item C<input_tag $name, $value, %attributes>
293 Creates a HTML 'input type=text' tag named C<$name> with the value
294 C<$value> and with arbitrary HTML attributes from C<%attributes>. The
295 tag's C<id> defaults to C<name_to_id($name)>.
297 =item C<man_days_tag $name, $object, %attributes>
299 Creates two HTML inputs: a text input for entering a number and a drop
300 down box for chosing the unit (either 'man days' or 'hours').
302 C<$object> must be a L<Rose::DB::Object> instance using the
303 L<SL::DB::Helper::AttrDuration> helper.
305 C<$name> is supposed to be the name of the underlying column,
306 e.g. C<time_estimation> for an instance of
307 C<SL::DB::RequirementSpecItem>. If C<$name> has the form
308 C<prefix.method> then the full C<$name> is used for the input's base
309 names while the methods called on C<$object> are only the suffix. This
310 makes it possible to write statements like e.g.
312 [% P.man_days_tag("requirement_spec_item.time_estimation", SELF.item) %]
314 The attribute C<size> can be used to set the text input's size. It
317 =item C<select_tag $name, \@collection, %attributes>
319 Creates an HTML 'select' tag named C<$name> with the contents of one
320 'E<lt>optionE<gt>' tag for each element in C<\@collection> and with arbitrary
321 HTML attributes from C<%attributes>. The value
322 to use and the title to display are extracted from the elements in
323 C<\@collection>. Each element can be one of four things:
327 =item 1. An array reference with at least two elements. The first element is
328 the value, the second element is its title. The third element is optional and and should contain a boolean.
329 If it is true, than the element will be used as default.
331 =item 2. A scalar. The scalar is both the value and the title.
333 =item 3. A hash reference. In this case C<%attributes> must contain
334 I<value_key>, I<title_key> and may contain I<default_key> keys that name the keys in the element to use
335 for the value, title and default respectively.
337 =item 4. A blessed reference. In this case C<%attributes> must contain
338 I<value_key>, I<title_key> and may contain I<default_key> keys that name functions called on the blessed
339 reference whose return values are used as the value, title and default
344 For cases 3 and 4 C<$attributes{value_key}> defaults to C<id>,
345 C<$attributes{title_key}> defaults to C<$attributes{value_key}> and
346 C<$attributes{default_key}> defaults to C<selected>. Note that
347 C<$attributes{default_key}> is set to C<undef> if
348 C<$attributes{default_value_key}> is used as well (see below).
350 In addition to pure keys/method you can also provide coderefs as I<value_sub>
351 and/or I<title_sub> and/or I<default_sub>. If present, these take precedence over keys or methods,
352 and are called with the element as first argument. It must return the value, title or default.
354 Lastly a joint coderef I<value_title_sub> may be provided, which in turn takes
355 precedence over the C<value_sub> and C<title_sub> subs. It will only be called once for each
356 element and must return a list of value and title.
358 If the option C<with_empty> is set then an empty element (value
359 C<undef>) will be used as the first element. The title to display for
360 this element can be set with the option C<empty_title> and defaults to
363 The tag's C<id> defaults to C<name_to_id($name)>.
365 The option C<default> can be quite a lot of things:
369 =item 1. A scalar value. This is the value of the entry that's
372 =item 2. A hash reference for C<multiple=1>. Whether or not an entry
373 is selected by default is looked up in this hash.
375 =item 3. An array reference containing scalar values. Same as 1., just
376 for the case of C<multiple=1>.
378 =item 4. If C<default_value_key> is given: an array reference of hash
379 references. For each hash reference the value belonging to the key
380 C<default_value_key> is treated as one value to select by
381 default. Constructs a hash that's treated like 3.
383 =item 5. If C<default_value_key> is given: an array reference of
384 blessed objects. For each object the value returne from calling the
385 function named C<default_value_key> on the object is treated as one
386 value to select by default. Constructs a hash that's treated like 3.
390 5. also applies to single RDBO instances (due to 'wantarray'
391 shenanigans assigning RDBO's relationships to a hash key will result
392 in a single RDBO object being assigned instead of an array reference
393 containing that single RDBO object).
395 If the option C<with_optgroups> is set then this function expects
396 C<\@collection> to be one level deeper. The upper-most level is
397 translated into an HTML C<optgroup> tag. So the structure becomes:
401 =item 1. Array of array references. Each element in the
402 C<\@collection> is converted into an optgroup.
404 =item 2. The optgroup's C<label> attribute will be set to the
405 first element in the array element. The second array element is then
406 converted to a list of C<option> tags as described above.
410 Example for use of optgroups:
412 # First in a controller:
414 [ t8("First optgroup with three items"),
415 [ { id => 42, name => "item one" },
416 { id => 54, name => "second item" },
417 { id => 23, name => "and the third one" },
419 [ t8("Another optgroup, with a lot of items from Rose"),
420 SL::DB::Manager::Customer->get_all_sorted ],
423 # Later in the template:
424 [% L.select_tag('the_selection', COLLECTION, with_optgroups=1, title_key='name') %]
434 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
435 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>