3 <TITLE>FS::Conf - Read access to Freeside configuration values</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#methods">METHODS</A></LI>
18 <LI><A HREF="#bugs">BUGS</A></LI>
19 <LI><A HREF="#see also">SEE ALSO</A></LI>
25 <H1><A NAME="name">NAME</A></H1>
26 <P>FS::Conf - Read access to Freeside configuration values</P>
29 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
33 $conf = new FS::Conf "/config/directory";</PRE>
35 $FS::Conf::default_dir = "/config/directory";
36 $conf = new FS::Conf;</PRE>
38 $dir = $conf->dir;</PRE>
40 $value = $conf->config('key');
41 @list = $conf->config('key');
42 $bool = $conf->exists('key');</PRE>
45 <H1><A NAME="description">DESCRIPTION</A></H1>
46 <P>Read access to Freeside configuration values. Keys currently map to filenames,
47 but this may change in the future.</P>
50 <H1><A NAME="methods">METHODS</A></H1>
52 <DT><STRONG><A NAME="item_new_%5B_DIRECTORY_%5D">new [ DIRECTORY ]</A></STRONG><BR>
54 Create a new configuration object. A directory arguement is required if
55 $FS::Conf::default_dir has not been set.
57 <DT><STRONG><A NAME="item_dir">dir</A></STRONG><BR>
59 Returns the directory.
61 <DT><STRONG><A NAME="item_config">config</A></STRONG><BR>
63 Returns the configuration value or values (depending on context) for key.
65 <DT><STRONG><A NAME="item_exists">exists</A></STRONG><BR>
67 Returns true if the specified key exists, even if the corresponding value
72 <H1><A NAME="bugs">BUGS</A></H1>
73 <P>Write access (with locking) should be implemented.</P>
76 <H1><A NAME="see also">SEE ALSO</A></H1>
77 <P>config.html from the base documentation contains a list of configuration files.</P>