ConfigReader::Values(3pm)

NAME
ConfigReader::Values - stores a set of configuration values

DESCRIPTION
This class stores a set of configuration values that have been read from a configuration file. Methods are provided to define directives, assign and retrieve values, and to create accessor subroutines.

As this class will usually be subclassed to implement a reader for a specific style of configuration files, the user-oriented methods will be described first. Methods used to help implement a subclass are described later.

USER METHODS

  "directive($directive, [$parser, [$default, [$whence]]])"
Defines a directive named $directive for the configuration file. You may optionally specify a parsing function or method for the directive, and a default value.

If $directive is a simple string, it will be used as both the name of the directive inside of the program and in the configuration file. You can use an array ref of the form

     ['program-name', 'name1', 'name2', 'name3' ...]

to use 'program-name' inside of the program, but to recognize any of 'name1', 'name2', 'name3' as the name of directive in the configuration file.

A directive will be set to undef if you don't specify a default value and it is not set in the configuration file.

Any errors or warnings that occur while parsing the default value are normally reported as orginating in the caller's module. You can change the reported location by specifying $whence.

  "required($directive, [$parser, [$whence]])"
Defines a directive which must be specified in the configuration file.

  "ignore($directive, [$whence])"
Defines a directive which will be accepted but ignored in the configuration file.

  directives()
Returns an array of the configuration directive names.

  "value($directive, [$whence])"
Returns the value of the configuration directive $directive.

  "define_accessors([$package, [@names]])"
Creates subroutines in the caller's package to access configuration values. For example, if one of the configuration directives is named "Input_File", you can do:

    $config->define_accessors();
    ...

    open(IN, Input_File());

The names of the created subroutines is returned in an array. If you'd like to export the accessor subroutines, you can say:

    push @EXPORT, $config->define_accessors();

You can specify the package in which to create the subroutines with the optional $package argument. You may also specify which configuration directives to create accessor subroutines for. By default, subroutines will be created for all the directives.

IMPLEMENTATION METHODS
The following methods will probably be called by a subclass implementing a reader for a particular style of configuration files.

  new( [$spec] )
The static method new() creates and returns a new ConfigReader::Values object.

Unless the optional $spec argument is present, a new ConfigReader::Spec object will be created to store the configuration specification. The directive(), required(), ignore(), value(), and directive() methods described above are passed through to the spec object.

By setting $spec, you can use a different class (perhaps a subclass) to store the specification.

You can also set $spec if you want to use one specification for multiple sets of values. Files like /etc/termcap describe a configuration for multiple objects (terminals, in this case), but use the same directives to describe each object.

  values()
Returns the hash ref which actually stores the configuration directive values. The key of the hash ref is the directive name.

  spec()
Returns the internal spec object used to store the configuration specification.

  "assign($directive, $value_string, $whence)"
Normally called while reading the configuration file, assigns a value to the directive named $directive. The $value_string will be parsed by the directive's parsing function or method, if any. $whence should describe the line in the configuration file which contained the value string.

  assign_defaults($whence)
After the configuration file is read, the assign_defaults() method is called to assign the default values for directives which were not specified in the configuration file. $whence should describe the name of the configuration file.