.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "CGI::FormBuilder::Template 3pm" .TH CGI::FormBuilder::Template 3pm "2019-01-19" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" CGI::FormBuilder::Template \- Template adapters for FormBuilder .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # Define a template engine \& \& package CGI::FormBuilder::Template::Whatever; \& use base \*(AqWhatever::Template::Module\*(Aq; \& \& sub new { \& my $self = shift; \& my $class = ref($self) || $self; \& my %opt = @_; \& \& # override some options \& $opt{some_setting} = 0; \& $opt{another_var} = \*(AqSome Value\*(Aq; \& \& # instantiate the template engine \& $opt{engine} = Whatever::Template::Module\->new(%opt); \& \& return bless \e%opt, $class; \& } \& \& sub render { \& my $self = shift; \& my $form = shift; # only arg is form object \& \& # grab any manually\-set template params \& my %tmplvar = $form\->tmpl_param; \& \& # example template manipulation \& my $html = $self\->{engine}\->do_template(%tmplvar); \& \& return $html; # scalar HTML is returned \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This documentation describes the usage of \fBFormBuilder\fR templates, as well as how to write your own template adapter. .PP The template engines serve as adapters between \s-1CPAN\s0 template modules and \fBFormBuilder\fR. A template engine is invoked by using the \f(CW\*(C`template\*(C'\fR option to the top-level \f(CW\*(C`new()\*(C'\fR method: .PP .Vb 3 \& my $form = CGI::FormBuilder\->new( \& template => \*(Aqfilename.tmpl\*(Aq \& ); .Ve .PP This example points to a filename that contains an \f(CW\*(C`HTML::Template\*(C'\fR compatible template to use to layout the \s-1HTML.\s0 You can also specify the \f(CW\*(C`template\*(C'\fR option as a reference to a hash, allowing you to further customize the template processing options, or use other template engines. .PP For example, you could turn on caching in \f(CW\*(C`HTML::Template\*(C'\fR with something like the following: .PP .Vb 7 \& my $form = CGI::FormBuilder\->new( \& fields => \e@fields, \& template => { \& filename => \*(Aqform.tmpl\*(Aq, \& shared_cache => 1 \& } \& ); .Ve .PP As mentioned, specifying a hashref allows you to use an alternate template processing system like the \f(CW\*(C`Template Toolkit\*(C'\fR. A minimal configuration would look like this: .PP .Vb 7 \& my $form = CGI::FormBuilder\->new( \& fields => \e@fields, \& template => { \& type => \*(AqTT2\*(Aq, # use Template Toolkit \& template => \*(Aqform.tmpl\*(Aq, \& }, \& ); .Ve .PP The \f(CW\*(C`type\*(C'\fR option specifies the name of the engine. Currently accepted types are: .PP .Vb 7 \& Builtin \- Included, default rendering if no template specified \& Div \- Render form using