Config::Abstract - Perl extension for abstracting configuration files


Config-Abstract documentation  | view source Contained in the Config-Abstract distribution.

Index


SYNOPSIS

Top

 use Config::Abstract;
 my $ini = new Config::Abstract('testdata.pl');

DESCRIPTION

Top

 Config::Abstract is the base  class for a  number of  other classes
 created to facilitate use and  handling of a  variety of  different
 configuration file formats. It uses the Data::Dumper file format to
 serialise it self and can be initialise from a file of that  format

EXAMPLES

Top

 We assume the content of the file 'testdata.pl' to be:

  $settings = {
    'book' => {
      'chapter1' => {
        'title' => 'The First Chapter, ever',
        'file' => 'book/chapter1.txt'
      },
      'title' => 'A book of chapters',
      'chapter2' => {
        'title' => 'The Next Chapter, after the First Chapter, ever',
        'file' => 'book/chapter2.txt'
      },
      'author' => 'Me, Myself and Irene'
    }
  };

 use Config::Abstract;
 my $settingsfile = 'testdata.pl';
 my $abstract = new Config::Abstract($settingsfile);

 my %book = $abstract->get_entry('book');
 my %chap1 = $abstract->get_entry_setting('book','chapter1');
 my $chap1title = $chapter1{'title'};

 # Want to see the file?
 # If you can live without comments and blank lines ;),
 # try this:
 print("My abstract file looks like this:\n$abstract\nCool, huh?\n");

 # We can also create an ini file from it
 # A bit crude, but it does the job
 bless($abstract,'Config::Abstract::Ini');
 print($abstract);

METHODS

Top

Returns a hash of all settings found in the processed file

Returns the setting at the given 'path' where the path divider is '//'.

Returns a hash of the settings within the entry ENTRYNAME. OBSOLETE, use get instead

Returns the value corresponding to ENTRYNAME,SETTINGSNAME. If the value isn't set it returns undef or, optionally, the DEFAULTVALUE. OBSOLETE, use get instead

Fill settings with data from SETTINGSHASH

Setting the entry at the given 'path', where the path divider is '//', to VALUE.

Fill the entry ENTRYNAME with data from ENTRYHASH

Set the setting ENTRYNAME,SETTINGSNAME to VALUE

Returns an object of type Config::Abstract that is a representation of the values in this object that needs altering to make it identical to OBJECT

Sets the entries in this object to whatever they are in OBJECT, creating entries as necessary. $obj_a->patch( $obj_a->diff( $obj_b ) ); should make $obj_a identical to $obj_b except for entries in obj_a that don't exist in $obj_b.

COPYRIGHT

Top

AUTHOR

Top

Eddie Olsson <ewt@avajadi.org>

SEE ALSO

Top

perl.


Config-Abstract documentation  | view source Contained in the Config-Abstract distribution.