X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=d4cf7e59f768e96d70bc1a1619a1bc602c1c6da4;hb=264bac8c94a84d7dbac9912946d1a639fa37d1cd;hp=38e87aafcfa16b9282d8e1625089c04543702df8;hpb=b5ecfcf07b8ffe7e9984f0279c8781ce51c6ac6a;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 38e87aa..d4cf7e5 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -3,8 +3,9 @@ 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/; +__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; =head1 NAME @@ -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,7 +63,40 @@ 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, $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 + +sub COMPONENT { + my ( $self, $c ) = @_; + + # Temporary fix, some components does not pass context to constructor + my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; + + if ( my $new = $self->NEXT::COMPONENT( $c, $arguments ) ) { + return $new; + } + else { + if ( my $new = $self->new( $c, $arguments ) ) { + return $new; + } + else { + my $class = ref $self || $self; + my $new = $self->merge_config_hashes( $self->config, $arguments ); + return bless $new, $class; + } + } } # remember to leave blank lines between the consecutive =head2's @@ -75,14 +112,17 @@ sub new { 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() @@ -95,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, L, L, L.