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=bb2a2013862a96664e4add663ae6338abc67d6d1;hp=c4717b48731dbeed03ffc5c9c4d707695b7c6691;hb=e7399d8baa841cb6525daa2c20d88f70ba42474c;hpb=7905feb37e16936e4acd2e21bf65815109b39620 diff --git a/lib/Catalyst/Component.pm b/lib/Catalyst/Component.pm index c4717b4..bb2a201 100644 --- a/lib/Catalyst/Component.pm +++ b/lib/Catalyst/Component.pm @@ -5,9 +5,11 @@ use Class::MOP; use Class::MOP::Object; use Catalyst::Utils; use Class::C3::Adopt::NEXT; +use Devel::InnerPackage (); use MRO::Compat; use mro 'c3'; use Scalar::Util 'blessed'; +use Class::Load 'is_class_loaded'; use namespace::clean -except => 'meta'; with 'MooseX::Emulate::Class::Accessor::Fast'; @@ -27,14 +29,18 @@ Catalyst::Component - Catalyst Component Base Class __PACKAGE__->config( foo => 'bar' ); + has foo => ( + is => 'ro', + ); + sub test { my $self = shift; - return $self->{foo}; + return $self->foo; } sub forward_to_me { my ( $self, $c ) = @_; - $c->response->output( $self->{foo} ); + $c->response->output( $self->foo ); } 1; @@ -45,16 +51,23 @@ Catalyst::Component - Catalyst Component Base Class # Or just methods print $c->comp('MyApp::Model::Something')->test; - print $c->comp('MyApp::Model::Something')->{foo}; + print $c->comp('MyApp::Model::Something')->foo; =head1 DESCRIPTION This is the universal base class for Catalyst components (Model/View/Controller). -It provides you with a generic new() for instantiation through Catalyst's +It provides you with a generic new() for component construction through Catalyst's component loader with config() support and a process() method placeholder. +B that calling C<< $self->config >> inside a component is strongly +not recommended - the correctly merged config should have already been +passed to the constructor and stored in attributes - accessing +the config accessor directly from an instance is likely to get the +wrong values (as it only holds the class wide config, not things loaded +from the config file!) + =cut __PACKAGE__->mk_classdata('_plugins'); @@ -81,11 +94,9 @@ sub BUILDARGS { } elsif (@_ == 2) { # is it ($app, $args) or foo => 'bar' ? if (blessed($_[0])) { $args = $_[1] if ref($_[1]) eq 'HASH'; - } elsif (Class::MOP::is_class_loaded($_[0]) && + } elsif (is_class_loaded($_[0]) && $_[0]->isa('Catalyst') && ref($_[1]) eq 'HASH') { $args = $_[1]; - } elsif ($_[0] == $_[1]) { - $args = $_[1]; } else { $args = +{ @_ }; } @@ -128,7 +139,7 @@ sub config { # TODO maybe this should be a ClassData option? my $class = blessed($self) || $self; my $meta = Class::MOP::get_metaclass_by_name($class); - unless ($meta->has_package_symbol('$_config')) { + unless (${ $meta->get_or_add_package_symbol('$_config') }) { # Call merge_hashes to ensure we deep copy the parent # config onto the subclass $self->_config( Catalyst::Utils::merge_hashes($config, {}) ); @@ -149,6 +160,11 @@ sub process { . " did not override Catalyst::Component::process" ); } +sub expand_modules { + my ($class, $component) = @_; + return Devel::InnerPackage::list_packages( $component ); +} + __PACKAGE__->meta->make_immutable; 1; @@ -166,7 +182,7 @@ to be stored in the application's component hash. C<< my $component_instance = $component->COMPONENT($app, $arguments); >> -If this method is present (as it is on all Catalyst::Component subclasses, +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 $app and any config entry on the application for this component (for example, in the case of MyApp::Controller::Foo this would be @@ -176,12 +192,12 @@ The arguments are expected to be a hashref and are merged with the C<< __PACKAGE__->config >> hashref before calling C<< ->new >> to instantiate the component. -You can override it in your components to do custom instantiation, using +You can override it in your components to do custom construction, using something like this: sub COMPONENT { my ($class, $app, $args) = @_; - $args = $self->merge_config_hashes($self->config, $args); + $args = $class->merge_config_hashes($class->config, $args); return $class->new($app, $args); } @@ -196,6 +212,12 @@ 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 its own config hash. +The component's config hash is merged with any config entry on the +application for this component and passed to C (as mentioned +above at L). The recommended practice to access the merged +config is to use a Moose attribute for each config entry on the +receiving component. + =head2 $c->process() This is the default method called on a Catalyst component in the dispatcher. @@ -207,6 +229,13 @@ when you forward to them. The default is an abstract method. Merges two hashes together recursively, giving right-hand precedence. Alias for the method in L. +=head2 $c->expand_modules( $setup_component_config ) + +Return a list of extra components that this component has created. By default, +it just looks for a list of inner packages of this component + +=cut + =head1 OPTIONAL METHODS =head2 ACCEPT_CONTEXT($c, @args)