The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Config-Trivial-Storable-0.10
River stage zero No dependents
/ Config::Trivial::Storable

NAME

Config::Trivial::Storable - Very simple tool for reading and writing very simple Storable configuration files

SYNOPSIS

  use Config::Trivial::Storable;
  my $config = Config::Trivial::Storable->new(config_file => "path/to/my/config.conf");
  my $settings = $config->read;
  print "Setting Colour is:\t", $settings->{'colour'};
  $settings->{'new-item'} = "New Setting";
  $settings->store;

DESCRIPTION

Use this module when you want use "Yet Another" very simple, light weight configuration file reader. The module extends Config::Trivial by providing Storable Support. See that module for more details.

store

The store method outputs a storable binary version of the configuration rather than a plain text version that the write version would.

There are two optional parameters that can be passed, a file name to use instead of the current one, and a reference of a hash to write out instead of the currently loaded one.

  $config->store(
    file_name => "/path/to/somewhere/else",
    configuration => $settings);

The method returns true on success. If the file already exists then it is backed up first. The write is not "atomic" or locked for reading in anyway. If the file cannot be written to then it will die.

Configuration data passed by this method is only written to file, it is not stored in the internal configuration object. To store data in the internal use the set_configuration data method. The option to pass a hash_ref in this method may be removed in future versions.

retrieve

This is the analog to read, only it reads data from a storable binary.

  $config->retrieve;

CONFIG FORMAT

About The Configuration File Format

This module extends Config::Trivial with optional support for using Storable binaries as a configuration file format, rather than plain text files.

The format of the text files is as with Config::Trivial and remains unchanged, as this module inherits from that one. The Storable format is offerd so that modules can simple "retrieve" their configuration without the use of any particular configuration module.

This module extends Config::Trivial so that they can be used to quickly read configuration in one format and convert to another.

MISC

Prerequisites

At the moment the module only uses core modules, plus Config::Trivial The test suite optionally uses POD::Coverage and Test::Pod, which will be skipped if you don't have them.

History

See Changes file.

Defects and Limitations

Patches Welcome... ;-)

EXPORT

None.

AUTHOR

Adam Trickett, <atrickett@cpan.org>

SEE ALSO

perl, Config::Trivial.

COPYRIGHT

This version as Config::Trivial::Storable, Copyright iredale consulting 2006

OSI Certified Open Source Software.

This program 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; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.