further doc updates.

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

diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm
index 130006a..0e132f5 100644 (file)
--- a/lib/Catalyst/Action.pm
+++ b/lib/Catalyst/Action.pm
@@ -13,6 +13,9 @@ use overload (
     # Codulate to encapsulated action coderef
     '&{}' => sub { shift->{code} },
 
+    # Make general $stuff still work
+    fallback => 1,
+
 );
 
 =head1 NAME
@@ -25,15 +28,27 @@ 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 execute( $c )
+
+Execute this action against a context
 
 =cut
 
@@ -43,12 +58,30 @@ sub execute {    # Execute ourselves against a context
     return $c->execute( $self->class, $self );
 }
 
+=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};
+    return scalar(@{$c->req->args}) == $self->attributes->{Args}[0];
+}
+
 =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