use NEXT;
use Catalyst::Utils;
-__PACKAGE__->mk_classdata($_) for qw/_config _plugins/;
=head1 NAME
=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
-=head2 new($c, $arguments)
+__PACKAGE__->mk_classdata($_) for qw/_config _plugins/;
-Called by COMPONENT to instantiate the component; should return an object
-to be stored in the application's component hash.
-=cut
sub new {
my ( $self, $c ) = @_;
# Temporary fix, some components does not pass context to constructor
my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
- return $self->NEXT::new( $self->merge_config_hashes( $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 ) = @_;
}
else {
my $class = ref $self || $self;
- my $new = $self->merge_config_hashes( $self->config, $arguments );
+ 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)
-
-=head2 $c->config($key, $value, ...)
-
-=cut
-
sub config {
my $self = shift;
- my $config = $self->_config;
- unless ($config) {
- $self->_config( $config = {} );
- }
+ my $config_sub = $self->can('_config');
+ my $config = $self->$config_sub() || {};
if (@_) {
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 $config;
}
-=head2 $c->process()
+sub merge_config_hashes {
+ my ( $self, $lefthash, $righthash ) = @_;
-=cut
+ return Catalyst::Utils::merge_hashes( $lefthash, $righthash );
+}
sub process {
. " did not override Catalyst::Component::process" );
}
-=head2 $c->merge_config_hashes( $hashref, $hashref )
+1;
-Merges two hashes together recursively, giving right-hand precedence.
+__END__
-=cut
+=head1 METHODS
-sub merge_config_hashes {
- my ( $self, $lefthash, $righthash ) = @_;
+=head2 new($c, $arguments)
- return Catalyst::Utils::merge_hashes( $lefthash, $righthash );
-}
+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<Catalyst::Utils>.
=head1 OPTIONAL METHODS
the same terms as Perl itself.
=cut
-
-1;