########################################################################### # Copyright (c) Nate Wiger http://nateware.com. All Rights Reserved. # Please visit http://formbuilder.org for tutorials, support, and examples. ########################################################################### package CGI::FormBuilder::Template::HTML; =head1 NAME CGI::FormBuilder::Template::HTML - FormBuilder interface to HTML::Template =head1 SYNOPSIS my $form = CGI::FormBuilder->new( fields => \@fields, template => 'form.tmpl', ); =cut use Carp; use strict; use warnings; no warnings 'uninitialized'; use CGI::FormBuilder::Util; use HTML::Template; use base 'HTML::Template'; our $VERSION = '3.09'; # # For legacy reasons, and due to its somewhat odd interface, # HTML::Template vars use a completely different naming scheme. # our %FORM_VARS = ( 'js-head' => 'jshead', 'form-title' => 'title', 'form-start' => 'start', 'form-submit' => 'submit', 'form-reset' => 'reset', 'form-end' => 'end', 'form-invalid' => 'invalid', 'form-required' => 'required', ); our %FIELD_VARS = map { $_ => "$_-%s" } qw( field value label type comment required error invalid missing nameopts cleanopts ); sub new { my $self = shift; my $class = ref($self) || $self; my $opt = arghash(@_); $opt->{die_on_bad_params} = 0; # force to avoid blow-ups $opt->{engine} = HTML::Template->new(%$opt); return bless $opt, $class; # rebless } sub engine { return shift()->{engine}; } sub render { my $self = shift; my $tvar = shift || puke "Missing template expansion hashref (\$form->prepare failed?)"; while(my($to, $from) = each %FORM_VARS) { debug 1, "renaming attr $from to: "; $tvar->{$to} = "$tvar->{$from}"; } # # For HTML::Template, each data struct is manually assigned # to a separate and tag # my @fieldlist; for my $field (@{$tvar->{fields}}) { # Field name is usually a good idea my $name = $field->{name}; debug 1, "expanding field: $name"; # Get all values my @value = @{$tvar->{field}{$name}{values} || []}; my @options = @{$tvar->{field}{$name}{options} || []}; # # Auto-expand all of our field tags, such as field, label, value # comment, error, etc, etc # my %all_loop; while(my($key, $str) = each %FIELD_VARS) { my $var = sprintf $str, $name; $all_loop{$key} = $tvar->{field}{$name}{$key}; $tvar->{$var} = "$tvar->{field}{$name}{$key}"; # fuck Perl debug 2, " = " . $all_loop{$str}; } # # Create a for multi-values/multi-opts # we can't include the field, really, since this would involve # too much effort knowing what type # my @tmpl_loop = (); for my $opt (@options) { # Since our data structure is a series of ['',''] things, # we get the name from that. If not, then it's a list # of regular old data that we _toname if nameopts => 1 debug 2, "looking at field $name option $opt"; my($o,$n) = optval $opt; $n ||= $tvar->{"nameopts-$name"} ? toname($o) : $o; my($slct, $chk) = ismember($o, @value) ? ('selected', 'checked') : ('',''); debug 2, " = adding { label => $n, value => $o }"; push @tmpl_loop, { label => $n, value => $o, checked => $chk, selected => $slct, }; } # Now assign our loop-field $tvar->{"loop-$name"} = \@tmpl_loop; # Finally, push onto a top-level loop named "fields" push @fieldlist, { field => $all_loop{field}, value => $all_loop{value}, values => [ @value ], options => [ @options ], label => $all_loop{label}, comment => $all_loop{comment}, error => $all_loop{error}, required=> $all_loop{required}, missing => $all_loop{missing}, fieldset=> $all_loop{fieldset}, loop => [ @tmpl_loop ], }; } # kill our previous fields list $tvar->{fields} = \@fieldlist; # loop thru each field we have and set the tmpl_param while(my($param, $tag) = each %$tvar) { $self->{engine}->param($param => $tag); } # template output return $self->{engine}->output; } 1; __END__ =head1 DESCRIPTION This engine adapts B to use C. C is the default template option and is activated one of two ways. Either: my $form = CGI::FormBuilder->new( fields => \@fields, template => 'form.tmpl', ); Or, you can specify any options which C<< HTML::Template->new >> accepts by using a hashref: my $form = CGI::FormBuilder->new( fields => \@fields, template => { type => 'HTML', filename => 'form.tmpl', shared_cache => 1, loop_context_vars => 1 } ); The following methods are provided (usually only used internally): =head2 engine Returns a reference to the C object =head2 prepare Returns a hash of all the fields ready to be rendered. =head2 render Uses the prepared hash and expands the template, returning a string of HTML. =head1 TEMPLATES In your template, each of the form fields will correspond directly to a C<< >> of the same name prefixed with "field-" in the template. So, if you defined a field called "email", then you would setup a variable called C<< >> in your template. In addition, there are a couple special fields: - JavaScript to stick in - The of the HTML form <tmpl_var form-start> - Opening <form> tag and internal fields <tmpl_var form-submit> - The submit button(s) <tmpl_var form-reset> - The reset button <tmpl_var form-end> - Just the closing </form> tag Let's look at an example C<form.tmpl> template we could use: <html> <head> <title>User Information

User Information

Please fill out the following information:

Your full name:

Your email address:

Choose a password:

Please confirm it:

Your home zipcode:

As you see, you get a C<< >> for each for field you define. However, you may want even more control. That is, maybe you want to specify every nitty-gritty detail of your input fields, and just want this module to take care of the statefulness of the values. This is no problem, since this module also provides several other C<< >> tags as well: - The value of a given field - The human-readable label - Any optional comment - Error text if validation fails - See if the field is required This means you could say something like this in your template: : And B would take care of the value stickiness for you, while you have control over the specifics of the C<< >> tag. A sample expansion may create HTML like the following: Email: You must enter a valid value Note, though, that this will only get the I value in the case of a multi-value parameter (for example, a multi-select list). To remedy this, if there are multiple values you will also get a C<< >> prefixed with "loop-". So, if you had: myapp.cgi?color=gray&color=red&color=blue This would give the C field three values. To create a select list, you would do this in your template: With C<< >> tags, each iteration gives you several variables: Inside , this... Gives you this --------------------------- ------------------------------- value of that option label for that option if selected, the word "checked" if selected, the word "selected" Please note that C<< >> gives you one of the I, not the values. Why? Well, if you think about it you'll realize that select lists and radio groups are fundamentally different from input boxes in a number of ways. Whereas in input tags you can just have an empty value, with lists you need to iterate through each option and then decide if it's selected or not. When you need precise control in a template this is all exposed to you; normally B does all this magic for you. If you don't need exact control over your lists, simply use the C<< >> tag and this will all be done automatically, which I strongly recommend. But, let's assume you need exact control over your lists. Here's an example select list template: Then, your Perl code would fiddle the field as follows: $form->field( name => 'color', nameopts => 1, options => [qw(red green blue yellow black white gray)] ); Assuming query string as shown above, the template would then be expanded to something like this: Notice that the C<< >> tag is expanded to the word "selected" when a given option is present as a value as well (i.e., via the CGI query). The C<< >> tag expands to each option in turn, and C<< >> is expanded to the label for that value. In this case, since C was specified to C, the labels are automatically generated from the options. Let's look at one last example. Here we want a radio group that allows a person to remove themself from a mailing list. Here's our template: Do you want to be on our mailing list?

Then, we would twiddle our C field via C: $form->field( name => 'mailopt', options => [ [ 1 => 'Yes, please keep me on it!' ], [ 0 => 'No, remove me immediately.' ] ] ); When the template is rendered, the result would be something like this: Do you want to be on our mailing list?

Yes, please keep me on it! No, remove me immediately
When the form was then sumbmitted, you would access the values just like any other field: if ($form->field('mailopt')) { # is 1, so add them } else { # is 0, remove them } Finally, you can also loop through each of the fields using the top-level C loop in your template. This allows you to reuse the same template even if your parameters change. The following template code would loop through each field, creating a table row for each:
Each loop will have a C