Presenter: hidden_tag, javascript, checkbox_tag von L → Presenter::Tag verschoben
[kivitendo-erp.git] / SL / Presenter / Tag.pm
index 43591e5..e1a041d 100644 (file)
@@ -2,16 +2,18 @@ package SL::Presenter::Tag;
 
 use strict;
 
+use SL::HTML::Restrict;
+
 use parent qw(Exporter);
 
 use Exporter qw(import);
-our @EXPORT = qw(html_tag input_tag man_days_tag name_to_id select_tag stringify_attributes);
+our @EXPORT = qw(html_tag input_tag hidden_tag javascript man_days_tag name_to_id select_tag checkbox_tag stringify_attributes restricted_html);
 
 use Carp;
 
 my %_valueless_attributes = map { $_ => 1 } qw(
   checked compact declare defer disabled ismap multiple noresize noshade nowrap
-  readonly selected
+  readonly selected hidden
 );
 
 sub _call_on {
@@ -60,6 +62,11 @@ sub input_tag {
   return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
 }
 
+sub hidden_tag {
+  my ($self, $name, $value, %attributes) = @_;
+  return $self->input_tag($name, $value, %attributes, type => 'hidden');
+}
+
 sub man_days_tag {
   my ($self, $name, $object, %attributes) = @_;
 
@@ -146,6 +153,10 @@ sub select_tag {
   my $list_to_code = sub {
     my ($sub_collection) = @_;
 
+    if ('ARRAY' ne ref $sub_collection) {
+      $sub_collection = [ $sub_collection ];
+    }
+
     my @options;
     foreach my $entry ( @{ $sub_collection } ) {
       my $value;
@@ -183,14 +194,56 @@ sub select_tag {
   return $self->html_tag('select', $code, %attributes, name => $name);
 }
 
+sub checkbox_tag {
+  my ($self, $name, %attributes) = @_;
+
+  _set_id_attribute(\%attributes, $name);
+
+  $attributes{value}   = 1 unless defined $attributes{value};
+  my $label            = delete $attributes{label};
+  my $checkall         = delete $attributes{checkall};
+  my $for_submit       = delete $attributes{for_submit};
+
+  if ($attributes{checked}) {
+    $attributes{checked} = 'checked';
+  } else {
+    delete $attributes{checked};
+  }
+
+  my $code  = '';
+  $code    .= $self->hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit;
+  $code    .= $self->html_tag('input', undef,  %attributes, name => $name, type => 'checkbox');
+  $code    .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+  $code    .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
+
+  return $code;
+}
+
+sub javascript {
+  my ($self, $data) = @_;
+  return $self->html_tag('script', $data, type => 'text/javascript');
+}
+
 sub _set_id_attribute {
-  my ($attributes, $name) = @_;
+  my ($attributes, $name, $unique) = @_;
 
-  $attributes->{id} = name_to_id(undef, $name) if !delete($attributes->{no_id}) && !$attributes->{id};
+  if (!delete($attributes->{no_id}) && !$attributes->{id}) {
+    $attributes->{id}  = name_to_id(undef, $name);
+    $attributes->{id} .= '_' . $attributes->{value} if $unique;
+  }
 
   return %{ $attributes };
 }
 
+my $html_restricter;
+
+sub restricted_html {
+  my ($self, $value) = @_;
+
+  $html_restricter ||= SL::HTML::Restrict->create;
+  return $html_restricter->process($value);
+}
+
 1;
 __END__
 
@@ -204,7 +257,7 @@ SL::Presenter::Tag - Layouting / tag generation
 
 =head1 SYNOPSIS
 
-Usage from a template:
+Usage in a template:
 
   [% USE P %]
 
@@ -212,14 +265,14 @@ Usage from a template:
 
   [% P.select_tag('direction', [ { direction => 'left',  display => 'To the left'  },
                                  { direction => 'right', display => 'To the right' } ],
-                               value_key => 'direction', title_key => 'display', default => 'right')) %]
+                               value_key => 'direction', title_key => 'display', default => 'right') %]
 
   [% P.select_tag('direction', [ { direction => 'left',  display => 'To the left'  },
                                  { direction => 'right', display => 'To the right', selected => 1 } ],
-                               value_key => 'direction', title_key => 'display')) %]
+                               value_key => 'direction', title_key => 'display') %]
 
-  # Use an RDBO object and it's n:m relatioship as the default
-  # values. For example, a user can be a member in many groups. "All
+  # Use an RDBO object and its n:m relationship as the default
+  # values. For example, a user can be a member of many groups. "All
   # groups" is therefore the full collection and "$user->groups" is a
   # list of RDBO AuthGroup objects whose IDs must match the ones in
   # "All groups". This could look like the following:
@@ -260,6 +313,10 @@ Creates a string from all elements in C<%items> suitable for usage as
 HTML tag attributes. Keys and values are HTML escaped even though keys
 must not contain non-ASCII characters for browsers to accept them.
 
+=item C<restricted_html $html>
+
+Returns HTML stripped of unknown tags. See L<SL::HTML::Restrict>.
+
 =back
 
 =head2 HIGH-LEVEL FUNCTIONS
@@ -294,7 +351,7 @@ defaults to 5.
 
 =item C<select_tag $name, \@collection, %attributes>
 
-Creates a HTML 'select' tag named C<$name> with the contents of one
+Creates an HTML 'select' tag named C<$name> with the contents of one
 'E<lt>optionE<gt>' tag for each element in C<\@collection> and with arbitrary
 HTML attributes from C<%attributes>. The value
 to use and the title to display are extracted from the elements in
@@ -365,23 +422,23 @@ value to select by default. Constructs a hash that's treated like 3.
 
 =back
 
-5. also applies for single RDBO instances (due to 'wantarray'
-shenanigangs assigning RDBO's relationships to a hash key will result
+5. also applies to single RDBO instances (due to 'wantarray'
+shenanigans assigning RDBO's relationships to a hash key will result
 in a single RDBO object being assigned instead of an array reference
 containing that single RDBO object).
 
 If the option C<with_optgroups> is set then this function expects
 C<\@collection> to be one level deeper. The upper-most level is
-translated into a HTML C<optgroup> tag. So the structure becomes:
+translated into an HTML C<optgroup> tag. So the structure becomes:
 
 =over 4
 
 =item 1. Array of array references. Each element in the
 C<\@collection> is converted into an optgroup.
 
-=item 2. The optgroup's C<label> attribute will be set to the the
+=item 2. The optgroup's C<label> attribute will be set to the
 first element in the array element. The second array element is then
-converted to a list of C<option> tags like it is described above.
+converted to a list of C<option> tags as described above.
 
 =back
 
@@ -389,7 +446,7 @@ Example for use of optgroups:
 
   # First in a controller:
   my @collection = (
-    [ t8("First optgroup with two items"),
+    [ t8("First optgroup with three items"),
       [ { id => 42, name => "item one" },
         { id => 54, name => "second item" },
         { id => 23, name => "and the third one" },