improved DispatchType docs

[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / Index.pm

diff --git a/lib/Catalyst/DispatchType/Index.pm b/lib/Catalyst/DispatchType/Index.pm
index 58420e3..f99e41c 100644 (file)
--- a/lib/Catalyst/DispatchType/Index.pm
+++ b/lib/Catalyst/DispatchType/Index.pm
@@ -18,7 +18,8 @@ See L<Catalyst>.
 =head2 $self->match( $c, $path )
 
 Check if there's an index action for a given path, and set it up to use it
-if there is.
+if there is; only matches a full URI - if $c->req->args is already set
+this DispatchType is guaranteed not to match.
 
 =cut
 
@@ -37,6 +38,23 @@ sub match {
     return 0;
 }
 
+=head2 $self->uri_for_action( $action, $captures )
+
+get a URI part for an action; always returns undef is $captures is set
+since index actions don't have captures
+
+=cut
+
+sub uri_for_action {
+    my ( $self, $action, $captures ) = @_;
+
+    return undef if @$captures;
+
+    return undef unless $action->name eq 'index';
+
+    return "/".$action->namespace;
+}
+
 =head1 AUTHOR
 
 Sebastian Riedel, C<sri@cpan.org>