X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=a4f5eb4fc95a7fd1887a43040547f2c1ca8edf6a;hp=8e5ea75990178c49fa32edc7f7cdef5febcbd26d;hb=cccc8f68ace5d11c3fdcbfc4e353225b3b574255;hpb=4082e67814e85bc9820e56eb38e5e21511c0a5f8

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 8e5ea75..a4f5eb4 100644
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -3,6 +3,24 @@ package Catalyst::Action;
 use strict;
 use base qw/Class::Accessor::Fast/;
 
+
+=head1 NAME
+
+Catalyst::Action - Catalyst Action
+
+=head1 SYNOPSIS
+
+	<form action="[%c.uri_for(c.action.reverse)%]">
+	
+=head1 DESCRIPTION
+
+This class represents a Catalyst Action. You can access the object for the 
+currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
+for more information on how actions are dispatched. Actions are defined in
+L<Catalyst::Controller> subclasses.
+
+=cut
+
 __PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
 
 use overload (
@@ -10,58 +28,78 @@ use overload (
     # Stringify to reverse for debug output etc.
     q{""} => sub { shift->{reverse} },
 
-    # Codulate to encapsulated action coderef
-    '&{}' => sub { shift->{code} },
+    # Codulate to execute to invoke the encapsulated action coderef
+    '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
 
     # Make general $stuff still work
     fallback => 1,
 
 );
 
-=head1 NAME
+sub dispatch {    # Execute ourselves against a context
+    my ( $self, $c ) = @_;
+    local $c->namespace = $self->namespace;
+    return $c->execute( $self->class, $self );
+}
 
-Catalyst::Action - Catalyst Action
+sub execute {
+  my $self = shift;
+  $self->{code}->(@_);
+}
 
-=head1 SYNOPSIS
+sub match {
+    my ( $self, $c ) = @_;
+    return 1 unless exists $self->attributes->{Args};
+    my $args = $self->attributes->{Args}[0];
+    return 1 unless defined($args) && length($args);
+    return scalar( @{ $c->req->args } ) == $args;
+}
 
-See L<Catalyst>.
+1;
 
-=head1 DESCRIPTION
+__END__
 
 =head1 METHODS
 
 =head2 attributes
 
+The sub attributes that are set for this action, like Local, Path, Private
+and so on. This determines how the action is dispatched to.
+
 =head2 class
 
+Returns the class name where this action is defined.
+
 =head2 code
 
-=head2 execute
+Returns a code reference to this action.
 
-=cut
+=head2 dispatch( $c )
 
-sub execute {    # Execute ourselves against a context
-    my ( $self, $c ) = @_;
-    local $c->namespace = $self->namespace;
-    return $c->execute( $self->class, $self );
-}
+Dispatch this action against a context
 
-=head2 match
+=head2 execute( $controller, $c, @args )
 
-=cut
+Execute this action's coderef against a given controller with a given
+context and arguments
 
-sub match {
-    my ( $self, $c ) = @_;
-    return 1 unless exists $self->attributes->{Args};
-    return scalar(@{$c->req->args}) == $self->attributes->{Args}[0];
-}
+=head2 match( $c )
+
+Check Args attribute, and makes sure number of args matches the setting.
+Always returns true if Args is omitted.
 
 =head2 namespace
 
+Returns the private namespace this action lives in.
+
 =head2 reverse
 
+Returns the private path for this action.
+
 =head2 name
 
+returns the sub name of this action.
+
 =head1 AUTHOR
 
 Matt S. Trout
@@ -71,6 +109,4 @@ Matt S. Trout
 This program is free software, you can redistribute it and/or modify it under
 the same terms as Perl itself.
 
-=cut
-
-1;
+=cut
\ No newline at end of file