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 with 'MooseX::Emulate::Class::Accessor::Fast';
25 use namespace::clean -except => 'meta';
27 has class => (is => 'rw');
28 has namespace => (is => 'rw');
29 has 'reverse' => (is => 'rw');
30 has attributes => (is => 'rw');
31 has name => (is => 'rw');
32 has code => (is => 'rw');
34 reader => 'private_path',
38 default => sub { '/'.shift->reverse },
43 # Stringify to reverse for debug output etc.
44 q{""} => sub { shift->{reverse} },
46 # Codulate to execute to invoke the encapsulated action coderef
47 '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
49 # Make general $stuff still work
56 no warnings 'recursion';
58 sub dispatch { # Execute ourselves against a context
59 my ( $self, $c ) = @_;
60 return $c->execute( $self->class, $self );
69 my ( $self, $c ) = @_;
70 #would it be unreasonable to store the number of arguments
71 #the action has as its own attribute?
72 #it would basically eliminate the code below. ehhh. small fish
73 return 1 unless exists $self->attributes->{Args};
74 my $args = $self->attributes->{Args}[0];
75 return 1 unless defined($args) && length($args);
76 return scalar( @{ $c->req->args } ) == $args;
79 sub match_captures { 1 }
84 my ($a1_args) = @{ $a1->attributes->{Args} || [] };
85 my ($a2_args) = @{ $a2->attributes->{Args} || [] };
87 $_ = looks_like_number($_) ? $_ : ~0
88 for $a1_args, $a2_args;
90 return $a1_args <=> $a2_args;
95 return 0 unless exists $self->attributes->{Args};
96 return $self->attributes->{Args}[0];
99 sub number_of_captures {
102 return 0 unless exists $self->attributes->{CaptureArgs};
103 return $self->attributes->{CaptureArgs}[0] || 0;
106 sub list_extra_info {
109 Args => $self->attributes->{Args}[0],
110 CaptureArgs => $self->number_of_captures,
114 __PACKAGE__->meta->make_immutable;
124 The sub attributes that are set for this action, like Local, Path, Private
125 and so on. This determines how the action is dispatched to.
129 Returns the name of the component where this action is defined.
130 Derived by calling the L<catalyst_component_name|Catalyst::Component/catalyst_component_name>
131 method on each component.
135 Returns a code reference to this action.
137 =head2 dispatch( $c )
139 Dispatch this action against a context.
141 =head2 execute( $controller, $c, @args )
143 Execute this action's coderef against a given controller with a given
144 context and arguments
148 Check Args attribute, and makes sure number of args matches the setting.
149 Always returns true if Args is omitted.
151 =head2 match_captures ($c, $captures)
153 Can be implemented by action class and action role authors. If the method
154 exists, then it will be called with the request context and an array reference
155 of the captures for this action.
157 Returning true from this method causes the chain match to continue, returning
158 makes the chain not match (and alternate, less preferred chains will be attempted).
163 Compares 2 actions based on the value of the C<Args> attribute, with no C<Args>
164 having the highest precedence.
168 Returns the private namespace this action lives in.
172 Returns the private path for this action.
176 Returns absolute private path for this action. Unlike C<reverse>, the
177 C<private_path> of an action is always suitable for passing to C<forward>.
181 Returns the sub name of this action.
183 =head2 number_of_args
185 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.
187 =head2 number_of_captures
189 Returns the number of captures this action expects for L<Chained|Catalyst::DispatchType::Chained> actions.
191 =head2 list_extra_info
193 A HashRef of key-values that an action can provide to a debugging screen
201 Catalyst Contributors, see Catalyst.pm
205 This library is free software. You can redistribute it and/or modify it under
206 the same terms as Perl itself.