X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction.pm;h=555c939589f97967f084b83b73257cbffb5a4f7f;hb=4f96d61ccf40febbf2f80a376cd3ec7b456c699c;hp=0eb99424eed9222274f112c9504d47736aee0bb1;hpb=05b47f2e6357bc7f1622e6b2cf730ad5bbeb993f;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Action.pm b/lib/Catalyst/Action.pm index 0eb9942..555c939 100644 --- a/lib/Catalyst/Action.pm +++ b/lib/Catalyst/Action.pm @@ -8,6 +8,8 @@ Catalyst::Action - Catalyst Action
+ $c->forward( $action->private_path ); + =head1 DESCRIPTION This class represents a Catalyst Action. You can access the object for the @@ -28,6 +30,13 @@ has 'reverse' => (is => 'rw'); has attributes => (is => 'rw'); has name => (is => 'rw'); has code => (is => 'rw'); +has private_path => ( + reader => 'private_path', + isa => 'Str', + lazy => 1, + required => 1, + default => sub { '/'.shift->reverse }, +); use overload ( @@ -37,10 +46,6 @@ use overload ( # Codulate to execute to invoke the encapsulated action coderef '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; }, - # Which action takes precedence - 'cmp' => 'compare', - '<=>' => 'compare', - # Make general $stuff still work fallback => 1, @@ -50,8 +55,6 @@ use overload ( no warnings 'recursion'; -#__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/); - sub dispatch { # Execute ourselves against a context my ( $self, $c ) = @_; return $c->execute( $self->class, $self ); @@ -73,22 +76,41 @@ sub match { return scalar( @{ $c->req->args } ) == $args; } -sub sort_order { - my $self = shift; +sub match_captures { 1 } + +sub compare { + my ($a1, $a2) = @_; + + my ($a1_args) = @{ $a1->attributes->{Args} || [] }; + my ($a2_args) = @{ $a2->attributes->{Args} || [] }; - my ($args) = @{ $self->attributes->{Args} || [] }; + $_ = looks_like_number($_) ? $_ : ~0 + for $a1_args, $a2_args; - return $args if looks_like_number($args); + return $a1_args <=> $a2_args; +} - return ~0; +sub number_of_args { + my ( $self ) = @_; + return 0 unless exists $self->attributes->{Args}; + return $self->attributes->{Args}[0]; } -sub compare { - my ($a1, $a2) = @_; +sub number_of_captures { + my ( $self ) = @_; - return $a1->sort_order <=> $a2->sort_order; + return 0 unless exists $self->attributes->{CaptureArgs}; + return $self->attributes->{CaptureArgs}[0] || 0; } +sub list_extra_info { + my $self = shift; + return { + Args => $self->attributes->{Args}[0], + CaptureArgs => $self->number_of_captures, + } +} + __PACKAGE__->meta->make_immutable; 1; @@ -104,7 +126,9 @@ and so on. This determines how the action is dispatched to. =head2 class -Returns the class name where this action is defined. +Returns the name of the component where this action is defined. +Derived by calling the L +method on each component. =head2 code @@ -112,7 +136,7 @@ Returns a code reference to this action. =head2 dispatch( $c ) -Dispatch this action against a context +Dispatch this action against a context. =head2 execute( $controller, $c, @args ) @@ -124,6 +148,21 @@ context and arguments Check Args attribute, and makes sure number of args matches the setting. Always returns true if Args is omitted. +=head2 match_captures ($c, $captures) + +Can be implemented by action class and action role authors. If the method +exists, then it will be called with the request context and an array reference +of the captures for this action. + +Returning true from this method causes the chain match to continue, returning +makes the chain not match (and alternate, less preferred chains will be attempted). + + +=head2 compare + +Compares 2 actions based on the value of the C attribute, with no C +having the highest precedence. + =head2 namespace Returns the private namespace this action lives in. @@ -132,13 +171,30 @@ Returns the private namespace this action lives in. Returns the private path for this action. +=head2 private_path + +Returns absolute private path for this action. Unlike C, the +C of an action is always suitable for passing to C. + =head2 name -returns the sub name of this action. +Returns the sub name of this action. + +=head2 number_of_args + +Returns the number of args this action expects. This is 0 if the action doesn't take any arguments and undef if it will take any number of arguments. + +=head2 number_of_captures + +Returns the number of captures this action expects for L actions. + +=head2 list_extra_info + +A HashRef of key-values that an action can provide to a debugging screen =head2 meta -Provided by Moose +Provided by Moose. =head1 AUTHORS