__PACKAGE__->mk_accessors(
qw/tree dispatch_types registered_dispatch_types
- method_action_class action_container_class/
+ method_action_class action_container_class
+ preload_dispatch_types postload_dispatch_types
+ /
);
# Preload these action types
=head1 DESCRIPTION
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
+
=head1 METHODS
+=head2 new
+
+Construct a new dispatcher.
+
+=cut
+
+sub new {
+ my $self = shift;
+ my $class = ref($self) || $self;
+
+ my $obj = $class->SUPER::new(@_);
+
+ # set the default pre- and and postloads
+ $obj->preload_dispatch_types( \@PRELOAD );
+ $obj->postload_dispatch_types( \@POSTLOAD );
+ return $obj;
+}
+
+=head2 $self->preload_dispatch_types
+
+An arrayref of pre-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
+
+ +My::Dispatch::Type
+
+=head2 $self->postload_dispatch_types
+
+An arrayref of post-loaded dispatchtype classes
+
+Entries are considered to be available as C<Catalyst::DispatchType::CLASS>
+To use a custom class outside the regular C<Catalyst> namespace, prefix
+it with a C<+>, like so:
+
+ +My::Dispatch::Type
+
=head2 $self->detach( $c, $command [, \@arguments ] )
+Documented in L<Catalyst>
+
=cut
sub detach {
=head2 $self->dispatch($c)
+Delegate the dispatch to the action that matched the url, or return a
+message about unknown resource
+
+
=cut
sub dispatch {
=head2 $self->forward( $c, $command [, \@arguments ] )
+Documented in L<Catalyst>
+
=cut
sub forward {
=head2 $self->prepare_action($c)
+Find an dispatch type that matches $c->req->path, and set args from it.
+
=cut
sub prepare_action {
=head2 $self->get_action( $action, $namespace )
+returns a named action from a given namespace.
+
=cut
sub get_action {
=head2 $self->get_containers( $namespace )
+Return all the action containers for a given namespace, inclusive
+
=cut
sub get_containers {
=head2 $self->register( $c, $action )
+Make sure all required dispatch types for this action are loaded, then
+pass the action to our dispatch types so they can register it if required.
+Also, set up the tree with the action containers.
+
=cut
sub register {
return unless $reg + $priv;
my $namespace = $action->namespace;
- my $parent = $self->tree;
- my $visitor = Tree::Simple::Visitor::FindByPath->new;
-
- if ($namespace) {
- for my $part ( split '/', $namespace ) {
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- my $child = $visitor->getResult;
-
- unless ($child) {
-
- # Create a new tree node and an ActionContainer to form
- # its value.
-
- my $container =
- Catalyst::ActionContainer->new(
- { part => $part, actions => {} } );
- $child = $parent->addChild( Tree::Simple->new($container) );
- $visitor->setSearchPath($part);
- $parent->accept($visitor);
- $child = $visitor->getResult;
- }
-
- $parent = $child;
- }
- }
+ my $node = $self->find_or_create_namespace_node( $namespace );
# Set the method value
- $parent->getNodeValue->actions->{ $action->name } = $action;
+ $node->getNodeValue->actions->{ $action->name } = $action;
+}
+
+sub find_or_create_namespace_node {
+ my ( $self, $namespace ) = @_;
+
+ my $tree ||= $self->tree;
+
+ return $tree unless $namespace;
+
+ my @namespace = split '/', $namespace;
+ return $self->_find_or_create_namespace_node( $tree, @namespace );
}
-=head2 $self->setup_actions( $class, $component )
+sub _find_or_create_namespace_node {
+ my ( $self, $parent, $part, @namespace ) = @_;
+
+ return $parent unless $part;
+
+ my $child = ( grep { $_->getNodeValue->part eq $part } $parent->getAllChildren )[0];
+
+ unless ($child) {
+ # Create a new tree node and an ActionContainer to form
+ # its value.
+
+ my $container =
+ Catalyst::ActionContainer->new(
+ { part => $part, actions => {} } );
+
+ $parent->addChild( $child = Tree::Simple->new($container) );
+ }
+
+ $self->_find_or_create_namespace_node( $child, @namespace );
+}
+
+=head2 $self->setup_actions( $class, $context )
+
=cut
$self->method_action_class('Catalyst::Action');
$self->action_container_class('Catalyst::ActionContainer');
- # Preload action types
- for my $type (@PRELOAD) {
- my $class = "Catalyst::DispatchType::$type";
- eval "require $class";
- Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
- if $@;
- push @{ $self->dispatch_types }, $class->new;
- $self->registered_dispatch_types->{$class} = 1;
- }
+ my @classes =
+ $self->do_load_dispatch_types( @{ $self->preload_dispatch_types } );
+ @{ $self->registered_dispatch_types }{@classes} = (1) x @classes;
- # We use a tree
+ # Create the root node of the tree
my $container =
Catalyst::ActionContainer->new( { part => '/', actions => {} } );
$self->tree( Tree::Simple->new( $container, Tree::Simple->ROOT ) );
$comp->register_actions($c) if $comp->can('register_actions');
}
- # Postload action types
- for my $type (@POSTLOAD) {
- my $class = "Catalyst::DispatchType::$type";
- eval "require $class";
- Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
- if $@;
- push @{ $self->dispatch_types }, $class->new;
- }
+ $self->do_load_dispatch_types( @{ $self->postload_dispatch_types } );
return unless $c->debug;
$_->list($c) for @{ $self->dispatch_types };
}
+sub do_load_dispatch_types {
+ my ( $self, @types ) = @_;
+
+ my @loaded;
+
+ # Preload action types
+ for my $type (@types) {
+ my $class =
+ ( $type =~ /^\+(.*)$/ ) ? $1 : "Catalyst::DispatchType::${type}";
+ eval "require $class";
+ Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
+ if $@;
+ push @{ $self->dispatch_types }, $class->new;
+
+ push @loaded, $class;
+ }
+
+ return @loaded;
+}
+
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>