3 <TITLE>FS::Conf - Read access to Freeside configuration values</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#BUGS">BUGS</A>
18 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
24 <H1><A NAME="NAME">NAME</A></H1>
26 FS::Conf - Read access to Freeside configuration values
30 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
35 <PRE> $conf = new FS::Conf "/config/directory";
38 <PRE> $FS::Conf::default_dir = "/config/directory";
42 <PRE> $dir = $conf->dir;
45 <PRE> $value = $conf->config('key');
46 @list = $conf->config('key');
47 $bool = $conf->exists('key');
51 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
53 Read access to Freeside configuration values. Keys currently map to
54 filenames, but this may change in the future.
58 <H1><A NAME="METHODS">METHODS</A></H1>
60 <DT><STRONG><A NAME="item_new">new [ DIRECTORY ]</A></STRONG><DD>
62 Create a new configuration object. A directory arguement is required if
63 $FS::Conf::default_dir has not been set.
65 <DT><STRONG><A NAME="item_dir">dir</A></STRONG><DD>
67 Returns the directory.
69 <DT><STRONG><A NAME="item_config">config</A></STRONG><DD>
71 Returns the configuration value or values (depending on context) for key.
73 <DT><STRONG><A NAME="item_exists">exists</A></STRONG><DD>
75 Returns true if the specified key exists, even if the corresponding value
81 <H1><A NAME="BUGS">BUGS</A></H1>
83 Write access (with locking) should be implemented.
87 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
89 config.html from the base documentation contains a list of configuration