X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=116aa9ad8dab10a71f01adf705a69f49d0f6502a;hp=339cab8994a43c350dc3f31231f62952a7b622d4;hb=e8b9f2a92084b3b9dab6b2b879900481b8548b3b;hpb=e7f1cf73b4e0e5863e901aaa0e6bda2e39bd0edc diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index 339cab8..116aa9a 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -3,8 +3,8 @@ 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/; =head1 NAME @@ -41,19 +41,17 @@ Catalyst::Component - Catalyst Component Base Class =head1 DESCRIPTION -This is the universal base class for Catalyst components +This is the universal base class for Catalyst components (Model/View/Controller). It provides you with a generic new() for instantiation through Catalyst's component loader with config() support and a process() method placeholder. -=head1 METHODS +=cut -=over 4 +__PACKAGE__->mk_classdata($_) for qw/_config _plugins/; -=item new($c) -=cut sub new { my ( $self, $c ) = @_; @@ -61,35 +59,66 @@ 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 - -=item $c->config - -=item $c->config($hashref) +sub COMPONENT { + my ( $self, $c ) = @_; -=item $c->config($key, $value, ...) + # Temporary fix, some components does not pass context to constructor + my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {}; -=cut + 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; + } + } +} sub config { my $self = shift; - $self->_config( {} ) unless $self->_config; + my $config_sub = $self->can('_config'); + my $config = $self->$config_sub() || {}; 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 ) + ); + } else { + # this is a bit of a kludge, required to make + # __PACKAGE__->config->{foo} = 'bar'; + # work in a subclass. Calling the Class::Data::Inheritable setter + # will create a new _config method in the current class if it's + # currently inherited from the superclass. So, the can() call will + # return a different subref in that case and that means we know to + # copy and reset the value stored in the class data. + + $self->_config( $config ); + + if ((my $config_sub_now = $self->can('_config')) ne $config_sub) { + + $config = $self->merge_config_hashes( $config, {} ); + $self->$config_sub_now( $config ); } } - return $self->_config; + return $config; } -=item $c->process() +sub merge_config_hashes { + my ( $self, $lefthash, $righthash ) = @_; -=cut + return Catalyst::Utils::merge_hashes( $lefthash, $righthash ); +} sub process { @@ -97,7 +126,62 @@ sub process { . " did not override Catalyst::Component::process" ); } -=back +1; + +__END__ + +=head1 METHODS + +=head2 new($c, $arguments) + +Called by COMPONENT to instantiate the component; should return an object +to be stored in the application's component hash. + +=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. + +=head2 $c->config + +=head2 $c->config($hashref) + +=head2 $c->config($key, $value, ...) + +Accessor for this component's config hash. Config values can be set as +key value pair, or you can specify a hashref. In either case the keys +will be merged with any existing config settings. Each component in +a Catalyst application has it's own config hash. + +=head2 $c->process() + +This is the default method called on a Catalyst component in the dispatcher. +For instance, Views implement this action to render the response body +when you forward to them. The default is an abstract method. + +=head2 $c->merge_config_hashes( $hashref, $hashref ) + +Merges two hashes together recursively, giving right-hand precedence. +Alias for the method in L. + +=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 @@ -115,5 +199,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;