X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FComponent.pm;h=4b12fdab40932773a3a4addc2d8c79888862bec8;hb=d030cb977237ba7fa728eb00ab9c679388af3281;hp=feab1cf8a59684c2c71168c6e01620716cb5f6b6;hpb=22247e54ccd3fbdaf286e77304b96e61ecc43a0f;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index feab1cf..4b12fda 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -4,7 +4,7 @@ use strict; 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 @@ -49,7 +49,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 @@ -62,7 +65,15 @@ sub new { return $self->NEXT::new( { %{ $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 @@ -100,14 +111,15 @@ 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; - } + $config = { %{$config}, %{@_ > 1 ? {@_} : $_[0]} }; + $self->_config($config); } - return $self->_config; + return $config; } =head2 $c->process() @@ -120,6 +132,20 @@ sub process { . " did not override Catalyst::Component::process" ); } +=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.