bob walker > OpenGuides > OpenGuides::Config

Download:
OpenGuides-0.76.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.09   Source  

NAME ^

OpenGuides::Config - Handle OpenGuides configuration variables.

DESCRIPTION ^

Does config stuff for OpenGuides. Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.

METHODS ^

new
  my $config = OpenGuides::Config->new( file => "wiki.conf" );

Initialises itself from the config file specified. Variables which are not set in that file, and which have sensible defaults, will be initialised as described below in ACCESSORS; others will be given a value of undef.

  my $config = OpenGuides::Config->new( vars => { dbname => "foo" } );

As above but gets variables from a supplied hashref instead.

ACCESSORS ^

Each of the accessors described below is read-write. Additionally, for each of them, there is also a read-write accessor called, for example, dbname__qu. This will contain an English-language question suitable for asking for a value for that variable. You shouldn't write to them, but this is not enforced.

The defaults mentioned below are those which are applied when ->new is called, to variables which are not supplied in the config file.

AUTHOR ^

The OpenGuides Project (openguides-dev@lists.openguides.org)

COPYRIGHT ^

     Copyright (C) 2004-2013 The OpenGuides Project.  All Rights Reserved.

The OpenGuides distribution is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

OpenGuides

syntax highlighting: