Add a test and update docs on how to pass-through the Authorization header under...

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

diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index 196d3fd..f8476eb 100644 (file)
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -13,6 +13,8 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is an abstract base class for Dispatch Types. 
+
 =head1 METHODS
 
 =head2 $self->list($c)
@@ -44,6 +46,18 @@ Should return true if it registers something, or false otherwise.
 
 sub register { }
 
+=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.
+
+=cut
+
+sub uri_for_action { }
+
 =head1 AUTHOR
 
 Matt S Trout