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=0e2bb583f46c45e5eb40c57905ec3de584e22875;hp=130006a244acde8057a021f022e01949688cdc94;hb=ac5c933bdd463558e8d621507a53a7b247a9093e;hpb=b5ecfcf07b8ffe7e9984f0279c8781ce51c6ac6a diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index 130006a..0e2bb58 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -1,54 +1,132 @@ 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/); +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; + +no warnings 'recursion'; + +#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); use overload ( # Stringify to reverse for debug output etc. - q{""} => sub { shift->{reverse} }, + 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 ) = @_; + #Moose todo: grrrrrr. this is no good. i don't know enough about it to + # debug it though. why can't we just call the accessor? + local $c->{namespace} = $self->namespace; + return $c->execute( $self->class, $self ); -Catalyst::Action - Catalyst Action + #believed to be equivalent: + #my $orig = $c->namespace; + #$c->namespace($self->namespace); + #my $ret = $c->execute( $self->class, $self ); + #$c->namespace($orig); + #return $ret; +} -=head1 SYNOPSIS +sub execute { + my $self = shift; + $self->code->(@_); +} -See L. +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; +} -=head1 DESCRIPTION +__PACKAGE__->meta->make_immutable; + +1; + +__END__ =head1 METHODS =head2 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. + =head2 class +Returns the class name where this action is defined. + =head2 code -=head2 execute +Returns a code reference to this action. -=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 execute( $controller, $c, @args ) + +Execute this action's coderef against a given controller with a given +context and arguments + +=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. + +=head2 meta + +Provided by Moose + =head1 AUTHOR Matt S. Trout @@ -59,5 +137,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;