Config::Backend::File - a file backend for Config::Frontend.


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

Index


NAME

Top

Config::Backend::File - a file backend for Config::Frontend.

ABSTRACT

Top

Config::Backend::File is a file backend for Config::Frontend. It handles files with identifiers that are assigned values. The files can have comments.

Description

Top

Each call set() will immediately result in file to be rewritten.

The configuration file has following syntax:

  %# Head of the configuration file
  %variable=value
  %variable=mult
  line value with
  %% double percentage sign
  at the beginning of the line % indicating
  %%# (This is not a comment)
  a single escaped percentage sign.
  %# Comments start with %#.




new(filename) --> Config::Backend::File

Invoked with a valid filename, new will open the filename for reading and read in the configuration items. A configuration file will have the following form:

  %var = value
  %multiline=Hi there,
  This is a multiline, with a hundred,
  %% (percent) read 
  back.
  %test=1000.0

Notice that the percentage sign in a multiline config item will be doubled to distinguish it from config variables.

DESTROY()

This function will write back the configuration to file.

set(var,value) --> void

Sets config key var to value. Writes the config file right away.

get(var) --> string

Reads var from config. Returns undef, if var does not exist. Returns the value of configuration item var, otherwise.

del(var) --> void

Deletes var from the configuration file.

variables() --> list of strings

Returns all variables in the configuraton file.

SEE ALSO

Top

Config::Frontend.

AUTHOR

Top

Hans Oesterholt-Dijkema, <oesterhol@cpan.org>

COPYRIGHT AND LICENSE

Top


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