Ioan Rogers > Prophet > Prophet::Config

Download:
Prophet-0.751.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  6
Open  2
View/Report Bugs
Module Version: 0.751   Source  

NAME ^

Prophet::Config - Prophet's configuration object

VERSION ^

version 0.751

SYNOPSIS ^

From, for example, a class that inherits from Prophet::App:

    has config => (
        is      => 'rw',
        isa     => 'Prophet::Config',
        default => sub {
            my $self = shift;
            return Prophet::Config->new(
                app_handle => $self,
                confname => 'prophetrc',
            );
        },
    );

DESCRIPTION ^

This class represents the configuration of Prophet and the application built on top of it. It's just an instance of Config::GitLike with a few small customizations and additions.

METHODS ^

aliases( $config_filename )

A convenience method that gets you a hash (or a hashref, depending on context) of all currently defined aliases. (Basically, every entry in the 'alias' section of the config file.)

If a filename is passed in, this method will only return the aliases that are defined in that particular config file.

sources

A convenience method that gets you a hash (or a hashref, depending on context) of all currently defined source replicas, in the format { 'name' => 'URL' }, or { 'URL' => 'name' } if the argument by_url is passed in.

replica_config_file

The replica-specific configuration file, or the configuration file given by PROPHET_APP_CONFIG if that environmental variable is set.

new( confname => 'prophetrc', app_handle => $instance_of_prophet_app )

Initialize the configuration. Does NOT load the config for you! You need to call load for that. The configuration will also load automatically the first time your prophet application tries to get a config variable.

Both constructor arguments are required.

CONFIG VARIABLES ^

The following config variables are currently used in various places in Prophet:

SEE ALSO ^

Most of the useful methods for getting and setting configuration variables actually come from Config::GitLike. See that module's documentation for details.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2009 by Best Practical Solutions.

This is free software, licensed under:

  The MIT (X11) License

BUGS AND LIMITATIONS ^

You can make new bug reports, and view existing ones, through the web interface at https://rt.cpan.org/Public/Dist/Display.html?Name=Prophet.

CONTRIBUTORS ^

syntax highlighting: