.\" 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 "MooseX::Param 3pm"
.TH MooseX::Param 3pm "2012-03-29" "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"
MooseX::Param \- Simple role to provide a standard param method
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package My::Template::System;
\&  use Moose;
\&  
\&  with \*(AqMooseX::Param\*(Aq;
\&  
\&  # ...
\&  
\&  my $template = My::Template::System\->new(
\&      params => { 
\&          foo => 10,
\&          bar => 20,
\&          baz => 30,
\&      }
\&  );
\&  
\&  # fetching params
\&  $template\->param(\*(Aqfoo\*(Aq); # 10
\&  
\&  # getting list of params
\&  $template\->param(); # foo, bar, baz
\&  
\&  # setting params
\&  $template\->param(foo => 30, bar => 100);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a very simple Moose role which provides a \s-1CGI\s0 like \f(CW\*(C`param\*(C'\fR method.
.PP
I found that I had written this code over and over and over and over again, 
and each time it was the same. So I thought, why not put it in a role?
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "\fIparams\fR" 4
.IX Item "params"
This role provides a \f(CW\*(C`params\*(C'\fR attribute which has a read-only accessor, 
and a HashRef type constraint. It also adds a builder method (see 
\&\f(CW\*(C`init_params\*(C'\fR method below) to properly initialize it.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBparams\fR" 4
.IX Item "params"
Return the \s-1HASH\s0 ref in which the parameters are stored.
.IP "\fBparam\fR" 4
.IX Item "param"
This is your standard \s-1CGI\s0 style \f(CW\*(C`param\*(C'\fR method. If passed no arguments, 
it will return a list of param names. If passed a single name argument it will 
return the param associated with that name. If passed a key value pair (or set 
of key value pairs) it will assign them into the params.
.IP "\fIinit_params\fR" 4
.IX Item "init_params"
This is the \fIparams\fR attribute \f(CW\*(C`builder\*(C'\fR option, so it is called the 
params are initialized.
.Sp
\&\fB\s-1NOTE:\s0\fR You can override this by defining your own version in your class, 
because local class methods beat role methods in composition.
.IP "\fBmeta\fR" 4
.IX Item "meta"
Returns the role metaclass.
.SH "SIMILAR MODULES"
.IX Header "SIMILAR MODULES"
The \f(CW\*(C`param\*(C'\fR method can be found in several other modules, such as \s-1CGI\s0, 
CGI::Application and HTML::Template to name a few. This is such a 
common Perl idiom that I felt it really deserved it's own role (if for 
nothing more than I was sick of re-writing and copy-pasting it all the 
time).
.PP
There are also a few modules which attempt to solve the same problem as 
this module. Those are:
.IP "Class::Param" 4
.IX Item "Class::Param"
This module is much more ambitious than mine, and provides much deeper 
functionality. For most of my purposes, this module would have been 
overkill, but if you need really sophisticated param handling and the 
ability to provide several different APIs (tied, etc), this module is
probably the way to go.
.IP "Mixin::ExtraFields::Param" 4
.IX Item "Mixin::ExtraFields::Param"
This module is very similar to mine, but for a different framework. It
works with the Mixin::ExtraFields framework.
.SH "BUGS"
.IX Header "BUGS"
All complex software has bugs lurking in it, and this module is no 
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2007 by Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.