home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / HTML.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  5.0 KB  |  198 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::HTML
  4. #
  5. # DESCRIPTION
  6. #
  7. #   Template Toolkit plugin providing useful functionality for generating
  8. #   HTML.
  9. #
  10. # AUTHOR
  11. #   Andy Wardley   <abw@kfs.org>
  12. #
  13. # COPYRIGHT
  14. #   Copyright (C) 1996-2001 Andy Wardley.  All Rights Reserved.
  15. #   Copyright (C) 1998-2001 Canon Research Centre Europe Ltd.
  16. #
  17. #   This module is free software; you can redistribute it and/or
  18. #   modify it under the same terms as Perl itself.
  19. #
  20. #----------------------------------------------------------------------------
  21. #
  22. # $Id: HTML.pm,v 2.56 2004/01/13 16:20:38 abw Exp $
  23. #
  24. #============================================================================
  25.  
  26. package Template::Plugin::HTML;
  27.  
  28. require 5.004;
  29.  
  30. use strict;
  31. use vars qw( $VERSION );
  32. use base qw( Template::Plugin );
  33. use Template::Plugin;
  34.  
  35. $VERSION = sprintf("%d.%02d", q$Revision: 2.56 $ =~ /(\d+)\.(\d+)/);
  36.  
  37. sub new {
  38.     my ($class, $context, @args) = @_;
  39.     my $hash = ref $args[-1] eq 'HASH' ? pop @args : { };
  40.     bless {
  41.     _SORTED => $hash->{ sorted } || 0,
  42.     }, $class;
  43. }
  44.  
  45. sub element {
  46.     my ($self, $name, $attr) = @_;
  47.     ($name, $attr) = %$name if ref $name eq 'HASH';
  48.     return '' unless defined $name and length $name;
  49.     $attr = $self->attributes($attr);
  50.     $attr = " $attr" if $attr;
  51.     return "<$name$attr>";
  52. }
  53.  
  54. sub attributes {
  55.     my ($self, $hash) = @_;
  56.     return '' unless UNIVERSAL::isa($hash, 'HASH');
  57.  
  58.     my @keys = keys %$hash;
  59.     @keys = sort @keys if $self->{ _SORTED };
  60.  
  61.     join(' ', map { 
  62.     "$_=\"" . $self->escape( $hash->{ $_ } ) . '"';
  63.     } @keys);
  64. }
  65.  
  66. sub escape {
  67.     my ($self, $text) = @_;
  68.     for ($text) {
  69.     s/&/&/g;
  70.     s/</</g;
  71.     s/>/>/g;
  72.     s/"/"/g;
  73.     }
  74.     $text;
  75. }
  76.  
  77. sub url {
  78.     my ($self, $text) = @_;
  79.     return undef unless defined $text;
  80.     $text =~ s/([^a-zA-Z0-9_.-])/uc sprintf("%%%02x",ord($1))/eg;
  81.     return $text;
  82. }
  83.  
  84.  
  85. 1;
  86.  
  87. __END__
  88.  
  89.  
  90. #------------------------------------------------------------------------
  91. # IMPORTANT NOTE
  92. #   This documentation is generated automatically from source
  93. #   templates.  Any changes you make here may be lost.
  94. # 
  95. #   The 'docsrc' documentation source bundle is available for download
  96. #   from http://www.template-toolkit.org/docs.html and contains all
  97. #   the source templates, XML files, scripts, etc., from which the
  98. #   documentation for the Template Toolkit is built.
  99. #------------------------------------------------------------------------
  100.  
  101. =head1 NAME
  102.  
  103. Template::Plugin::HTML - Plugin to create HTML elements
  104.  
  105. =head1 SYNOPSIS
  106.  
  107.     [% USE HTML %]
  108.  
  109.     [% HTML.escape("if (a < b && c > d) ..." %]
  110.  
  111.     [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
  112.  
  113.     [% HTML.attributes(border => 1, cellpadding => 2) %]
  114.  
  115. =head1 DESCRIPTION
  116.  
  117. The HTML plugin is very new and very basic, implementing a few useful
  118. methods for generating HTML.  It is likely to be extended in the future
  119. or integrated with a larger project to generate HTML elements in a generic
  120. way (as discussed recently on the mod_perl mailing list).
  121.  
  122. =head1 METHODS
  123.  
  124. =head2 escape(text)
  125.  
  126. Returns the source text with any HTML reserved characters such as 
  127. E<lt>, E<gt>, etc., correctly esacped to their entity equivalents.
  128.  
  129. =head2 attributes(hash)
  130.  
  131. Returns the elements of the hash array passed by reference correctly
  132. formatted (e.g. values quoted and correctly escaped) as attributes for
  133. an HTML element.
  134.  
  135. =head2 element(type, attributes)
  136.  
  137. Generates an HTML element of the specified type and with the attributes
  138. provided as an optional hash array reference as the second argument or
  139. as named arguments.
  140.  
  141.     [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
  142.     [% HTML.element('table', border=1, cellpadding=2) %]
  143.     [% HTML.element(table => attribs) %]
  144.  
  145. =head1 DEBUGGING
  146.  
  147. The HTML plugin accepts a 'sorted' option as a constructor argument
  148. which, when set to any true value, causes the attributes generated by
  149. the attributes() method (either directly or via element()) to be
  150. returned in sorted order.  Order of attributes isn't important in
  151. HTML, but this is provided mainly for the purposes of debugging where
  152. it is useful to have attributes generated in a deterministic order
  153. rather than whatever order the hash happened to feel like returning
  154. the keys in.
  155.  
  156.     [% USE HTML(sorted=1) %]
  157.     [% HTML.element( foo => { charlie => 1, bravo => 2, alpha => 3 } ) %]
  158.  
  159. generates:
  160.  
  161.     <foo alpha="3" bravo="2" charlie="1">
  162.  
  163. =head1 AUTHOR
  164.  
  165. Andy Wardley E<lt>abw@andywardley.comE<gt>
  166.  
  167. L<http://www.andywardley.com/|http://www.andywardley.com/>
  168.  
  169.  
  170.  
  171.  
  172. =head1 VERSION
  173.  
  174. 2.56, distributed as part of the
  175. Template Toolkit version 2.13, released on 30 January 2004.
  176.  
  177. =head1 COPYRIGHT
  178.  
  179.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  180.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  181.  
  182. This module is free software; you can redistribute it and/or
  183. modify it under the same terms as Perl itself.
  184.  
  185. =head1 SEE ALSO
  186.  
  187. L<Template::Plugin|Template::Plugin>
  188.  
  189. =cut
  190.  
  191. # Local Variables:
  192. # mode: perl
  193. # perl-indent-level: 4
  194. # indent-tabs-mode: nil
  195. # End:
  196. #
  197. # vim: expandtab shiftwidth=4:
  198.