added docs for engine/dispatcher
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Dispatcher.pm
index 8c4a5d8..e74a49d 100644 (file)
@@ -17,7 +17,9 @@ use overload '""' => sub { return ref shift }, fallback => 1;
 
 __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
@@ -36,10 +38,53 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This is the class that maps public urls to actions in your Catalyst
+application based on the attributes you set.
+
 =head1 METHODS
 
+=item 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 {
@@ -50,6 +95,10 @@ 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 {
@@ -70,6 +119,8 @@ sub dispatch {
 
 =head2 $self->forward( $c, $command [, \@arguments ] )
 
+Documented in L<Catalyst>
+
 =cut
 
 sub forward {
@@ -170,6 +221,8 @@ qq/Couldn't forward to command "$command". Invalid action or component./;
 
 =head2 $self->prepare_action($c)
 
+Find an dispatch type that matches $c->req->path, and set args from it.
+
 =cut
 
 sub prepare_action {
@@ -194,7 +247,9 @@ sub prepare_action {
         }
 
         # If not, move the last part path to args
-        unshift @args, pop @path;
+        my $arg = pop(@path);
+        $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
+        unshift @args, $arg;
     }
 
     $c->log->debug( 'Path is "' . $c->req->match . '"' )
@@ -206,6 +261,8 @@ sub prepare_action {
 
 =head2 $self->get_action( $action, $namespace )
 
+returns a named action from a given namespace.
+
 =cut
 
 sub get_action {
@@ -240,6 +297,8 @@ sub get_actions {
 
 =head2 $self->get_containers( $namespace )
 
+Return all the action containers for a given namespace, inclusive
+
 =cut
 
 sub get_containers {
@@ -282,6 +341,10 @@ 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 {
@@ -340,7 +403,8 @@ sub register {
     $parent->getNodeValue->actions->{ $action->name } = $action;
 }
 
-=head2 $self->setup_actions( $class, $component )
+=head2 $self->setup_actions( $class, $context )
+
 
 =cut
 
@@ -353,8 +417,8 @@ sub setup_actions {
     $self->action_container_class('Catalyst::ActionContainer');
 
     # Preload action types
-    for my $type (@PRELOAD) {
-        my $class = "Catalyst::DispatchType::$type";
+    for my $type ( @{$self->preload_dispatch_types} ) {
+        my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}";
         eval "require $class";
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;
@@ -372,8 +436,8 @@ sub setup_actions {
     }
 
     # Postload action types
-    for my $type (@POSTLOAD) {
-        my $class = "Catalyst::DispatchType::$type";
+    for my $type ( @{$self->postload_dispatch_types} ) {
+        my $class = ($type =~ /^\+(.*)$/) ? $1 : "Catalyst::DispatchType::${type}";
         eval "require $class";
         Catalyst::Exception->throw( message => qq/Couldn't load "$class"/ )
           if $@;