use Moose;
use Class::MOP;
-use MooseX::Adopt::Class::Accessor::Fast;
+use Class::MOP::Object;
use Catalyst::Utils;
use Class::C3::Adopt::NEXT;
use MRO::Compat;
use mro 'c3';
+use Scalar::Util 'blessed';
+use namespace::clean -except => 'meta';
with 'MooseX::Emulate::Class::Accessor::Fast';
with 'Catalyst::ClassData';
my ( $self, $c ) = @_;
$c->response->output( $self->{foo} );
}
-
+
1;
# Methods can be a request step
=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
__PACKAGE__->mk_classdata('_plugins');
__PACKAGE__->mk_classdata('_config');
+has _component_name => ( is => 'ro' );
+
sub BUILDARGS {
- my ($self) = @_;
-
- # Temporary fix, some components does not pass context to constructor
- my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
+ my $class = shift;
+ my $args = {};
+
+ if (@_ == 1) {
+ $args = $_[0] if ref($_[0]) eq 'HASH';
+ } 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]) &&
+ $_[0]->isa('Catalyst') && ref($_[1]) eq 'HASH') {
+ $args = $_[1];
+ } elsif ($_[0] == $_[1]) {
+ $args = $_[1];
+ } else {
+ $args = +{ @_ };
+ }
+ } elsif (@_ % 2 == 0) {
+ $args = +{ @_ };
+ }
- my $args = $self->merge_config_hashes( $self->config, $arguments );
-
- return $args;
+ return $class->merge_config_hashes( $class->config, $args );
}
sub COMPONENT {
- my ( $self, $c ) = @_;
+ my ( $class, $c ) = @_;
# Temporary fix, some components does not pass context to constructor
my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
- if( my $next = $self->next::can ){
- my $class = blessed $self || $self;
+ if ( my $next = $class->next::can ) {
my ($next_package) = Class::MOP::get_code_info($next);
- warn "There is a COMPONENT method resolving after Catalyst::Component in ${next_package}. This behavior is deprecated and will stop working in future releases.";
- return $next->($self, $arguments);
+ warn "There is a COMPONENT method resolving after Catalyst::Component in ${next_package}.\n";
+ warn "This behavior can no longer be supported, and so your application is probably broken.\n";
+ warn "Your linearized isa hierarchy is: " . join(', ', @{ mro::get_linear_isa($class) }) . "\n";
+ warn "Please see perldoc Catalyst::Upgrading for more information about this issue.\n";
}
- return $self->new($c, $arguments);
+ return $class->new($c, $arguments);
}
sub config {
} else {
# this is a bit of a kludge, required to make
# __PACKAGE__->config->{foo} = 'bar';
- # work in a subclass. If we don't have the package symbol in the
- # current class we know we need to copy up to ours, which calling
- # the setter will do for us.
-
- unless ($self->meta->has_package_symbol('$_config')) {
-
- $config = $self->merge_config_hashes( $config, {} );
- $self->_config( $config );
+ # work in a subclass.
+ # 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')) {
+ # Call merge_hashes to ensure we deep copy the parent
+ # config onto the subclass
+ $self->_config( Catalyst::Utils::merge_hashes($config, {}) );
}
}
- return $config;
+ return $self->_config;
}
sub merge_config_hashes {
. " did not override Catalyst::Component::process" );
}
-no Moose;
-
__PACKAGE__->meta->make_immutable;
+
1;
__END__
Called by COMPONENT to instantiate the component; should return an object
to be stored in the application's component hash.
-=head2 COMPONENT($c, $arguments)
+=head2 COMPONENT
+
+C<< my $component_instance = $component->COMPONENT($app, $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.
+C<< MyApp->config('Controller::Foo' => \%conf >>).
+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
+something like this:
+
+ sub COMPONENT {
+ my ($class, $app, $args) = @_;
+ $args = $self->merge_config_hashes($self->config, $args);
+ return $class->new($app, $args);
+ }
+
+=head2 _component_class
+
+The class name of the component within an application. This is used to
+pass the component's class name to actions generated (becoming
+C<< $action->class >>). This is needed so that the L</COMPONENT> method can
+return an instance of a different class (e.g. a L<Class::MOP> anonymous class),
+and should be used to retrieve a component instead of C<< ref($self) >>.
=head2 $c->config
=head2 $c->config($key, $value, ...)
-Accessor for this component's config hash. Config values can be set as
+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.
+will be merged with any existing config settings. Each component in
+a Catalyst application has its 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
+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 )
=head2 ACCEPT_CONTEXT($c, @args)
-Catalyst components are normally initalized during server startup, either
+Catalyst components are normally initialized 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.
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
projects / catagits/Catalyst-Runtime.git / blobdiff