From: André Walker Date: Fri, 29 Jul 2011 20:56:59 +0000 (-0300) Subject: documenting Container. removed pod for private methods X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=bbb306a9630de32362823ccc0138fdb17adb520b documenting Container. removed pod for private methods --- diff --git a/lib/Catalyst/IOC/Container.pm b/lib/Catalyst/IOC/Container.pm index ebffb92..994998c 100644 --- a/lib/Catalyst/IOC/Container.pm +++ b/lib/Catalyst/IOC/Container.pm @@ -681,7 +681,7 @@ Catalyst::Container - IOC for Catalyst components =head1 METHODS -=head1 Containers +=head1 Building Containers =head2 build_model_subcontainer @@ -695,7 +695,7 @@ Container that stores all views. Container that stores all controllers. -=head1 Services +=head1 Building Services =head2 build_application_name_service @@ -711,28 +711,78 @@ Config options passed directly to the driver being used. =head2 build_substitutions_service -Executes all the substitutions in config. See L method. +This method substitutes macros found with calls to a function. There are a +number of default macros: + +=over + +=item * C<__HOME__> - replaced with C<$c-Epath_to('')> + +=item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}> + +=item * C<__path_to(foo/bar)__> - replaced with C<$c-Epath_to('foo/bar')> + +=item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use +C<__DATA__> as a config value, for example) + +=back + +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 +Cconfig-E{ 'Plugin::ConfigLoader' }-E{ substitutions }>. +Example: + + MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { + baz => sub { my $c = shift; qux( @_ ); } + } + +The above will respond to C<__baz(x,y)__> in config strings. =head2 build_extensions_service +Config::Any's available config file extensions (e.g. xml, json, pl, etc). + =head2 build_prefix_service +The prefix, based on the application name, that will be used to lookup the +config files (which will be in the format $prefix.$extension). If the app is +MyApp::Foo, the prefix will be myapp_foo. + =head2 build_path_service +The path to the config file (or environment variable, if defined). + =head2 build_config_service +The resulting configuration for the application, after it has successfully +been loaded, and all substitutions have been made. + =head2 build_raw_config_service +The merge of local_config and global_config hashes, before substitutions. + =head2 build_global_files_service +Gets all files for config that don't have the local_suffix, such as myapp.conf. + =head2 build_local_files_service +Gets all files for config that have the local_suffix, such as myapp_local.conf. + =head2 build_global_config_service +Reads config from global_files. + =head2 build_local_config_service +Reads config from local_files. + =head2 build_config_path_service +Splits the path to the config file, and returns on array ref containing +the path to the config file minus the extension in the first position, +and the extension in the second. + =head2 build_config_local_suffix_service Determines the suffix of files used to override the main config. By default @@ -754,6 +804,16 @@ For example, if C< $ENV{ MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C, ConfigLoader will try and load C instead of C. +=head2 build_locate_components_service + +This method is meant to provide a list of component modules that should be +setup for the application. By default, it will use L. + +Specify a C config option to pass additional options directly +to L. + +=head1 Other methods + =head2 get_component_from_sub_container($sub_container, $name, $c, @args) Looks for components in a given subcontainer (such as controller, model or view), and returns the searched component. If $name is undef, it returns the default component (such as default_view, if $sub_container is 'view'). If $name is a regexp, it returns an array of matching components. Otherwise, it looks for the component with name $name. @@ -776,50 +836,11 @@ Searches for components in all containers. If $component is the full class name, Finds components that match a given regexp. Used internally, by find_component. -=head2 _fix_syntax - -=head2 _config_substitutions - -This method substitutes macros found with calls to a function. There are a -number of default macros: - -=over - -=item * C<__HOME__> - replaced with C<$c-Epath_to('')> - -=item * C<__ENV(foo)__> - replaced with the value of C<$ENV{foo}> - -=item * C<__path_to(foo/bar)__> - replaced with C<$c-Epath_to('foo/bar')> - -=item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use -C<__DATA__> as a config value, for example) - -=back - -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 -Cconfig-E{ 'Plugin::ConfigLoader' }-E{ substitutions }>. -Example: - - MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { - baz => sub { my $c = shift; qux( @_ ); } - } - -The above will respond to C<__baz(x,y)__> in config strings. - =head2 $c->expand_component_module( $component, $setup_component_config ) Components found by C will be passed to this method, which is expected to return a list of component (package) names to be set up. -=head2 build_locate_components_service - -This method is meant to provide a list of component modules that should be -setup for the application. By default, it will use L. - -Specify a C config option to pass additional options directly -to L. - =head2 setup_components =head1 AUTHORS