X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=b38361e2daa9c4951070fa454a4ca0e1bde95cf2;hb=8a6a6581d48a3c1c4d5f631cdb7cbda336c0e5e2;hp=097af41fe9a18adaa208589ad0e45abb01eb40f3;hpb=158c88c0db581dcee202cd854c77186590c2992c;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 097af41..b38361e 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -1,10 +1,10 @@ package Catalyst::Component; use strict; -use base qw/Class::Data::Inheritable/; +use base qw/Class::Accessor::Fast Class::Data::Inheritable/; use NEXT; -__PACKAGE__->mk_classdata($_) for qw/_config/; +__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; =head1 NAME @@ -15,7 +15,7 @@ Catalyst::Component - Catalyst Component Base Class # lib/MyApp/Model/Something.pm package MyApp::Model::Something; - use base 'Catalyst::Base'; + use base 'Catalyst::Component'; __PACKAGE__->config( foo => 'bar' ); @@ -49,9 +49,10 @@ component loader with config() support and a process() method placeholder. =head1 METHODS -=over 4 +=head2 new($c, $arguments) -=item new($c) +Called by COMPONENT to instantiate the component; should return an object +to be stored in the application's component hash. =cut @@ -61,33 +62,69 @@ 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 ) ); } -# remember to leave blank lines between the consecutive =item's -# otherwise the pod tools don't recognize the subsequent =items +=head2 COMPONENT($c, $arguments) -=item $c->config +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. -=item $c->config($hashref) +=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 +# otherwise the pod tools don't recognize the subsequent =head2s + +=head2 $c->config + +=head2 $c->config($hashref) -=item $c->config($key, $value, ...) +=head2 $c->config($key, $value, ...) =cut 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; } -=item $c->process() +=head2 $c->process() =cut @@ -97,11 +134,49 @@ sub process { . " did not override Catalyst::Component::process" ); } -=back +=head2 $c->merge_hash_config( $hashref, $hashref ) + +Merges two hashes together recursively, giving right-hand precedence. + +=cut + +sub merge_config_hashes { + my ( $self, $lefthash, $righthash ) = @_; + + my %merged = %$lefthash; + for my $key ( keys %$righthash ) { + my $right_ref = ( ref $righthash->{ $key } || '' ) eq 'HASH'; + my $left_ref = ( ( exists $lefthash->{ $key } && ref $lefthash->{ $key } ) || '' ) eq 'HASH'; + if( $right_ref and $left_ref ) { + $merged{ $key } = $self->merge_config_hashes( + $lefthash->{ $key }, $righthash->{ $key } + ); + } + else { + $merged{ $key } = $righthash->{ $key }; + } + } + + return \%merged; +} + +=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, L. =head1 AUTHOR