Scroll to navigation

Param(3pm) LogReport's Lire Documentation Param(3pm)

NAME

Lire::Param - Object which represents a parameter in a XML specification.

DESCRIPTION

Lire::Param are objects which represent parameters in an XML specification. The object is used to represent the parameter's specification as well as its current value.

new( 'name' => $name, 'type' => $type, [ 'default' => $default ] )

Creates a new Lire::Param object.

name()

Returns the name of this parameter.

type()

Returns this parameter's type.

value( [ $new_value ] )

Returns (and optionnally modifies) the current value for this parameter. If no value was set, but a default is available, the default value will be returned.

default( [ $new_default ] )

Returns (and optionnally changes) the parameter's default value.

description( [ $new_description ] )

Returns (and optionnally changes) the current parameter's description.

as_type_spec()

Returns a Lire::Config::TypeSpec object which adequately represents the current parameter.

SEE ALSO

  Lire::Config::TypeSpec(3pm), Lire::XMLSpecContainer(3pm)

AUTHOR

  Francis J. Lacoste <flacoste@logreport.org>

VERSION

$Id: Param.pm,v 1.13 2006/07/23 13:16:29 vanbaal Exp $

COPYRIGHT

Copyright (C) 2001,2004 Stichting LogReport Foundation LogReport@LogReport.org
This file is part of Lire.
Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.
2006-07-23 Lire 2.1.1