.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CGI::FormBuilder::Source::YAML 3pm" .TH CGI::FormBuilder::Source::YAML 3pm "2015-06-08" "perl v5.20.2" "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::Source::YAML \- Initialize FormBuilder from YAML file .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use CGI::FormBuilder; \& \& my $form = CGI::FormBuilder\->new( \& source => { \& source => \*(Aqform.fb\*(Aq, \& type => \*(AqYAML\*(Aq, \& }, \& ); \& \& my $lname = $form\->field(\*(Aqlname\*(Aq); # like normal .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This reads a \s-1YAML \s0(YAML::Syck) file that contains \fBFormBuilder\fR config options and returns a hash to be fed to CGI::FormBuilder\->\fInew()\fR. .PP Instead of the syntax read by CGI::FormBuilder::Source::File, it uses \s-1YAML\s0 syntax as read by YAML::Syck. That means you fully specify the entire data structure. .PP LoadCode is enabled, so you can use \s-1YAML\s0 syntax for defining subroutines. This is convenient if you have a function that generates validation subrefs, for example, I have one that can check profanity using Regexp::Common. .PP .Vb 10 \& validate: \& myfield: \& javascript: /^[\es\eS]{2,50}$/ \& perl: !!perl/code: >\- \& { My::Funk::fb_perl_validate({ \& min => 2, \& max => 50, \& profanity => \*(Aqcheck\*(Aq \& })\->(shift); \& } .Ve .SH "POST PROCESSING" .IX Header "POST PROCESSING" There are two exceptions to \*(L"pure \s-1YAML\s0 syntax\*(R" where this module does some post-processing of the result. .SS "\s-1REFERENCES \s0(ala CGI::FormBuilder::Source::File)" .IX Subsection "REFERENCES (ala CGI::FormBuilder::Source::File)" You can specify references as string values that start with \&\e&, \e$, \e@, or \e% in the same way you can with CGI::FormBuilder::Source::File. If you have a full direct package reference, it will look there, otherwise it will traverse up the caller stack and take the first it finds. .PP For example, say your code serves multiple sites, and a menu gets different options depending on the server name requested: .PP .Vb 5 \& # in My::Funk: \& our $food_options = { \& www.meats.com => [qw( beef chicken horta fish )], \& www.veggies.com => [qw( carrot apple quorn radish )], \& }; \& \& # in source file: \& options: \e@{ $My::Funk::food_options\->{ $ENV{SERVER_NAME} } } .Ve .SS "\s-1EVAL STRINGS\s0" .IX Subsection "EVAL STRINGS" You can specify an eval statement. You could achieve the same example a different way: .PP .Vb 1 \& options: eval { $My::Funk::food_options\->{ $ENV{SERVER_NAME} }; } .Ve .PP The cost either way is about the same \*(-- the string is eval'd. .SH "EXAMPLE" .IX Header "EXAMPLE" .Vb 7 \& method: GET \& header: 0 \& title: test \& name: test \& action: /test \& submit: test it \& linebreaks: 1 \& \& required: \& \- test1 \& \- test2 \& \& fields: \& \- test1 \& \- test2 \& \- test3 \& \- test4 \& \& fieldopts: \& test1: \& type: text \& size: 10 \& maxlength: 32 \& \& test2: \& type: text \& size: 10 \& maxlength: 32 \& \& test3: \& type: radio \& options: \& \- \& \- 1 \& \- Yes \& \- \& \- 0 \& \- No \& \& test4: \& options: \e@test4opts \& sort: \e&Someother::Package::sortopts \& \& validate: \& test1: /^\ew{3,10}$/ \& test2: \& javascript: EMAIL \& perl: eq \*(Aqtest@test.foo\*(Aq \& test3: \& \- 0 \& \- 1 \& test4: \e@test4opts .Ve .PP You get the idea. A bit more whitespace, but it works in a standardized way. .SH "METHODS" .IX Header "METHODS" .SS "\fInew()\fP" .IX Subsection "new()" Normally not used directly; it is called from CGI::FormBuilder. Creates the \f(CW\*(C`CGI::FormBuilder::Source::YAML\*(C'\fR object. Arguments from the 'source' hash passed to CGI::FormBuilder\->\fInew()\fR will become defaults, unless specified in the file. .SS "parse($source)" .IX Subsection "parse($source)" Normally not used directly; it is called from CGI::FormBuilder. Parses the specified source file. No fancy params \*(-- just a single filename is accepted. If the file isn't acceptable to YAML::Syck, I suppose it will die. .SH "SEE ALSO" .IX Header "SEE ALSO" CGI::FormBuilder, CGI::FormBuilder::Source .SH "AUTHOR" .IX Header "AUTHOR" Copyright (c) 2006 Mark Hedges . All rights reserved. .SH "LICENSE" .IX Header "LICENSE" This module is free software; you may copy it under terms of the Perl license (\s-1GNU\s0 General Public License or Artistic License.) http://www.opensource.org/licenses/index.html