Lire::Config::ConfigFile(3) Class for configuration file manipulation.

SYNOPSIS


use Lire::Config::ConfigFile;

DESCRIPTION

Object representing a Lire configuration file.

new( 'filename' => $file, spec => $config_spec )

Creates a new Lire::Config::ConfigFile object. The constructor takes two parameters:
filename
The file form where the configuration was stored or was loaded from.
spec
The Lire::Config::TypeSpec object to which this configuration adheres.

filename( [$new_filename] )

Returns (and optionally changes) the filename where this configuration file should be stored.

spec()

Returns the Lire::Config::TypeSpec object to which this configuration file adheres.

global( [ $config] )

Returns or modify the 'global' configuration part of the file. This is an instance Lire::Config::Compound object.

save()

Saves this ConfigConfigFile object back to the filename from which it was loaded.

revert()

Reads back the configuration from the file.

as_value()

Returns this configuration file as an hash reference. Delegates to the global configuration object contained in the file.

get( $name )

Returns the configuration parameter $name from this configuration file. Delegates to the global configuration object contained in the file.

is_set( $name )

Checks that a configuration parameter is set in this file. Delegates to the global configuration object contained in the file.

set( $param )

Sets a configuration variable in the file. Delegates to the global configuration object contained in the file.

AUTHORS

Wessel Dankers <[email protected]> Francis J. Lacoste <[email protected]> Wolfgang Sourdeau <[email protected]>

VERSION

$Id: ConfigFile.pm,v 1.9 2006/07/23 13:16:30 vanbaal Exp $

COPYRIGHT

Copyright (C) 2002-2004 Stichting LogReport Foundation [email protected]

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.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:
Around line 42:
'=end' without a target?
Around line 64:
You forgot a '=back' before '=head2'