.\" 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::Plugins::Validate 3"
.TH Gantry::Plugins::Validate 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Gantry::Plugin::Validate \- Validates input values.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  is_date
\&    if ( is_date( $date ) )
.Ve
.PP
.Vb 2
\&  is_email
\&    if ( is_email( $email ) )
.Ve
.PP
.Vb 2
\&  is_float 
\&    if ( is_float( $float ) )
.Ve
.PP
.Vb 2
\&  is_ident
\&    if ( is_ident( $ident ) )
.Ve
.PP
.Vb 2
\&  is_integer
\&    if ( is_integer( $integer ) )
.Ve
.PP
.Vb 2
\&  is_ip
\&    if ( is_ip( $ip ) )
.Ve
.PP
.Vb 2
\&  is_mac
\&    if ( is_mac( $mac ) )
.Ve
.PP
.Vb 2
\&  is_number
\&    if ( is_number( $number ) )
.Ve
.PP
.Vb 2
\&  is_text 
\&    if ( is_text( $text ) )
.Ve
.PP
.Vb 2
\&  is_time
\&    if ( is_time( $time ) )
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module allows the validation of many common types of input.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .IP "is_date( $date )" 4
.el .IP "is_date( \f(CW$date\fR )" 4
.IX Item "is_date( $date )"
This function takes a date, \f(CW$date\fR, and verifies that it is indeed a valid
date. The date must be of the form \*(L"\s-1MM\-DD\-YYYY\s0\*(R". The function returns 
either '1' or '0'.
.ie n .IP "is_email( $email )" 4
.el .IP "is_email( \f(CW$email\fR )" 4
.IX Item "is_email( $email )"
This function checks to see if \f(CW$email\fR is a valid email address. It checks
only the form of the email address and not if the username or the domain 
exist. The function returns either '1' or '0'.
.ie n .IP "is_float( $float )" 4
.el .IP "is_float( \f(CW$float\fR )" 4
.IX Item "is_float( $float )"
This function checks to see if \f(CW$float\fR is a valid floating point number. 
The function returns either '1' or '0'.
.ie n .IP "is_ident( $ident )" 4
.el .IP "is_ident( \f(CW$ident\fR )" 4
.IX Item "is_ident( $ident )"
This function checks to see if \f(CW$ident\fR is a valid text ident. This
means it has text, and none of the text is a space.  The function
returns either '1' or '0'.
.ie n .IP "is_integer( $integer )" 4
.el .IP "is_integer( \f(CW$integer\fR )" 4
.IX Item "is_integer( $integer )"
This function checks to see if \f(CW$integer\fR is in fact a valid integer number.
The function returns either '1' or '0'.
.ie n .IP "is_ip( $ip )" 4
.el .IP "is_ip( \f(CW$ip\fR )" 4
.IX Item "is_ip( $ip )"
This function checks to see if \f(CW$ip\fR is a valid ip address. The function
returns either '1' or '0'.
.ie n .IP "is_mac( $mac )" 4
.el .IP "is_mac( \f(CW$mac\fR )" 4
.IX Item "is_mac( $mac )"
This function checks to see if \f(CW$mac\fR contains the valid characters 
for a \s-1MAC\s0 address. It does not currently check to see if the \s-1MAC\s0 address
is of the proper length. The function returns either '1' or '0'.
.ie n .IP "is_number( $number )" 4
.el .IP "is_number( \f(CW$number\fR )" 4
.IX Item "is_number( $number )"
This function checks to see if \f(CW$number\fR is a valid number. It does this
by checking if it passes \f(CW\*(C`is_integer()\*(C'\fR or \f(CW\*(C`is_float()\*(C'\fR. The function 
returns eiter a '1' or a '0'.
.ie n .IP "is_text( $text )" 4
.el .IP "is_text( \f(CW$text\fR )" 4
.IX Item "is_text( $text )"
This function checks to see if \f(CW$text\fR does contain text. This is a
fairly broad range of things mainly it must be defined and have a length
that is greater than 0. The function returns either a '1' or a '0'.
.ie n .IP "is_time( $time )" 4
.el .IP "is_time( \f(CW$time\fR )" 4
.IX Item "is_time( $time )"
This function checks to see if \f(CW$time\fR does contain a valid time. A
valid date is in military time ( 0\-23:0\-59 ) seconds are optional. 
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIGantry\fR\|(3), \fIDate::Calc\fR\|(3)
.SH "LIMITATIONS"
.IX Header "LIMITATIONS"
This module depends on \fIDate::Calc\fR\|(3) for the is_date validation.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tim Keefer <tkeefer@gmail.com>
Nicholas Studt <nstudt@angrydwarf.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2005\-6, Tim Keefer.
.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.