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 button_tag submit_tag ajax_submit_tag input_number_tag stringify_attributes restricted_html link);
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 {
}
}
+sub _J {
+ my $string = shift;
+ $string =~ s/(\"|\'|\\)/\\$1/g;
+ return $string;
+}
sub stringify_attributes {
my ($self, %params) = @_;
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) = @_;
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;
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 button_tag {
+ my ($self, $onclick, $value, %attributes) = @_;
+
+ _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
+ $attributes{type} ||= 'button';
+
+ $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm};
+
+ return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
+}
+
+sub submit_tag {
+ my ($self, $name, $value, %attributes) = @_;
+
+ _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name};
+
+ if ( $attributes{confirm} ) {
+ $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");';
+ }
+
+ return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
+}
+
+sub ajax_submit_tag {
+ my ($self, $url, $form_selector, $text, %attributes) = @_;
+
+ $url = _J($url);
+ $form_selector = _J($form_selector);
+ my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|;
+
+ return $self->button_tag($onclick, $text, %attributes);
+}
+
+sub input_number_tag {
+ my ($self, $name, $value, %params) = @_;
+
+ _set_id_attribute(\%params, $name);
+ my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : ();
+ my @classes = ('numeric');
+ push @classes, delete($params{class}) if $params{class};
+ my %class = @classes ? (class => join(' ', @classes)) : ();
+
+ $::request->layout->add_javascripts('kivi.Validator.js');
+ $::request->presenter->need_reinit_widgets($params{id});
+
+ return $self->input_tag(
+ $name, $::form->foramt_amount(\%::myconfig, $value),
+ "data-validate" => "number",
+ %params,
+ %class, @onchange,
+ );
+}
+
+
+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);
+}
+
+sub link {
+ my ($self, $href, $content, %params) = @_;
+
+ $href ||= '#';
+
+ return $self->html_tag('a', $content, %params, href => $href);
+}
+
1;
__END__
=head1 SYNOPSIS
-Usage from a template:
+Usage in a template:
[% USE P %]
[% 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:
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
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)>.
+
+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}>. The request is only submitted if the user
+clicks the dialog's ok/yes button.
+
+=item C<ajax_submit_tag $url, $form_selector, $text, %attributes>
+
+Creates a HTML 'input type="button"' tag with a very specific onclick
+handler that submits the form given by the jQuery selector
+C<$form_selector> to the URL C<$url> (the actual JavaScript function
+called for that is C<kivi.submit_ajax_form()> in
+C<js/client_js.js>). The button's label will be C<$text>.
+
+=item C<button_tag $onclick, $text, %attributes>
+
+Creates a HTML 'input type="button"' tag with an onclick handler
+C<$onclick> and a value of C<$text>. The button does not have a name
+nor an ID by default.
+
+If C<$attributes{confirm}> is set then a JavaScript popup dialog will
+be prepended to the C<$onclick> handler asking the question given with
+C<$attributes{confirm}>. The request is only submitted if the user
+clicks the dialog's "ok/yes" button.
+
=item C<man_days_tag $name, $object, %attributes>
Creates two HTML inputs: a text input for entering a number and a drop
The attribute C<size> can be used to set the text input's size. It
defaults to 5.
+=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<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.
+
+If C<%attributes> contains a key C<checkall> then the value is taken as a
+JQuery selector and clicking this checkbox will also toggle all checkboxes
+matching the selector.
+
=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
=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
# 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" },
projects / kivitendo-erp.git / blobdiff