1 package Catalyst::Action;
5 Catalyst::Action - Catalyst Action
9 <form action="[%c.uri_for(c.action)%]">
11 $c->forward( $action->private_path );
15 This class represents a Catalyst Action. You can access the object for the
16 currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
17 for more information on how actions are dispatched. Actions are defined in
18 L<Catalyst::Controller> subclasses.
23 use Scalar::Util 'looks_like_number';
24 use Moose::Util::TypeConstraints ();
25 with 'MooseX::Emulate::Class::Accessor::Fast';
26 use namespace::clean -except => 'meta';
28 has class => (is => 'rw');
29 has namespace => (is => 'rw');
30 has 'reverse' => (is => 'rw');
31 has attributes => (is => 'rw');
32 has name => (is => 'rw');
33 has code => (is => 'rw');
35 reader => 'private_path',
39 default => sub { '/'.shift->reverse },
42 has number_of_args => (
48 builder=>'_build_number_of_args');
50 sub _build_number_of_args {
52 if( ! exists $self->attributes->{Args} ) {
53 # When 'Args' does not exist, that means we want 'any number of args'.
55 } elsif(!defined($self->attributes->{Args}[0])) {
56 # When its 'Args' that internal cue for 'unlimited'
58 } elsif(looks_like_number($self->attributes->{Args}[0])) {
59 # 'Old school' numberd args (is allowed to be undef as well)
60 return $self->attributes->{Args}[0];
62 # New hotness named arg constraints
63 return $self->number_of_args_constraints;
67 sub normalized_arg_number {
68 return defined($_[0]->number_of_args) ? $_[0]->number_of_args : ~0;
71 has args_constraints => (
78 builder=>'_build_args_constraints',
80 has_args_constraints => 'count',
81 number_of_args_constraints => 'count',
84 sub _build_args_constraints {
86 my @arg_protos = @{$self->attributes->{Args}||[]};
88 return [] unless scalar(@arg_protos);
89 # If there is only one arg and it looks like a number
90 # we assume its 'classic' and the number is the number of
94 scalar(@arg_protos) == 1 &&
95 looks_like_number($arg_protos[0])
99 @args = map { Moose::Util::TypeConstraints::find_or_parse_type_constraint($_) || die "$_ is not a constraint!" } @arg_protos;
107 # Stringify to reverse for debug output etc.
108 q{""} => sub { shift->{reverse} },
110 # Codulate to execute to invoke the encapsulated action coderef
111 '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
113 # Make general $stuff still work
118 no warnings 'recursion';
120 sub dispatch { # Execute ourselves against a context
121 my ( $self, $c ) = @_;
122 return $c->execute( $self->class, $self );
131 my ( $self, $c ) = @_;
133 # If infinite args, we always match
134 return 1 if $self->normalized_arg_number == ~0;
136 # There there are arg constraints, we must see to it that the constraints
137 # check positive for each arg in the list.
138 if($self->has_args_constraints) {
139 for my $i($#{ $c->req->args }) {
140 $self->args_constraints->[$i]->check($c->req->args->[$i]) || return 0;
144 # Otherwise, we just need to match the number of args.
145 return scalar( @{ $c->req->args } ) == $self->normalized_arg_number;
149 sub match_captures { 1 }
153 return $a1->normalized_arg_number <=> $a2->normalized_arg_number;
156 sub number_of_captures {
159 return 0 unless exists $self->attributes->{CaptureArgs};
160 return $self->attributes->{CaptureArgs}[0] || 0;
164 return exists $_[0]->attributes->{Scheme} ? $_[0]->attributes->{Scheme}[0] : undef;
167 sub list_extra_info {
170 Args => $self->attributes->{Args}[0],
171 CaptureArgs => $self->number_of_captures,
175 __PACKAGE__->meta->make_immutable;
185 The sub attributes that are set for this action, like Local, Path, Private
186 and so on. This determines how the action is dispatched to.
190 Returns the name of the component where this action is defined.
191 Derived by calling the L<catalyst_component_name|Catalyst::Component/catalyst_component_name>
192 method on each component.
196 Returns a code reference to this action.
198 =head2 dispatch( $c )
200 Dispatch this action against a context.
202 =head2 execute( $controller, $c, @args )
204 Execute this action's coderef against a given controller with a given
205 context and arguments
209 Check Args attribute, and makes sure number of args matches the setting.
210 Always returns true if Args is omitted.
212 =head2 match_captures ($c, $captures)
214 Can be implemented by action class and action role authors. If the method
215 exists, then it will be called with the request context and an array reference
216 of the captures for this action.
218 Returning true from this method causes the chain match to continue, returning
219 makes the chain not match (and alternate, less preferred chains will be attempted).
224 Compares 2 actions based on the value of the C<Args> attribute, with no C<Args>
225 having the highest precedence.
229 Returns the private namespace this action lives in.
233 Returns the private path for this action.
237 Returns absolute private path for this action. Unlike C<reverse>, the
238 C<private_path> of an action is always suitable for passing to C<forward>.
242 Returns the sub name of this action.
244 =head2 number_of_args
246 Returns the number of args this action expects. This is 0 if the action doesn't
247 take any arguments and undef if it will take any number of arguments.
249 =head2 normalized_arg_number
251 For the purposes of comparison we normalize 'number_of_args' so that if it is
252 undef we mean ~0 (as many args are we can think of).
254 =head2 number_of_captures
256 Returns the number of captures this action expects for L<Chained|Catalyst::DispatchType::Chained> actions.
258 =head2 list_extra_info
260 A HashRef of key-values that an action can provide to a debugging screen
264 Any defined scheme for the action
272 Catalyst Contributors, see Catalyst.pm
276 This library is free software. You can redistribute it and/or modify it under
277 the same terms as Perl itself.