.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Gantry::Utils::FormErrors 3"
.TH Gantry::Utils::FormErrors 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Gantry::Utils::FormErrors \- A CRUD form validation error object
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
A typical example:
.PP
.Vb 2
\&    use Gantry::Plugins::CRUD;
\&    use Gantry::Utils::FormErrors;
.Ve
.PP
.Vb 4
\&    my $crud_obj = Gantry::Plugins::CRUD->new(
\&        #...
\&        validator => \e&my_validator,
\&    );
.Ve
.PP
.Vb 4
\&    sub my_validator {
\&        my $opts   = shift;
\&        my $params = $opts->{ params };
\&        my $form   = $opts->{ form   };
.Ve
.PP
.Vb 2
\&        my %missing;
\&        my @errors;
.Ve
.PP
.Vb 7
\&        if ( not $params->{ password } ) {
\&            $missing{ password }++;
\&        }
\&        if ( $params->{ password } =~ /$params->{ user_name }/ ) {
\&            push @errors, 'Password cannot contain user name';
\&        }
\&        # ... other similar tests
.Ve
.PP
.Vb 1
\&        my $error_text = join "\en<br /><b>Error:</b> ", @errors;
.Ve
.PP
.Vb 1
\&        $form->{ error_text } = $error_text;
.Ve
.PP
.Vb 6
\&        return Gantry::Utils::FormErrors->new(
\&            {
\&                missing    => \e%missing,
\&            }
\&        );
\&    }
.Ve
.PP
The rest is handled by the \s-1CRUD\s0 plugin and the default template (form.tt).
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides objects which respond to the same \s-1API\s0 as
Data::FormValidator::Results (or at least the parts of that \s-1API\s0 which
Gantry normally uses).
.PP
Use this module in your Gantry::Plugins::CRUD validator callback.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Constructor, expects a hash reference with the following keys (all are
optional):
.Sp
.Vb 2
\&    missing    - a hash reference keyed by missing field names
\&    invalid    - a hash reference keyed by invalid field names
.Ve
.IP "has_missing" 4
.IX Item "has_missing"
Returns 1 if there are any keys in the missing hash.
.IP "has_invalid" 4
.IX Item "has_invalid"
Same as has_missing, except that it checks the invalid hash.
.IP "missing" 4
.IX Item "missing"
If called without arguments, returns number of missing fields.  If
call with the name of a field, returns 1 if that field is a key in the
missing hash and 0 otherwise.
.IP "invalid" 4
.IX Item "invalid"
Same as missing, but checks the invalid hash.
.IP "get_missing_hash" 4
.IX Item "get_missing_hash"
Returns the hash reference of missing fields.  Keys are field names values
are usually 1 (but they must be true).
.Sp
This is useful if two validation routines are cooperating to form the
final lists.
.IP "get_invalid_hash" 4
.IX Item "get_invalid_hash"
Returns the hash reference of invalid fields.  Keys are field names values
are usually 1 (but they must be true).
.Sp
This is useful if two validation routines are cooperating to form the
final lists.
.SH "AUTHOR"
.IX Header "AUTHOR"
Phil Crow, <philcrow2000@yayoo.com<gt>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2006 Phil Crow
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.