.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Mixin::ExtraFields::Param 3pm"
.TH Mixin::ExtraFields::Param 3pm "2021-01-09" "perl v5.32.0" "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"
Mixin::ExtraFields::Param \- make your class provide a familiar "param" method
.SH "VERSION"
.IX Header "VERSION"
version 0.020
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package Widget::Parametric;
\&  use Mixin::ExtraFields::Param \-fields => { driver => \*(AqHashGuts\*(Aq };;
\&
\&  ...
\&
\&  my $widget = Widget::Parametric\->new({ flavor => \*(Aqvanilla\*(Aq });
\&
\&  printf "%s: %s\en", $_, $widget\->param($_) for $widget\->param;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module mixes in to your class to provide a \f(CW\*(C`param\*(C'\fR method like the ones
provided by \s-1CGI\s0, CGI::Application, and other classes.  It uses
Mixin::ExtraFields, which means it can use any Mixin::ExtraFields driver to
store your data.
.PP
By default, the methods provided are:
.IP "\(bu" 4
param
.IP "\(bu" 4
exists_param
.IP "\(bu" 4
delete_param
.PP
These methods are imported by the \f(CW\*(C`fields\*(C'\fR group, which must be requested.  If
a \f(CW\*(C`moniker\*(C'\fR argument is supplied, the moniker is used instead of \*(L"param\*(R".  For
more information, see Mixin::ExtraFields.
.SH "METHODS"
.IX Header "METHODS"
.SS "param"
.IX Subsection "param"
.Vb 1
\& my @params = $object\->param;        # get names of existing params
\&
\& my $value = $object\->param(\*(Aqname\*(Aq); # get value of a param
\&
\& my $value = $object\->param(name => $value); # set a param\*(Aqs value
\&
\& my @values = $object\->param(n1 => $v1, n2 => $v2, ...); # set many values
.Ve
.PP
This method sets or retrieves parameters.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2005 by Ricardo \s-1SIGNES.\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.