Make go('/chained/action') execute the full chain, not just the endpoint.
[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType.pm
index 98ac0eb..06905ad 100644 (file)
@@ -1,7 +1,7 @@
 package Catalyst::DispatchType;
 
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose; # using it to add Moose::Object to @ISA ...
+no Moose;
 
 =head1 NAME
 
@@ -13,30 +13,56 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is an abstract base class for Dispatch Types. 
+
 =head1 METHODS
 
 =head2 $self->list($c)
 
+abstract method, to be implemented by dispatchtypes. Called to display
+info in debug log.
+
 =cut
 
 sub list { }
 
 =head2 $self->match( $c, $path )
 
+abstract method, to be implemented by dispatchtypes. Returns true if the
+dispatch type matches the given path
+
 =cut
 
 sub match { die "Abstract method!" }
 
 =head2 $self->register( $c, $action )
 
+abstract method, to be implemented by dispatchtypes. Takes a
+context object and a L<Catalyst::Action> object. 
+
+Should return true if it registers something, or false otherwise.
+
 =cut
 
 sub register { }
 
-=head1 AUTHOR
+=head2 $self->uri_for_action( $action, \@captures )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+L<Catalyst::Action> object and an arrayref of captures, and should
+return either a URI part which if placed in $c->req->path would cause
+$self->match to match this action and set $c->req->captures to the supplied
+arrayref, or undef if unable to do so.
 
-Matt S Trout
-Sebastian Riedel, C<sri@cpan.org>
+=cut
+
+sub uri_for_action { }
+
+sub expand_action { }
+
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
@@ -45,4 +71,6 @@ the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;