document $c->detach with no args

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Component.pm

diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm
index da40d5c..d4cf7e5 100644 (file)
--- a/lib/Catalyst/Component.pm
+++ b/lib/Catalyst/Component.pm
@@ -3,6 +3,7 @@ package Catalyst::Component;
 use strict;
 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
 use NEXT;
+use Catalyst::Utils;
 
 __PACKAGE__->mk_classdata($_) for qw/_config _plugins/;
 
@@ -49,7 +50,10 @@ component loader with config() support and a process() method placeholder.
 
 =head1 METHODS
 
-=head2 new($c)
+=head2 new($c, $arguments)
+
+Called by COMPONENT to instantiate the component; should return an object
+to be stored in the application's component hash.
 
 =cut
 
@@ -59,10 +63,18 @@ sub new {
     # Temporary fix, some components does not pass context to constructor
     my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
 
-    return $self->NEXT::new( { %{ $self->config }, %{$arguments} } );
+    return $self->NEXT::new( $self->merge_config_hashes( $self->config, $arguments ) );
 }
 
-=head2 COMPONENT($c)
+=head2 COMPONENT($c, $arguments)
+
+If this method is present (as it is on all Catalyst::Component subclasses,
+it is called by Catalyst during setup_components with the application class
+as $c and any config entry on the application for this component (for example,
+in the case of MyApp::Controller::Foo this would be
+MyApp->config->{'Controller::Foo'}). The arguments are expected to be a hashref
+and are merged with the __PACKAGE__->config hashref before calling ->new to
+instantiate the component.
 
 =cut
 
@@ -81,7 +93,7 @@ sub COMPONENT {
         }
         else {
             my $class = ref $self || $self;
-            my $new = { %{ $self->config }, %{$arguments} };
+            my $new   = $self->merge_config_hashes( $self->config, $arguments );
             return bless $new, $class;
         }
     }
@@ -100,14 +112,17 @@ sub COMPONENT {
 
 sub config {
     my $self = shift;
-    $self->_config( {} ) unless $self->_config;
+    my $config = $self->_config;
+    unless ($config) {
+        $self->_config( $config = {} );
+    }
     if (@_) {
-        my $config = @_ > 1 ? {@_} : $_[0];
-        while ( my ( $key, $val ) = each %$config ) {
-            $self->_config->{$key} = $val;
-        }
+        my $newconfig = { %{@_ > 1 ? {@_} : $_[0]} };
+        $self->_config(
+            $self->merge_config_hashes( $config, $newconfig )
+        );
     }
-    return $self->_config;
+    return $config;
 }
 
 =head2 $c->process()
@@ -120,6 +135,32 @@ sub process {
           . " did not override Catalyst::Component::process" );
 }
 
+=head2 $c->merge_config_hashes( $hashref, $hashref )
+
+Merges two hashes together recursively, giving right-hand precedence.
+
+=cut
+
+sub merge_config_hashes {
+    my ( $self, $lefthash, $righthash ) = @_;
+
+    return Catalyst::Utils::merge_hashes( $lefthash, $righthash );
+}
+
+=head1 OPTIONAL METHODS
+
+=head2 ACCEPT_CONTEXT($c, @args)
+
+Catalyst components are normally initalized during server startup, either
+as a Class or a Instance. However, some components require information about
+the current request. To do so, they can implement an ACCEPT_CONTEXT method.
+
+If this method is present, it is called during $c->comp/controller/model/view
+with the current $c and any additional args (e.g. $c->model('Foo', qw/bar baz/)
+would cause your MyApp::Model::Foo instance's ACCEPT_CONTEXT to be called with
+($c, 'bar', 'baz')) and the return value of this method is returned to the
+calling code in the application rather than the component itself.
+
 =head1 SEE ALSO
 
 L<Catalyst>, L<Catalyst::Model>, L<Catalyst::View>, L<Catalyst::Controller>.