htdocs/docs/man/Conf.txt

   1 NAME
   2     FS::Conf - Read access to Freeside configuration values
   3
   4 SYNOPSIS
   5       use FS::Conf;
   6
   7       $conf = new FS::Conf;
   8       $conf = new FS::Conf "/non/standard/config/directory";
   9
  10       $dir = $conf->dir;
  11
  12       $value = $conf->config('key');
  13       @list  = $conf->config('key');
  14       $bool  = $conf->exists('key');
  15
  16 DESCRIPTION
  17     Read access to Freeside configuration values. Keys currently map
  18     to filenames, but this may change in the future.
  19
  20 METHODS
  21     new [ DIRECTORY ]
  22         Create a new configuration object. Optionally, a non-default
  23         directory may be specified.
  24
  25     dir Returns the directory.
  26
  27     config
  28         Returns the configuration value or values (depending on
  29         context) for key.
  30
  31     exists
  32         Returns true if the specified key exists, even if the
  33         corresponding value is undefined.
  34
  35 BUGS
  36     The option to specify a non-default directory should probably be
  37     removed.
  38
  39     Write access (with locking) should be implemented.
  40
  41 SEE ALSO
  42     config.html from the base documentation contains a list of
  43     configuration files.
  44
  45 HISTORY
  46     Ivan Kohler <ivan@sisd.com> 98-sep-6
  47
  48     sub exists forgot to fetch $dir ivan@sisd.com 98-sep-27
  49