Daisuke Maki > Pickles > Pickles::Config

Download:
Pickles-0.10.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Pickles::Config - Config Object

SYNOPSIS ^

    use MyApp::Config;
    my $config = MyApp::Config->construct;
    my $component = $config->get( $component_name );
    my $path = $config->path_to( $subpath, ... );

METHODS ^

Class->new([ files => \@files, home => $home ]);

create new config object.

files => \@files

specify the config files. if relative paths are specified, convert to absolute path from application home.

home => $home

specify the application home directory.

Class->construct;

returns a config object which is based on predefined rules and ENV values. see CONSTRUCT RULES section.

$config->home

returns a application home dir's Path::Class::Dir object.

$config->get( $name, [$default_value] )

get config value.

$config->path_to( @path )

construct absolute path from application home.

CONSTRUCT RULES ^

following files and env values are used in construct.

etc/config.pl

This file is always read, and will be read first. Use it to populate sane defaults for your app

config.pl

This file is read after etc/config.pl, and is read only for backwards compatibility. THIS FEATURE WILL BE REMOVED IN THE FUTURE.

MYAPP_ENV

If you set the environment variable MYAPP_ENV, Pickles will go and read a config file named using that term. For example, if you set MYAPP_ENV to be 'test', then it Pickles will attemp to read 'config_test.pl'.

NOTE: The name 'MYAPP_ENV' should be changed according to your app name. For example, If you built a Pickles app named Foo::Bar, then the environment variable that you want to set is FOO_BAR_ENV, not MYAPP_ENV

NOTE: The filename that this environment affects also dependson the value of MYAPP_CONFIG. See below.

MYAPP_CONFIG

If you set the environment variable MYAPP_CONFIG, Pickles will go and read that file. Use this to specify an alternate config file.

NOTE: The name 'MYAPP_CONFIG' should be changed according to your app name. For example, If you built a Pickles app named Foo::Bar, then the environment variable that you want to set is FOO_BAR_CONFIG, not MYAPP_CONFIG

This value is subsequently use in the MYAPP_ENV. For example, if you set MYAPP_CONFIG to be 'foo.pl', then setting MYAPP_ENV to 'test' will trigger Pickles to read foo_test.pl, not config_test.pl

syntax highlighting: