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'
59 scalar(@{$self->attributes->{Args}}) == 1 &&
60 looks_like_number($self->attributes->{Args}[0])
62 # 'Old school' numberd args (is allowed to be undef as well)
63 return $self->attributes->{Args}[0];
65 # New hotness named arg constraints
66 return $self->number_of_args_constraints;
70 sub normalized_arg_number {
71 return defined($_[0]->number_of_args) ? $_[0]->number_of_args : ~0;
74 has args_constraints => (
81 builder=>'_build_args_constraints',
83 has_args_constraints => 'count',
84 number_of_args_constraints => 'count',
87 sub _build_args_constraints {
89 my @arg_protos = @{$self->attributes->{Args}||[]};
91 return [] unless scalar(@arg_protos);
92 # If there is only one arg and it looks like a number
93 # we assume its 'classic' and the number is the number of
97 scalar(@arg_protos) == 1 &&
98 looks_like_number($arg_protos[0])
103 map { $self->resolve_type_constraint($_) || die "$_ is not a constraint!" }
110 sub resolve_type_constraint {
111 my ($self, $name) = @_;
112 my $tc = eval "package ${\$self->class}; $name" || undef;
113 return $tc || Moose::Util::TypeConstraints::find_or_parse_type_constraint($name);
118 # Stringify to reverse for debug output etc.
119 q{""} => sub { shift->{reverse} },
121 # Codulate to execute to invoke the encapsulated action coderef
122 '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
124 # Make general $stuff still work
129 no warnings 'recursion';
131 sub dispatch { # Execute ourselves against a context
132 my ( $self, $c ) = @_;
133 return $c->execute( $self->class, $self );
142 my ( $self, $c ) = @_;
143 $c->log->debug($self->reverse);
145 # If infinite args, we always match
146 return 1 if $self->normalized_arg_number == ~0;
148 # There there are arg constraints, we must see to it that the constraints
149 # check positive for each arg in the list.
150 if($self->has_args_constraints) {
151 # If there is only one type constraint, and its a Ref or subtype of Ref,
152 # That means we expect a reference, so use the full args arrayref.
154 $self->number_of_args_constraints == 1 &&
155 $self->args_constraints->[0]->is_a_type_of('Ref')
157 return $self->args_constraints->[0]->check($c->req->args);
159 for my $i(0..$#{ $c->req->args }) {
160 $self->args_constraints->[$i]->check($c->req->args->[$i]) || return 0;
165 # Otherwise, we just need to match the number of args.
166 return scalar( @{ $c->req->args } ) == $self->normalized_arg_number;
170 sub match_captures { 1 }
174 return $a1->normalized_arg_number <=> $a2->normalized_arg_number;
177 sub number_of_captures {
180 return 0 unless exists $self->attributes->{CaptureArgs};
181 return $self->attributes->{CaptureArgs}[0] || 0;
185 return exists $_[0]->attributes->{Scheme} ? $_[0]->attributes->{Scheme}[0] : undef;
188 sub list_extra_info {
191 Args => $self->attributes->{Args}[0],
192 CaptureArgs => $self->number_of_captures,
196 __PACKAGE__->meta->make_immutable;
206 The sub attributes that are set for this action, like Local, Path, Private
207 and so on. This determines how the action is dispatched to.
211 Returns the name of the component where this action is defined.
212 Derived by calling the L<catalyst_component_name|Catalyst::Component/catalyst_component_name>
213 method on each component.
217 Returns a code reference to this action.
219 =head2 dispatch( $c )
221 Dispatch this action against a context.
223 =head2 execute( $controller, $c, @args )
225 Execute this action's coderef against a given controller with a given
226 context and arguments
230 Check Args attribute, and makes sure number of args matches the setting.
231 Always returns true if Args is omitted.
233 =head2 match_captures ($c, $captures)
235 Can be implemented by action class and action role authors. If the method
236 exists, then it will be called with the request context and an array reference
237 of the captures for this action.
239 Returning true from this method causes the chain match to continue, returning
240 makes the chain not match (and alternate, less preferred chains will be attempted).
245 Compares 2 actions based on the value of the C<Args> attribute, with no C<Args>
246 having the highest precedence.
250 Returns the private namespace this action lives in.
254 Returns the private path for this action.
258 Returns absolute private path for this action. Unlike C<reverse>, the
259 C<private_path> of an action is always suitable for passing to C<forward>.
263 Returns the sub name of this action.
265 =head2 number_of_args
267 Returns the number of args this action expects. This is 0 if the action doesn't
268 take any arguments and undef if it will take any number of arguments.
270 =head2 normalized_arg_number
272 For the purposes of comparison we normalize 'number_of_args' so that if it is
273 undef we mean ~0 (as many args are we can think of).
275 =head2 number_of_captures
277 Returns the number of captures this action expects for L<Chained|Catalyst::DispatchType::Chained> actions.
279 =head2 list_extra_info
281 A HashRef of key-values that an action can provide to a debugging screen
285 Any defined scheme for the action
293 Catalyst Contributors, see Catalyst.pm
297 This library is free software. You can redistribute it and/or modify it under
298 the same terms as Perl itself.