/ 
Mixin-ExtraFields-Param-0.011
River stage one • 1 direct dependent • 5 total dependents
/ Mixin::ExtraFields::Param

NAME

Mixin::ExtraFields::Param - make your class provide a familiar "param" method

VERSION

version 0.011

$Id: /my/cs/projects/Mixin-ExtraFields-Param/trunk/lib/Mixin/ExtraFields/Param.pm 29059 2006-12-11T03:20:29.045283Z rjbs  $

SYNOPSIS

package Widget::Parametric;
use Mixin::ExtraFields::Param -fields => { driver => 'HashGuts' };;

...

my $widget = Widget::Parametric->new({ flavor => 'vanilla' });

printf "%s: %s\n", $_, $widget->param($_) for $widget->param;

DESCRIPTION

This module mixes in to your class to provide a param method like the ones provided by CGI, CGI::Application, and other classes. It uses Mixin::ExtraFields, which means it can use any Mixin::ExtraFields driver to store your data.

By default, the methods provided are:

  • param

  • exists_param

  • delete_param

These methods are imported by the fields group, which must be requested. If a moniker argument is supplied, the moniker is used instead of "param". For more information, see Mixin::ExtraFields.

METHODS

param

my @params = $object->param;        # get names of existing params

my $value = $object->param('name'); # get value of a param

my $value = $object->param(name => $value); # set a param's value

my @values = $object->param(n1 => $v1, n2 => $v2, ...); # set many values

This method sets or retrieves parameters.

AUTHOR

Ricardo SIGNES, <rjbs@cpan.org>

BUGS

Please report any bugs or feature requests to http://rt.cpan.org, for Mixin-ExtraFields-Param. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT

Copyright 2005-2006 Ricardo Signes, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.