Commit | Line | Data |
fbcc39ad |
1 | package Catalyst::Action; |
2 | |
b2ddf6d7 |
3 | =head1 NAME |
4 | |
5 | Catalyst::Action - Catalyst Action |
6 | |
7 | =head1 SYNOPSIS |
8 | |
804fb55d |
9 | <form action="[%c.uri_for(c.action)%]"> |
85d9fce6 |
10 | |
009b5b23 |
11 | $c->forward( $action->private_path ); |
12 | |
b2ddf6d7 |
13 | =head1 DESCRIPTION |
14 | |
43c58153 |
15 | This class represents a Catalyst Action. You can access the object for the |
b2ddf6d7 |
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. |
19 | |
20 | =cut |
21 | |
059c085b |
22 | use Moose; |
05b47f2e |
23 | use Scalar::Util 'looks_like_number'; |
241edc9b |
24 | with 'MooseX::Emulate::Class::Accessor::Fast'; |
05b47f2e |
25 | use namespace::clean -except => 'meta'; |
241edc9b |
26 | |
5fb12dbb |
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'); |
009b5b23 |
33 | has private_path => ( |
34 | reader => 'private_path', |
35 | isa => 'Str', |
36 | lazy => 1, |
37 | required => 1, |
38 | default => sub { '/'.shift->reverse }, |
39 | ); |
059c085b |
40 | |
2055d9ad |
41 | use overload ( |
42 | |
43 | # Stringify to reverse for debug output etc. |
44 | q{""} => sub { shift->{reverse} }, |
45 | |
46 | # Codulate to execute to invoke the encapsulated action coderef |
47 | '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; }, |
48 | |
49 | # Make general $stuff still work |
50 | fallback => 1, |
51 | |
52 | ); |
53 | |
54 | |
55 | |
059c085b |
56 | no warnings 'recursion'; |
57 | |
b2ddf6d7 |
58 | sub dispatch { # Execute ourselves against a context |
59 | my ( $self, $c ) = @_; |
049f82e2 |
60 | return $c->execute( $self->class, $self ); |
b2ddf6d7 |
61 | } |
fbcc39ad |
62 | |
b2ddf6d7 |
63 | sub execute { |
64 | my $self = shift; |
059c085b |
65 | $self->code->(@_); |
b2ddf6d7 |
66 | } |
fbcc39ad |
67 | |
b2ddf6d7 |
68 | sub match { |
60034b8c |
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; |
760d121e |
77 | } |
78 | |
60034b8c |
79 | sub match_captures { 1 } |
fbcc39ad |
80 | |
05b47f2e |
81 | sub compare { |
82 | my ($a1, $a2) = @_; |
83 | |
cbe555e8 |
84 | my ($a1_args) = @{ $a1->attributes->{Args} || [] }; |
85 | my ($a2_args) = @{ $a2->attributes->{Args} || [] }; |
86 | |
18a9655c |
87 | $_ = looks_like_number($_) ? $_ : ~0 |
cbe555e8 |
88 | for $a1_args, $a2_args; |
89 | |
90 | return $a1_args <=> $a2_args; |
05b47f2e |
91 | } |
92 | |
0cff119a |
93 | sub number_of_args { |
94 | my ( $self ) = @_; |
95 | return 0 unless exists $self->attributes->{Args}; |
96 | return $self->attributes->{Args}[0]; |
97 | } |
98 | |
99 | sub number_of_captures { |
100 | my ( $self ) = @_; |
101 | |
102 | return 0 unless exists $self->attributes->{CaptureArgs}; |
103 | return $self->attributes->{CaptureArgs}[0] || 0; |
104 | } |
105 | |
ffca3e96 |
106 | sub list_extra_info { |
107 | my $self = shift; |
108 | return { |
109 | Args => $self->attributes->{Args}[0], |
110 | CaptureArgs => $self->number_of_captures, |
111 | } |
112 | } |
3c0da3ec |
113 | |
e5ecd5bc |
114 | __PACKAGE__->meta->make_immutable; |
115 | |
b2ddf6d7 |
116 | 1; |
fbcc39ad |
117 | |
b2ddf6d7 |
118 | __END__ |
4ab87e27 |
119 | |
fbcc39ad |
120 | =head1 METHODS |
121 | |
b5ecfcf0 |
122 | =head2 attributes |
fbcc39ad |
123 | |
4ab87e27 |
124 | The sub attributes that are set for this action, like Local, Path, Private |
b2ddf6d7 |
125 | and so on. This determines how the action is dispatched to. |
4ab87e27 |
126 | |
b5ecfcf0 |
127 | =head2 class |
b96f127f |
128 | |
4d38cb07 |
129 | Returns the name of the component where this action is defined. |
8f6cebb2 |
130 | Derived by calling the L<Catalyst::Component/catalyst_component_name|catalyst_component_name> |
fb0c5b21 |
131 | method on each component. |
4ab87e27 |
132 | |
b5ecfcf0 |
133 | =head2 code |
11bd4e3e |
134 | |
b2ddf6d7 |
135 | Returns a code reference to this action. |
4ab87e27 |
136 | |
b8f669f3 |
137 | =head2 dispatch( $c ) |
4ab87e27 |
138 | |
18a9655c |
139 | Dispatch this action against a context. |
fbcc39ad |
140 | |
b8f669f3 |
141 | =head2 execute( $controller, $c, @args ) |
142 | |
143 | Execute this action's coderef against a given controller with a given |
144 | context and arguments |
145 | |
649fd1fa |
146 | =head2 match( $c ) |
4ab87e27 |
147 | |
649fd1fa |
148 | Check Args attribute, and makes sure number of args matches the setting. |
b2ddf6d7 |
149 | Always returns true if Args is omitted. |
4082e678 |
150 | |
760d121e |
151 | =head2 match_captures ($c, $captures) |
152 | |
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. |
156 | |
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). |
159 | |
160 | |
91955398 |
161 | =head2 compare |
162 | |
cbe555e8 |
163 | Compares 2 actions based on the value of the C<Args> attribute, with no C<Args> |
164 | having the highest precedence. |
91955398 |
165 | |
b5ecfcf0 |
166 | =head2 namespace |
fbcc39ad |
167 | |
4ab87e27 |
168 | Returns the private namespace this action lives in. |
169 | |
b5ecfcf0 |
170 | =head2 reverse |
6b239949 |
171 | |
4ab87e27 |
172 | Returns the private path for this action. |
173 | |
009b5b23 |
174 | =head2 private_path |
175 | |
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>. |
178 | |
b5ecfcf0 |
179 | =head2 name |
fbcc39ad |
180 | |
18a9655c |
181 | Returns the sub name of this action. |
4ab87e27 |
182 | |
0cff119a |
183 | =head2 number_of_args |
184 | |
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. |
186 | |
187 | =head2 number_of_captures |
188 | |
189 | Returns the number of captures this action expects for L<Chained|Catalyst::DispatchType::Chained> actions. |
190 | |
3c0da3ec |
191 | =head2 list_extra_info |
192 | |
ffca3e96 |
193 | A HashRef of key-values that an action can provide to a debugging screen |
3c0da3ec |
194 | |
059c085b |
195 | =head2 meta |
196 | |
18a9655c |
197 | Provided by Moose. |
059c085b |
198 | |
2f381252 |
199 | =head1 AUTHORS |
fbcc39ad |
200 | |
2f381252 |
201 | Catalyst Contributors, see Catalyst.pm |
fbcc39ad |
202 | |
203 | =head1 COPYRIGHT |
204 | |
536bee89 |
205 | This library is free software. You can redistribute it and/or modify it under |
fbcc39ad |
206 | the same terms as Perl itself. |
207 | |
85d9fce6 |
208 | =cut |