X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=01c05646c3f24c0a432bdda51d982d4c07ec58ff;hb=85d9fce671016c9040775c8b4458cf9c72ec2208;hp=0bc165aa880282d3d6d84665c741a5a1a4da9b35;hpb=9ce5ab638a3850ea9b2449dc1ed20693f5478973;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index 0bc165a..01c0564 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -3,52 +3,102 @@ package Catalyst::Action; use strict; use base qw/Class::Accessor::Fast/; -__PACKAGE__->mk_accessors(qw/code namespace reverse prefix attributes name/); + +=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 ( # 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. +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 code +=head2 class -=item execute +Returns the class name where this action is defined. -=cut +=head2 code -sub execute { # Execute ourselves against a context - my ( $self, $c ) = @_; - return $c->execute( $self->namespace, $self ); -} +Returns a code reference to this action. + +=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 ) + +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 @@ -60,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;