X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=01c05646c3f24c0a432bdda51d982d4c07ec58ff;hb=de19de2e6f40d9f8986df5e4f37dc8084a7c83ee;hp=ca695c4d6bad48521be87e41d885acc44c4805b5;hpb=4ab87e274ac0a05f98c10a4cdba467ba4398b0d3;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index ca695c4..01c0564 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 + +
+ +=head1 DESCRIPTION + +This class represents a Catalyst Action. You can access the object for the +currently dispatched action via $c->action. See the L +for more information on how actions are dispatched. Actions are defined in +L subclasses. + +=cut + __PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); use overload ( @@ -10,65 +28,65 @@ 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 - -Catalyst::Action - Catalyst Action +sub dispatch { # Execute ourselves against a context + my ( $self, $c ) = @_; + local $c->namespace = $self->namespace; + return $c->execute( $self->class, $self ); +} -=head1 SYNOPSIS +sub execute { + my $self = shift; + $self->{code}->(@_); +} -See L. +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; +} -=head1 DESCRIPTION +1; -This class represents a Catalyst Action. You can access the object for the -currently dispatched action via $c->action +__END__ =head1 METHODS =head2 attributes The sub attributes that are set for this action, like Local, Path, Private -and so on. +and so on. This determines how the action is dispatched to. =head2 class -Returns the class name of this action +Returns the class name where this action is defined. =head2 code -Returns a code reference to this action - -=head2 execute +Returns a code reference to this action. -Execute this action against a context - -=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 ) -Check Args setting, and makes sure number of args matches the setting. +Execute this action's coderef against a given controller with a given +context and arguments -=cut +=head2 match( $c ) -sub match { - my ( $self, $c ) = @_; - return 1 unless exists $self->attributes->{Args}; - return scalar(@{$c->req->args}) == $self->attributes->{Args}[0]; -} +Check Args attribute, and makes sure number of args matches the setting. +Always returns true if Args is omitted. =head2 namespace @@ -92,5 +110,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;