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=a74eb29f0ef1fa8cf986a784c3cca079a12757a8;hp=e8b5230371ffdbd8b53a22ea760c625b768d1cf0;hb=f3414019f472b55682ef3af53f761b6db7955887;hpb=d4a29ad2859eb2b659bdd1032bd00f431235487e diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index e8b5230..a74eb29 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -1,57 +1,119 @@ package Catalyst::Action; -use strict; -use base qw/Class::Accessor::Fast/; +=head1 NAME -__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); +Catalyst::Action - Catalyst Action -use overload ( +=head1 SYNOPSIS - # Stringify to reverse for debug output etc. - q{""} => sub { shift->{reverse} }, +
- # Codulate to encapsulated action coderef - '&{}' => sub { shift->{code} }, +=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. -=head1 NAME +=cut -Catalyst::Action - Catalyst Action +use Class::C3; +use Moose; -=head1 SYNOPSIS +has class => (is => 'rw'); +has namespace => (is => 'rw'); +has 'reverse' => (is => 'rw'); +has attributes => (is => 'rw'); +has name => (is => 'rw'); +has code => (is => 'rw'); -See L. +no Moose; -=head1 DESCRIPTION +no warnings 'recursion'; + +#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); + +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 ); + + #believed to be equivalent: + my $orig = $c->namespace; + $c->namespace($self->namespace); + my $ret = $c->execute( $self->class, $self ); + $c->namespace($orig); + return $ret; +} + +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 ) = @_; - local $c->{namespace} = $self->namespace; - return $c->execute( $self->class, $self ); -} +=head2 dispatch( $c ) + +Dispatch this action against a context + +=head2 execute( $controller, $c, @args ) -=item namespace +Execute this action's coderef against a given controller with a given +context and arguments -=item reverse +=head2 match( $c ) -=item name +Check Args attribute, and makes sure number of args matches the setting. +Always returns true if Args is omitted. -=back +=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 @@ -63,5 +125,3 @@ This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself. =cut - -1;