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 (
# 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 ) = @_;
+ 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
-=over 4
+=head2 attributes
-=item 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.
-=item class
+=head2 class
-=item code
+Returns the class name where this action is defined.
-=item execute
+=head2 code
-=cut
+Returns a code reference to this action.
-sub execute { # Execute ourselves against a context
- my ( $self, $c ) = @_;
- local $c->namespace = $self->namespace;
- return $c->execute( $self->class, $self );
-}
+=head2 dispatch( $c )
-=item namespace
+Dispatch this action against a context
-=item reverse
+=head2 execute( $controller, $c, @args )
-=item name
+Execute this action's coderef against a given controller with a given
+context and arguments
-=back
+=head2 match( $c )
-=head1 AUTHOR
+Check Args attribute, and makes sure number of args matches the setting.
+Always returns true if Args is omitted.
-Matt S. Trout
+=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 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
the same terms as Perl itself.
=cut
-
-1;