| Current Path : /lib64/perl5/vendor_perl/Template/Plugin/ |
Linux gator3171.hostgator.com 4.19.286-203.ELK.el7.x86_64 #1 SMP Wed Jun 14 04:33:55 CDT 2023 x86_64 |
| Current File : //lib64/perl5/vendor_perl/Template/Plugin/HTML.pm |
#============================================================= -*-Perl-*-
#
# Template::Plugin::HTML
#
# DESCRIPTION
# Template Toolkit plugin providing useful functionality for generating
# HTML.
#
# AUTHOR
# Andy Wardley <abw@wardley.org>
#
# COPYRIGHT
# Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.
#
# This module is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
#
#============================================================================
package Template::Plugin::HTML;
use strict;
use warnings;
use base 'Template::Plugin';
our $VERSION = 2.62;
sub new {
my ($class, $context, @args) = @_;
my $hash = ref $args[-1] eq 'HASH' ? pop @args : { };
bless {
_SORTED => $hash->{ sorted } || 0,
}, $class;
}
sub element {
my ($self, $name, $attr) = @_;
($name, $attr) = %$name if ref $name eq 'HASH';
return '' unless defined $name and length $name;
$attr = $self->attributes($attr);
$attr = " $attr" if $attr;
return "<$name$attr>";
}
sub attributes {
my ($self, $hash) = @_;
return '' unless ref $hash eq 'HASH';
my @keys = keys %$hash;
@keys = sort @keys if $self->{ _SORTED };
join(' ', map {
"$_=\"" . $self->escape( $hash->{ $_ } ) . '"';
} @keys);
}
sub escape {
my ($self, $text) = @_;
for ($text) {
s/&/&/g;
s/</</g;
s/>/>/g;
s/"/"/g;
}
$text;
}
sub url {
my ($self, $text) = @_;
return undef unless defined $text;
$text =~ s/([^a-zA-Z0-9_.-])/uc sprintf("%%%02x",ord($1))/eg;
return $text;
}
1;
__END__
=head1 NAME
Template::Plugin::HTML - Plugin to create HTML elements
=head1 SYNOPSIS
[% USE HTML %]
[% HTML.escape("if (a < b && c > d) ..." %]
[% HTML.element(table => { border => 1, cellpadding => 2 }) %]
[% HTML.attributes(border => 1, cellpadding => 2) %]
=head1 DESCRIPTION
The C<HTML> plugin is a very basic plugin, implementing a few useful
methods for generating HTML.
=head1 METHODS
=head2 escape(text)
Returns the source text with any HTML reserved characters such as
C<E<lt>>, C<E<gt>>, etc., correctly esacped to their entity equivalents.
=head2 attributes(hash)
Returns the elements of the hash array passed by reference correctly
formatted (e.g. values quoted and correctly escaped) as attributes for
an HTML element.
=head2 element(type, attributes)
Generates an HTML element of the specified type and with the attributes
provided as an optional hash array reference as the second argument or
as named arguments.
[% HTML.element(table => { border => 1, cellpadding => 2 }) %]
[% HTML.element('table', border=1, cellpadding=2) %]
[% HTML.element(table => attribs) %]
=head1 DEBUGGING
The HTML plugin accepts a C<sorted> option as a constructor argument
which, when set to any true value, causes the attributes generated by
the C<attributes()> method (either directly or via C<element()>) to be
returned in sorted order. Order of attributes isn't important in
HTML, but this is provided mainly for the purposes of debugging where
it is useful to have attributes generated in a deterministic order
rather than whatever order the hash happened to feel like returning
the keys in.
[% USE HTML(sorted=1) %]
[% HTML.element( foo => { charlie => 1, bravo => 2, alpha => 3 } ) %]
generates:
<foo alpha="3" bravo="2" charlie="1">
=head1 AUTHOR
Andy Wardley E<lt>abw@wardley.orgE<gt> L<http://wardley.org/>
=head1 COPYRIGHT
Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=head1 SEE ALSO
L<Template::Plugin>
=cut
# Local Variables:
# mode: perl
# perl-indent-level: 4
# indent-tabs-mode: nil
# End:
#
# vim: expandtab shiftwidth=4: