# you can specify a file if you'd like
__PACKAGE__->config( 'Plugin::ConfigLoader' => { file => 'config.yaml' } );
- In the file, assuming it's in YAML format:
+In the file, assuming it's in YAML format:
foo: bar
- Accessible through the context object, or the class itself
+Accessible through the context object, or the class itself
- $c->config->{foo} # bar
- MyApp->config->{foo} # bar
+ $c->config->{foo} # bar
+ MyApp->config->{foo} # bar
=head1 DESCRIPTION
This module will attempt to load find and load a configuration
file of various types. Currently it supports YAML, JSON, XML,
INI and Perl formats. Special configuration for a particular driver format can
-be stored in C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ driver }>.
+be stored in C<< MyApp->config->{ 'Plugin::ConfigLoader' }->{ driver } >>.
For example, to pass arguments to L<Config::General>, use the following:
__PACKAGE__->config( 'Plugin::ConfigLoader' => {
See L<Config::Any>'s C<driver_args> parameter for more information.
To support the distinction between development and production environments,
-this module will also attemp to load a local config (e.g. myapp_local.yaml)
+this module will also attemp to load a local config (e.g. F<myapp_local.yaml>)
which will override any duplicate settings. See
-L<get_config_local_suffix|/get_config_local_suffix>
+L</get_config_local_suffix>
for details on how this is configured.
=head1 METHODS
This method determines the potential file paths to be used for config loading.
It returns an array of paths (up to the filename less the extension) to pass to
-L<Config::Any|Config::Any> for loading.
+L<Config::Any> for loading.
=cut
=item * C<$ENV{ CATALYST_CONFIG }>
-=item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ file }>
+=item * C<< $c->config->{ 'Plugin::ConfigLoader' }->{ file } >>
-=item * C<$c-E<gt>path_to( $application_prefix )>
+=item * C<< $c->path_to( $application_prefix ) >>
=back
=item * C<$ENV{ CATALYST_CONFIG_LOCAL_SUFFIX }>
-=item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ config_local_suffix }>
+=item * C<< $c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix } >>
=back
name of the local config file to be loaded.
For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>,
-ConfigLoader will try and load C<myapp_testing.conf> instead of
-C<myapp_local.conf>.
+ConfigLoader will try and load F<myapp_testing.conf> instead of
+F<myapp_local.conf>.
=cut
used to implement tuning of config values that can only be done
at runtime. If you need to do this to properly configure any
plugins, it's important to load ConfigLoader before them.
-ConfigLoader provides a default finalize_config method which
-walks through the loaded config hash and calls the C<config_substitutions>
-sub on any string.
+ConfigLoader provides a default C<finalize_config> method which
+walks through the loaded config hash and calls the
+L<config_substitutions|/config_substitutions( $value )> method on any string.
=cut
The parameter list is split on comma (C<,>). You can override this method to
do your own string munging, or you can define your own macros in
-C<MyApp-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ substitutions }>.
+C<< MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } >>.
Example:
MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
=head1 AUTHOR
-Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+Brian Cassidy <bricas@cpan.org>
=head1 CONTRIBUTORS
=over 4
-=item * Joel Bernstein E<lt>rataxis@cpan.orgE<gt> - Rewrite to use L<Config::Any>
+=item * Joel Bernstein <rataxis@cpan.org> - Rewrite to use L<Config::Any>
-=item * David Kamholz E<lt>dkamholz@cpan.orgE<gt> - L<Data::Visitor> integration
+=item * David Kamholz <dkamholz@cpan.org> - L<Data::Visitor> integration
=item * Stuart Watt - Addition of ENV macro.
-
=head1 NAME
Catalyst::Plugin::ConfigLoader::Manual - Guide to using the ConfigLoader plugin
=head1 BASIC USAGE
package MyApp;
-
+
use Catalyst qw( ConfigLoader ... );
=head1 ENVIRONMENT VARIABLES
=head3 Example Config
name=TestApp
-
+
[Controller::Foo]
foo=bar
-
+
[Model::Baz]
qux=xyzzy
=head3 Example Config
- <config>
+ <config>
<name>MyApp::CMS</name>
<paths>
- <upload_dir>/var/www/docs/myapp-cms/uploads</upload_dir>
+ <upload_dir>/var/www/docs/myapp-cms/uploads</upload_dir>
</paths>
<model name="DB">
- <connect_info>dbi:mysql:cmsdb</connect_info>
- <connect_info>user</connect_info>
- <connect_info>password</connect_info>
+ <connect_info>dbi:mysql:cmsdb</connect_info>
+ <connect_info>user</connect_info>
+ <connect_info>password</connect_info>
</model>
<component name="View::TT">
- <INCLUDE_PATH>__path_to(root,templates)__</INCLUDE_PATH>
- <ENCODING>UTF-8</ENCODING>
- <TRIM>1</TRIM>
- <PRE_CHOMP>2</PRE_CHOMP>
- <POST_CHOMP>2</POST_CHOMP>
+ <INCLUDE_PATH>__path_to(root,templates)__</INCLUDE_PATH>
+ <ENCODING>UTF-8</ENCODING>
+ <TRIM>1</TRIM>
+ <PRE_CHOMP>2</PRE_CHOMP>
+ <POST_CHOMP>2</POST_CHOMP>
</component>
-
- </config>
+ </config>
Note that the name attribute for the C<model> tag should be the relative
namespace of the Catalyst model, not the absolute one. That is for
=head2 Configuring a Catalyst::Model::DBIC::Schema model from a YAML config
Model::MyModel:
- schema_class: MyApp::MySchema
- connect_info:
- - dbi:SQLite:myapp.db
- - ''
- - ''
- - AutoCommit: 1
+ schema_class: MyApp::MySchema
+ connect_info:
+ - dbi:SQLite:myapp.db
+ - ''
+ - ''
+ - AutoCommit: 1
=head2 Converting your existing config to Config::General format
When ConfigLoader reads configurations, it starts by reading the configuration
file for C<myapp> with one of the supported extensions as listed
-L<above|/Config Formats>.
+L<above|/CONFIG FORMATS>.
-For example, A L<Config::General> config file is C<myapp.conf>.
+For example, A L<Config::General> config file is F<myapp.conf>.
If a configuration file called C<myapp_local> exists with one of the supported
file extensions, it will also be read, and values from that file will
override values from the main config file.
A L<Config::General> local configuration file would be called
-C<myapp_local.conf>.
+F<myapp_local.conf>.
The C<local> suffix can be changed. See
L<Catalyst::Plugin::ConfigLoader/get_config_local_suffix> for the details of
This is useful because it allows different people or environments to have
different configuration files. A project with three developers,
I<Tom>, I<Dick>, and I<Harry> as well as a production environment can have
-a C<myapp_tom.conf>, a C<myapp_dick.conf>, a C<myapp_harry.conf>, and a
-C<myapp_production.conf>.
+a F<myapp_tom.conf>, a F<myapp_dick.conf>, a F<myapp_harry.conf>, and a
+F<myapp_production.conf>.
Each developer, and the web server, would set the environment variable
to load their proper configuration file. All of the configurations can
be stored properly in source control.
-If there is no C<myapp_local.ext> (where .ext is a supported extension), and
+If there is no F<myapp_local.ext> (where C<.ext> is a supported extension), and
the individual configuration files contain something required to start the
application, such as the Model's data source definition, the applicaton won't
start unless the environment variable is set properly.
=cut
-
projects / catagits/Catalyst-Plugin-ConfigLoader.git / commitdiff