X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=f21e34d01830083aeffbb05a4f7dd8c638adacbb;hp=9b2ea9fed4f3e759faa9c0e7cf534094c5cb6c11;hb=77f23d2a797fdde1e4e8e21c6bdff58639144383;hpb=11bd4e3eaa29685c44318041381621e79c4a5f44 diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index 9b2ea9f..f21e34d 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -1,60 +1,129 @@ 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 + +use Moose; -__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); +with 'MooseX::Emulate::Class::Accessor::Fast'; + +has class => (is => 'rw'); +has namespace => (is => 'rw'); +has 'reverse' => (is => 'rw'); +has attributes => (is => 'rw'); +has name => (is => 'rw'); +has code => (is => 'rw'); + +no Moose; 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 -=head1 SYNOPSIS +no warnings 'recursion'; -See L. +#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); -=head1 DESCRIPTION +sub dispatch { # Execute ourselves against a context + my ( $self, $c ) = @_; + return $c->execute( $self->class, $self ); +} + +sub execute { + my $self = shift; + $self->code->(@_); +} + +sub match { + my ( $self, $c ) = @_; + #would it be unreasonable to store the number of arguments + #the action has as it's own attribute? + #it would basically eliminate the code below. ehhh. small fish + 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; +} + +__PACKAGE__->meta->make_immutable; + +1; + +__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 ) = @_; - 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. + +=head2 meta + +Provided by Moose + +=head1 AUTHORS + +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT @@ -62,5 +131,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;