Eric Andreychek > OpenPlugin-0.11 > OpenPlugin::Param

Download:
OpenPlugin-0.11.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 1.16   Source  

NAME ^

OpenPlugin::Param - Retrieve GET/POST/other values sent by client with a request

SYNOPSIS ^

 $OP = OpenPlugin->new();

 @params = $OP->param->get_incoming();

 $param  = $OP->param->get_incoming('param');

DESCRIPTION ^

The Param plugin offers an interface to retrieve parameters sent from the browser to the server.

METHODS ^

get_incoming( [ $fieldname ] )

get( [ $fieldname ] )

Called with no parameters, get_incoming() returns a list containing the names of each parameter sent to the server.

Called with one parameter, get_incoming returns value(s) for $fieldname. Call in list context to return multiple values for $fieldname.

set_incoming( $fieldname = $value )>

Set the value of an incoming parameter. This is typically called internally when the server receives parameters by the browser. However, sometimes developers find it useful to be able to modify this value, perhaps in order to do sanity checking on the information sent from the user.

The $value parameter can be a reference to a hash, if there are multiple values for a particular field.

BUGS ^

None known.

TO DO ^

See the TO DO section of the <OpenPlugin::Request> plugin.

SEE ALSO ^

See the individual driver documentation for settings and parameters specific to that driver.

COPYRIGHT ^

Copyright (c) 2001-2003 Eric Andreychek. All rights reserved.

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

AUTHORS ^

Eric Andreychek <eric@openthought.net>

syntax highlighting: