first cut at :ChildOf

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

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 0002ef7..0ddd796 100644 (file)
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -10,8 +10,8 @@ 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,
@@ -28,30 +28,74 @@ See L<Catalyst>.
 
 =head1 DESCRIPTION
 
+This class represents a Catalyst Action. You can access the object for the 
+currently dispatched action via $c->action
+
 =head1 METHODS
 
 =head2 attributes
 
+The sub attributes that are set for this action, like Local, Path, Private
+and so on.
+
 =head2 class
 
+Returns the class name of this action
+
 =head2 code
 
-=head2 execute
+Returns a code reference to this action
+
+=head2 dispatch( $c )
+
+Dispatch this action against a context
 
 =cut
 
-sub execute {    # Execute ourselves against a context
+sub dispatch {    # Execute ourselves against a context
     my ( $self, $c ) = @_;
     local $c->namespace = $self->namespace;
     return $c->execute( $self->class, $self );
 }
 
+=head2 execute( $controller, $c, @args )
+
+Execute this action's coderef against a given controller with a given
+context and arguments
+
+=cut
+
+sub execute {
+  my $self = shift;
+  $self->{code}->(@_);
+}
+
+=head2 match( $c )
+
+Check Args attribute, and makes sure number of args matches the setting.
+
+=cut
+
+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;
+}
+
 =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