.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Jifty::Param::Schema 3pm"
.TH Jifty::Param::Schema 3pm "2010-09-25" "perl v5.14.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"
Jifty::Param::Schema \- Declare parameters of a Jifty action with ease.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    package MyApp::Action::Login;
\&    use Jifty::Param::Schema;
\&    use Jifty::Action schema {
\&
\&    param email =>
\&        label is \*(AqEmail address\*(Aq,
\&        is mandatory,
\&        ajax validates;
\&
\&    param password =>
\&        type is \*(Aqpassword\*(Aq,
\&        label is \*(AqPassword\*(Aq,
\&        is mandatory;
\&
\&    param remember =>
\&        type is \*(Aqcheckbox\*(Aq,
\&        label is \*(AqRemember me?\*(Aq,
\&        hints is \*(AqIf you want, your browser can remember your login for you\*(Aq,
\&        default is 0;
\&
\&    };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a simple syntax to declare action parameters.
.PP
It re-exports \f(CW\*(C`defer\*(C'\fR and \f(CW\*(C`lazy\*(C'\fR from Scalar::Defer, for setting
parameter fields that must be recomputed at request-time:
.PP
.Vb 2
\&    param name =>
\&        default is defer { Jifty\->web\->current_user\->name };
.Ve
.PP
See Scalar::Defer for more information about \f(CW\*(C`defer\*(C'\fR.
.SS "schema"
.IX Subsection "schema"
The \f(CW\*(C`schema\*(C'\fR block from a Jifty::Action subclass describes an action
for a Jifty application.
.PP
Within the \f(CW\*(C`schema\*(C'\fR block, the localization function \f(CW\*(C`_\*(C'\fR is redefined
with \f(CW\*(C`defer\*(C'\fR, so that it resolves into a dynamic value that will be
recalculated upon each request, according to the user's current language
preference.
.SS "param"
.IX Subsection "param"
Each \f(CW\*(C`param\*(C'\fR statement inside the \f(CW\*(C`schema\*(C'\fR block sets out the name
and attributes used to describe one named parameter, which is then used
to build a Jifty::Param object.  That class defines possible field names
to use in the declarative syntax here.
.PP
The \f(CW\*(C`param\*(C'\fR function is not available outside the \f(CW\*(C`schema\*(C'\fR block.
.SH "ALIASES"
.IX Header "ALIASES"
In addition to the labels provided by Jifty::Web::Form::Field and
Jifty::Param, this module offers the following aliases:
.PP
.Vb 7
\&    ajax validates,             # ajax_validates is 1
\&    ajax canonicalizes,         # ajax_canonicalizes is 1
\&    order is \-1,                # sort_order is \-1
\&    default is 0,               # default_value is 0
\&    valid are qw( 1 2 3 ),      # valid_values are qw( 1 2 3 )
\&    available are qw( 1 2 3 ),  # available_values are qw( 1 2 3 )
\&    render as \*(Aqselect\*(Aq,         # render_as is \*(Aqselect\*(Aq
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Object::Declare, Scalar::Defer
.SS "merge_params \s-1HASHREF\s0 \s-1HASHREF\s0"
.IX Subsection "merge_params HASHREF HASHREF"
Takes two hashrefs. Merges them together and returns the merged hashref.
.PP
.Vb 3
\&    \- Empty fields in subclasses don\*(Aqt override nonempty fields in superclass anymore.
\&    \- Arrays don\*(Aqt merge; e.g. if parent class\*(Aqs valid_values is [1,2,3,4], and
\&      subclass\*(Aqs valid_values() is [1,2], they don\*(Aqt somehow become [1,2,3,4,1,2].
.Ve
.PP
\&\s-1BUG:\s0 This should either be a private routine or factored out into Jifty::Util