merged from master to sync release
[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType / Chained.pm
CommitLineData
5882c86e 1package Catalyst::DispatchType::Chained;
141459fa 2
3c0186f2 3use Moose;
e8b9f2a9 4extends 'Catalyst::DispatchType';
5
141459fa 6use Text::SimpleTable;
7use Catalyst::ActionChain;
39fc2ce1 8use Catalyst::Utils;
141459fa 9use URI;
dd97c1ac 10use Scalar::Util ();
0ca510f0 11use Encode 2.21 'decode_utf8';
141459fa 12
be5cb4e4 13has _endpoints => (
14 is => 'rw',
15 isa => 'ArrayRef',
16 required => 1,
17 default => sub{ [] },
18 );
19
20has _actions => (
21 is => 'rw',
22 isa => 'HashRef',
23 required => 1,
24 default => sub{ {} },
25 );
26
27has _children_of => (
28 is => 'rw',
29 isa => 'HashRef',
30 required => 1,
31 default => sub{ {} },
32 );
33
0fc2d522 34no Moose;
35
792b40ac 36# please don't perltidy this. hairy code within.
37
141459fa 38=head1 NAME
39
5882c86e 40Catalyst::DispatchType::Chained - Path Part DispatchType
141459fa 41
42=head1 SYNOPSIS
43
26dc649a 44Path part matching, allowing several actions to sequentially take care of processing a request:
45
05a90578 46 # root action - captures one argument after it
47 sub foo_setup : Chained('/') PathPart('foo') CaptureArgs(1) {
48 my ( $self, $c, $foo_arg ) = @_;
49 ...
50 }
51
52 # child action endpoint - takes one argument
53 sub bar : Chained('foo_setup') Args(1) {
54 my ( $self, $c, $bar_arg ) = @_;
55 ...
56 }
141459fa 57
58=head1 DESCRIPTION
59
26dc649a 60Dispatch type managing default behaviour. For more information on
61dispatch types, see:
62
63=over 4
64
b9b89145 65=item * L<Catalyst::Manual::Intro> for how they affect application authors
26dc649a 66
67=item * L<Catalyst::DispatchType> for implementation information.
68
69=back
05a90578 70
141459fa 71=head1 METHODS
72
73=head2 $self->list($c)
74
75Debug output for Path Part dispatch points
76
141459fa 77=cut
78
792b40ac 79sub list {
80 my ( $self, $c ) = @_;
81
be5cb4e4 82 return unless $self->_endpoints;
792b40ac 83
48d435ba 84 my $avail_width = Catalyst::Utils::term_width() - 9;
85 my $col1_width = ($avail_width * .50) < 35 ? 35 : int($avail_width * .50);
86 my $col2_width = $avail_width - $col1_width;
792b40ac 87 my $paths = Text::SimpleTable->new(
48d435ba 88 [ $col1_width, 'Path Spec' ], [ $col2_width, 'Private' ],
39fc2ce1 89 );
792b40ac 90
007a7ca0 91 my $has_unattached_actions;
92 my $unattached_actions = Text::SimpleTable->new(
48d435ba 93 [ $col1_width, 'Private' ], [ $col2_width, 'Missing parent' ],
007a7ca0 94 );
95
792b40ac 96 ENDPOINT: foreach my $endpoint (
97 sort { $a->reverse cmp $b->reverse }
be5cb4e4 98 @{ $self->_endpoints }
792b40ac 99 ) {
ffca3e96 100 my $args = $endpoint->list_extra_info->{Args};
79b7db20 101 my @parts = (defined($endpoint->attributes->{Args}[0]) ? (("*") x $args) : '...');
d34667c3 102 my @parents = ();
792b40ac 103 my $parent = "DUMMY";
ba3f8a81 104 my $extra = $self->_list_extra_http_methods($endpoint);
e72a3cd6 105 my $consumes = $self->_list_extra_consumes($endpoint);
342d2169 106 my $scheme = $self->_list_extra_scheme($endpoint);
792b40ac 107 my $curr = $endpoint;
108 while ($curr) {
ffca3e96 109 if (my $cap = $curr->list_extra_info->{CaptureArgs}) {
110 unshift(@parts, (("*") x $cap));
792b40ac 111 }
77771155 112 if (my $pp = $curr->attributes->{PathPart}) {
792b40ac 113 unshift(@parts, $pp->[0])
114 if (defined $pp->[0] && length $pp->[0]);
115 }
5882c86e 116 $parent = $curr->attributes->{Chained}->[0];
be5cb4e4 117 $curr = $self->_actions->{$parent};
d34667c3 118 unshift(@parents, $curr) if $curr;
792b40ac 119 }
007a7ca0 120 if ($parent ne '/') {
121 $has_unattached_actions = 1;
59d5a638 122 $unattached_actions->row('/' . ($parents[0] || $endpoint)->reverse, $parent);
007a7ca0 123 next ENDPOINT;
124 }
d34667c3 125 my @rows;
126 foreach my $p (@parents) {
127 my $name = "/${p}";
ba3f8a81 128
129 if (defined(my $extra = $self->_list_extra_http_methods($p))) {
130 $name = "${extra} ${name}";
131 }
ffca3e96 132 if (defined(my $cap = $p->list_extra_info->{CaptureArgs})) {
90102012 133 if($p->has_captures_constraints) {
134 my $tc = join ',', @{$p->captures_constraints};
135 $name .= " ($tc)";
136 } else {
137 $name .= " ($cap)";
138 }
d34667c3 139 }
e72a3cd6 140 if (defined(my $ct = $p->list_extra_info->{Consumes})) {
141 $name .= ' :'.$ct;
142 }
342d2169 143 if (defined(my $s = $p->list_extra_info->{Scheme})) {
144 $scheme = uc $s;
145 }
e72a3cd6 146
d34667c3 147 unless ($p eq $parents[0]) {
148 $name = "-> ${name}";
149 }
150 push(@rows, [ '', $name ]);
151 }
90102012 152
79b7db20 153 if($endpoint->has_args_constraints) {
154 my $tc = join ',', @{$endpoint->args_constraints};
155 $endpoint .= " ($tc)";
156 } else {
157 $endpoint .= defined($endpoint->attributes->{Args}[0]) ? " ($args)" : " (...)";
90102012 158 }
342d2169 159 push(@rows, [ '', (@rows ? "=> " : '').($extra ? "$extra " : ''). ($scheme ? "$scheme: ":'')."/${endpoint}". ($consumes ? " :$consumes":"" ) ]);
0ca510f0 160 my @display_parts = map { $_ =~s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; decode_utf8 $_ } @parts;
161 $rows[0][0] = join('/', '', @display_parts) || '/';
d34667c3 162 $paths->row(@$_) for @rows;
792b40ac 163 }
164
1cf0345b 165 $c->log->debug( "Loaded Chained actions:\n" . $paths->draw . "\n" );
007a7ca0 166 $c->log->debug( "Unattached Chained actions:\n", $unattached_actions->draw . "\n" )
167 if $has_unattached_actions;
792b40ac 168}
141459fa 169
ba3f8a81 170sub _list_extra_http_methods {
171 my ( $self, $action ) = @_;
172 return unless defined $action->list_extra_info->{HTTP_METHODS};
173 return join(', ', @{$action->list_extra_info->{HTTP_METHODS}});
e72a3cd6 174
ba3f8a81 175}
176
e72a3cd6 177sub _list_extra_consumes {
178 my ( $self, $action ) = @_;
179 return unless defined $action->list_extra_info->{CONSUMES};
180 return join(', ', @{$action->list_extra_info->{CONSUMES}});
181}
182
342d2169 183sub _list_extra_scheme {
184 my ( $self, $action ) = @_;
185 return unless defined $action->list_extra_info->{Scheme};
186 return uc $action->list_extra_info->{Scheme};
187}
e72a3cd6 188
141459fa 189=head2 $self->match( $c, $path )
190
05a90578 191Calls C<recurse_match> to see if a chain matches the C<$path>.
141459fa 192
193=cut
194
195sub match {
196 my ( $self, $c, $path ) = @_;
197
e5ecd5bc 198 my $request = $c->request;
199 return 0 if @{$request->args};
141459fa 200
201 my @parts = split('/', $path);
202
6365b527 203 my ($chain, $captures, $parts) = $self->recurse_match($c, '/', \@parts);
634780e0 204
205 if ($parts && @$parts) {
206 for my $arg (@$parts) {
207 $arg =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
208 push @{$request->args}, $arg;
209 }
210 }
141459fa 211
212 return 0 unless $chain;
213
214 my $action = Catalyst::ActionChain->from_chain($chain);
215
e5ecd5bc 216 $request->action("/${action}");
217 $request->match("/${action}");
218 $request->captures($captures);
141459fa 219 $c->action($action);
220 $c->namespace( $action->namespace );
221
222 return 1;
223}
224
225=head2 $self->recurse_match( $c, $parent, \@path_parts )
226
05a90578 227Recursive search for a matching chain.
141459fa 228
229=cut
230
231sub recurse_match {
232 my ( $self, $c, $parent, $path_parts ) = @_;
be5cb4e4 233 my $children = $self->_children_of->{$parent};
141459fa 234 return () unless $children;
6b495723 235 my $best_action;
141459fa 236 my @captures;
1b04b972 237 TRY: foreach my $try_part (sort { length($b) <=> length($a) }
cdc97b63 238 keys %$children) {
1b04b972 239 # $b then $a to try longest part first
141459fa 240 my @parts = @$path_parts;
241 if (length $try_part) { # test and strip PathPart
242 next TRY unless
243 ($try_part eq join('/', # assemble equal number of parts
244 splice( # and strip them off @parts as well
792b40ac 245 @parts, 0, scalar(@{[split('/', $try_part)]})
246 ))); # @{[]} to avoid split to @_
141459fa 247 }
248 my @try_actions = @{$children->{$try_part}};
249 TRY_ACTION: foreach my $action (@try_actions) {
1c34f703 250 if (my $capture_attr = $action->attributes->{CaptureArgs}) {
a82c96cf 251 my $capture_count = $action->number_of_captures|| 0;
f505df49 252
253 # Short-circuit if not enough remaining parts
3f91cb25 254 next TRY_ACTION unless @parts >= $capture_count;
f505df49 255
141459fa 256 my @captures;
257 my @parts = @parts; # localise
7a7ac23c 258
1c34f703 259 # strip CaptureArgs into list
3f91cb25 260 push(@captures, splice(@parts, 0, $capture_count));
7a7ac23c 261
1279064a 262 # check if the action may fit, depending on a given test by the app
a82c96cf 263 next TRY_ACTION unless $action->match_captures($c, \@captures);
1279064a 264
141459fa 265 # try the remaining parts against children of this action
0c78acb6 266 my ($actions, $captures, $action_parts, $n_pathparts) = $self->recurse_match(
141459fa 267 $c, '/'.$action->reverse, \@parts
268 );
2f381252 269 # No best action currently
270 # OR The action has less parts
271 # OR The action has equal parts but less captured data (ergo more defined)
272 if ($actions &&
273 (!$best_action ||
f4dbb497 274 $#$action_parts < $#{$best_action->{parts}} ||
2f381252 275 ($#$action_parts == $#{$best_action->{parts}} &&
0c78acb6 276 $#$captures < $#{$best_action->{captures}} &&
277 $n_pathparts > $best_action->{n_pathparts}))) {
278 my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
6b495723 279 $best_action = {
280 actions => [ $action, @$actions ],
281 captures=> [ @captures, @$captures ],
0c78acb6 282 parts => $action_parts,
283 n_pathparts => scalar(@pathparts) + $n_pathparts,
284 };
6b495723 285 }
286 }
287 else {
7a7ac23c 288 {
289 local $c->req->{arguments} = [ @{$c->req->args}, @parts ];
290 next TRY_ACTION unless $action->match($c);
291 }
5c6d829d 292 my $args_attr = $action->attributes->{Args}->[0];
0c78acb6 293 my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
953c176d 294 # No best action currently
295 # OR This one matches with fewer parts left than the current best action,
296 # And therefore is a better match
b0ad47c1 297 # OR No parts and this expects 0
953c176d 298 # The current best action might also be Args(0),
299 # but we couldn't chose between then anyway so we'll take the last seen
300
219b4f88 301 if (
302 !$best_action ||
953c176d 303 @parts < @{$best_action->{parts}} ||
219b4f88 304 (
305 !@parts &&
306 defined($args_attr) &&
09914a47 307 (
308 $args_attr eq "0" &&
7a504990 309 (
310 ($c->config->{use_chained_args_0_special_case}||0) ||
311 (
312 exists($best_action->{args_attr}) && defined($best_action->{args_attr}) ?
313 ($best_action->{args_attr} ne 0) : 1
314 )
315 )
09914a47 316 )
219b4f88 317 )
318 ){
6b495723 319 $best_action = {
320 actions => [ $action ],
321 captures=> [],
0c78acb6 322 parts => \@parts,
09914a47 323 args_attr => $args_attr,
0c78acb6 324 n_pathparts => scalar(@pathparts),
325 };
953c176d 326 }
141459fa 327 }
328 }
329 }
0c78acb6 330 return @$best_action{qw/actions captures parts n_pathparts/} if $best_action;
141459fa 331 return ();
332}
333
334=head2 $self->register( $c, $action )
335
05a90578 336Calls register_path for every Path attribute for the given $action.
141459fa 337
338=cut
339
340sub register {
341 my ( $self, $c, $action ) = @_;
342
1dc8af44 343 my @chained_attr = @{ $action->attributes->{Chained} || [] };
141459fa 344
1dc8af44 345 return 0 unless @chained_attr;
141459fa 346
2f381252 347 if (@chained_attr > 1) {
141459fa 348 Catalyst::Exception->throw(
5882c86e 349 "Multiple Chained attributes not supported registering ${action}"
141459fa 350 );
351 }
13c6b4cc 352 my $chained_to = $chained_attr[0];
141459fa 353
13c6b4cc 354 Catalyst::Exception->throw(
355 "Actions cannot chain to themselves registering /${action}"
356 ) if ($chained_to eq '/' . $action);
357
358 my $children = ($self->_children_of->{ $chained_to } ||= {});
141459fa 359
360 my @path_part = @{ $action->attributes->{PathPart} || [] };
361
09461385 362 my $part = $action->name;
141459fa 363
09461385 364 if (@path_part == 1 && defined $path_part[0]) {
365 $part = $path_part[0];
141459fa 366 } elsif (@path_part > 1) {
367 Catalyst::Exception->throw(
f3414019 368 "Multiple PathPart attributes not supported registering " . $action->reverse()
141459fa 369 );
370 }
371
8a6a6581 372 if ($part =~ m(^/)) {
373 Catalyst::Exception->throw(
f3414019 374 "Absolute parameters to PathPart not allowed registering " . $action->reverse()
8a6a6581 375 );
376 }
377
0ca510f0 378 my $encoded_part = URI->new($part)->canonical;
379 $encoded_part =~ s{(?<=[^/])/+\z}{};
792b40ac 380
0ca510f0 381 $action->attributes->{PathPart} = [ $encoded_part ];
382
383 unshift(@{ $children->{$encoded_part} ||= [] }, $action);
141459fa 384
be5cb4e4 385 $self->_actions->{'/'.$action->reverse} = $action;
792b40ac 386
2e29aec2 387 if (exists $action->attributes->{Args} and exists $action->attributes->{CaptureArgs}) {
388 Catalyst::Exception->throw(
bc71493a 389 "Combining Args and CaptureArgs attributes not supported registering " .
390 $action->reverse()
2e29aec2 391 );
dd97c1ac 392 }
393
1c34f703 394 unless ($action->attributes->{CaptureArgs}) {
be5cb4e4 395 unshift(@{ $self->_endpoints }, $action);
792b40ac 396 }
397
398 return 1;
141459fa 399}
400
401=head2 $self->uri_for_action($action, $captures)
402
05a90578 403Get the URI part for the action, using C<$captures> to fill
404the capturing parts.
141459fa 405
406=cut
407
408sub uri_for_action {
409 my ( $self, $action, $captures ) = @_;
410
5882c86e 411 return undef unless ($action->attributes->{Chained}
8b13f357 412 && !$action->attributes->{CaptureArgs});
792b40ac 413
414 my @parts = ();
415 my @captures = @$captures;
416 my $parent = "DUMMY";
417 my $curr = $action;
b6847871 418 # If this is an action chain get the last action in the chain
419 if($curr->can('chain') ) {
420 $curr = ${$curr->chain}[-1];
421 }
792b40ac 422 while ($curr) {
b6847871 423 if (my $cap = $curr->number_of_captures) {
424 return undef unless @captures >= $cap; # not enough captures
425 if ($cap) {
426 unshift(@parts, splice(@captures, -$cap));
8b13f357 427 }
792b40ac 428 }
77771155 429 if (my $pp = $curr->attributes->{PathPart}) {
792b40ac 430 unshift(@parts, $pp->[0])
8b13f357 431 if (defined($pp->[0]) && length($pp->[0]));
792b40ac 432 }
5882c86e 433 $parent = $curr->attributes->{Chained}->[0];
be5cb4e4 434 $curr = $self->_actions->{$parent};
141459fa 435 }
792b40ac 436
437 return undef unless $parent eq '/'; # fail for dangling action
438
439 return undef if @captures; # fail for too many captures
440
441 return join('/', '', @parts);
59d5a638 442
141459fa 443}
444
ae0e35ee 445=head2 $c->expand_action($action)
446
b0ad47c1 447Return a list of actions that represents a chained action. See
ae0e35ee 448L<Catalyst::Dispatcher> for more info. You probably want to
449use the expand_action it provides rather than this directly.
450
451=cut
452
52f71256 453sub expand_action {
454 my ($self, $action) = @_;
455
456 return unless $action->attributes && $action->attributes->{Chained};
457
458 my @chain;
459 my $curr = $action;
460
461 while ($curr) {
462 push @chain, $curr;
463 my $parent = $curr->attributes->{Chained}->[0];
464 $curr = $self->_actions->{$parent};
465 }
466
467 return Catalyst::ActionChain->from_chain([reverse @chain]);
468}
469
e5ecd5bc 470__PACKAGE__->meta->make_immutable;
f4de8c99 4711;
e5ecd5bc 472
05a90578 473=head1 USAGE
474
475=head2 Introduction
476
477The C<Chained> attribute allows you to chain public path parts together
67869327 478by their private names. A chain part's path can be specified with
479C<PathPart> and can be declared to expect an arbitrary number of
480arguments. The endpoint of the chain specifies how many arguments it
481gets through the C<Args> attribute. C<:Args(0)> would be none at all,
482C<:Args> without an integer would be unlimited. The path parts that
483aren't endpoints are using C<CaptureArgs> to specify how many parameters
484they expect to receive. As an example setup:
05a90578 485
486 package MyApp::Controller::Greeting;
487 use base qw/ Catalyst::Controller /;
488
489 # this is the beginning of our chain
490 sub hello : PathPart('hello') Chained('/') CaptureArgs(1) {
491 my ( $self, $c, $integer ) = @_;
492 $c->stash->{ message } = "Hello ";
493 $c->stash->{ arg_sum } = $integer;
494 }
495
496 # this is our endpoint, because it has no :CaptureArgs
497 sub world : PathPart('world') Chained('hello') Args(1) {
498 my ( $self, $c, $integer ) = @_;
499 $c->stash->{ message } .= "World!";
500 $c->stash->{ arg_sum } += $integer;
501
502 $c->response->body( join "<br/>\n" =>
503 $c->stash->{ message }, $c->stash->{ arg_sum } );
504 }
505
506The debug output provides a separate table for chained actions, showing
67869327 507the whole chain as it would match and the actions it contains. Here's an
508example of the startup output with our actions above:
05a90578 509
510 ...
511 [debug] Loaded Path Part actions:
512 .-----------------------+------------------------------.
513 | Path Spec | Private |
514 +-----------------------+------------------------------+
515 | /hello/*/world/* | /greeting/hello (1) |
516 | | => /greeting/world |
517 '-----------------------+------------------------------'
518 ...
519
67869327 520As you can see, Catalyst only deals with chains as whole paths and
521builds one for each endpoint, which are the actions with C<:Chained> but
522without C<:CaptureArgs>.
05a90578 523
524Let's assume this application gets a request at the path
67869327 525C</hello/23/world/12>. What happens then? First, Catalyst will dispatch
526to the C<hello> action and pass the value C<23> as an argument to it
527after the context. It does so because we have previously used
528C<:CaptureArgs(1)> to declare that it has one path part after itself as
529its argument. We told Catalyst that this is the beginning of the chain
530by specifying C<:Chained('/')>. Also note that instead of saying
531C<:PathPart('hello')> we could also just have said C<:PathPart>, as it
532defaults to the name of the action.
05a90578 533
534After C<hello> has run, Catalyst goes on to dispatch to the C<world>
67869327 535action. This is the last action to be called: Catalyst knows this is an
536endpoint because we did not specify a C<:CaptureArgs>
537attribute. Nevertheless we specify that this action expects an argument,
538but at this point we're using C<:Args(1)> to do that. We could also have
539said C<:Args> or left it out altogether, which would mean this action
540would get all arguments that are there. This action's C<:Chained>
541attribute says C<hello> and tells Catalyst that the C<hello> action in
542the current controller is its parent.
05a90578 543
544With this we have built a chain consisting of two public path parts.
67869327 545C<hello> captures one part of the path as its argument, and also
546specifies the path root as its parent. So this part is
547C</hello/$arg>. The next part is the endpoint C<world>, expecting one
548argument. It sums up to the path part C<world/$arg>. This leads to a
549complete chain of C</hello/$arg/world/$arg> which is matched against the
550requested paths.
551
552This example application would, if run and called by e.g.
553C</hello/23/world/12>, set the stash value C<message> to "Hello" and the
554value C<arg_sum> to "23". The C<world> action would then append "World!"
555to C<message> and add C<12> to the stash's C<arg_sum> value. For the
556sake of simplicity no view is shown. Instead we just put the values of
557the stash into our body. So the output would look like:
05a90578 558
559 Hello World!
560 35
561
67869327 562And our test server would have given us this debugging output for the
05a90578 563request:
564
565 ...
566 [debug] "GET" request for "hello/23/world/12" from "127.0.0.1"
567 [debug] Path is "/greeting/world"
568 [debug] Arguments are "12"
569 [info] Request took 0.164113s (6.093/s)
570 .------------------------------------------+-----------.
571 | Action | Time |
572 +------------------------------------------+-----------+
573 | /greeting/hello | 0.000029s |
574 | /greeting/world | 0.000024s |
575 '------------------------------------------+-----------'
576 ...
577
67869327 578What would be common uses of this dispatch technique? It gives the
579possibility to split up logic that contains steps that each depend on
580each other. An example would be, for example, a wiki path like
05a90578 581C</wiki/FooBarPage/rev/23/view>. This chain can be easily built with
582these actions:
583
584 sub wiki : PathPart('wiki') Chained('/') CaptureArgs(1) {
585 my ( $self, $c, $page_name ) = @_;
586 # load the page named $page_name and put the object
587 # into the stash
588 }
589
590 sub rev : PathPart('rev') Chained('wiki') CaptureArgs(1) {
591 my ( $self, $c, $revision_id ) = @_;
67869327 592 # use the page object in the stash to get at its
05a90578 593 # revision with number $revision_id
594 }
595
596 sub view : PathPart Chained('rev') Args(0) {
597 my ( $self, $c ) = @_;
67869327 598 # display the revision in our stash. Another option
05a90578 599 # would be to forward a compatible object to the action
600 # that displays the default wiki pages, unless we want
601 # a different interface here, for example restore
602 # functionality.
603 }
604
67869327 605It would now be possible to add other endpoints, for example C<restore>
606to restore this specific revision as the current state.
05a90578 607
67869327 608You don't have to put all the chained actions in one controller. The
609specification of the parent through C<:Chained> also takes an absolute
610action path as its argument. Just specify it with a leading C</>.
05a90578 611
612If you want, for example, to have actions for the public paths
67869327 613C</foo/12/edit> and C</foo/12>, just specify two actions with
05a90578 614C<:PathPart('foo')> and C<:Chained('/')>. The handler for the former
67869327 615path needs a C<:CaptureArgs(1)> attribute and a endpoint with
05a90578 616C<:PathPart('edit')> and C<:Chained('foo')>. For the latter path give
617the action just a C<:Args(1)> to mark it as endpoint. This sums up to
618this debugging output:
619
620 ...
621 [debug] Loaded Path Part actions:
622 .-----------------------+------------------------------.
623 | Path Spec | Private |
624 +-----------------------+------------------------------+
625 | /foo/* | /controller/foo_view |
626 | /foo/*/edit | /controller/foo_load (1) |
627 | | => /controller/edit |
628 '-----------------------+------------------------------'
629 ...
630
b0ad47c1 631Here's a more detailed specification of the attributes belonging to
05a90578 632C<:Chained>:
633
634=head2 Attributes
635
636=over 8
637
638=item PathPart
639
640Sets the name of this part of the chain. If it is specified without
641arguments, it takes the name of the action as default. So basically
642C<sub foo :PathPart> and C<sub foo :PathPart('foo')> are identical.
643This can also contain slashes to bind to a deeper level. An action
644with C<sub bar :PathPart('foo/bar') :Chained('/')> would bind to
645C</foo/bar/...>. If you don't specify C<:PathPart> it has the same
646effect as using C<:PathPart>, it would default to the action name.
647
d21a2b27 648=item PathPrefix
649
650Sets PathPart to the path_prefix of the current controller.
651
05a90578 652=item Chained
653
654Has to be specified for every child in the chain. Possible values are
d21a2b27 655absolute and relative private action paths or a single slash C</> to
656tell Catalyst that this is the root of a chain. The attribute
657C<:Chained> without arguments also defaults to the C</> behavior.
658Relative action paths may use C<../> to refer to actions in parent
659controllers.
05a90578 660
67869327 661Because you can specify an absolute path to the parent action, it
662doesn't matter to Catalyst where that parent is located. So, if your
663design requests it, you can redispatch a chain through any controller or
664namespace you want.
05a90578 665
666Another interesting possibility gives C<:Chained('.')>, which chains
67869327 667itself to an action with the path of the current controller's namespace.
05a90578 668For example:
669
670 # in MyApp::Controller::Foo
671 sub bar : Chained CaptureArgs(1) { ... }
672
673 # in MyApp::Controller::Foo::Bar
674 sub baz : Chained('.') Args(1) { ... }
675
676This builds up a chain like C</bar/*/baz/*>. The specification of C<.>
67869327 677as the argument to Chained here chains the C<baz> action to an action
678with the path of the current controller namespace, namely
679C</foo/bar>. That action chains directly to C</>, so the C</bar/*/baz/*>
680chain comes out as the end product.
05a90578 681
d21a2b27 682=item ChainedParent
683
684Chains an action to another action with the same name in the parent
685controller. For Example:
686
687 # in MyApp::Controller::Foo
688 sub bar : Chained CaptureArgs(1) { ... }
689
690 # in MyApp::Controller::Foo::Moo
691 sub bar : ChainedParent Args(1) { ... }
692
693This builds a chain like C</bar/*/bar/*>.
694
05a90578 695=item CaptureArgs
696
67869327 697Must be specified for every part of the chain that is not an
05a90578 698endpoint. With this attribute Catalyst knows how many of the following
67869327 699parts of the path (separated by C</>) this action wants to capture as
700its arguments. If it doesn't expect any, just specify
701C<:CaptureArgs(0)>. The captures get passed to the action's C<@_> right
702after the context, but you can also find them as array references in
05a90578 703C<$c-E<gt>request-E<gt>captures-E<gt>[$level]>. The C<$level> is the
704level of the action in the chain that captured the parts of the path.
705
67869327 706An action that is part of a chain (that is, one that has a C<:Chained>
707attribute) but has no C<:CaptureArgs> attribute is treated by Catalyst
708as a chain end.
05a90578 709
480d94b5 710Allowed values for CaptureArgs is a single integer (CaptureArgs(2), meaning two
711allowed) or you can declare a L<Moose>, L<MooseX::Types> or L<Type::Tiny>
712named constraint such as CaptureArgs(Int,Str) would require two args with
713the first being a Integer and the second a string. You may declare your own
714custom type constraints and import them into the controller namespace:
715
716 package MyApp::Controller::Root;
717
718 use Moose;
719 use MooseX::MethodAttributes;
720 use MyApp::Types qw/Int/;
721
722 extends 'Catalyst::Controller';
723
724 sub chain_base :Chained(/) CaptureArgs(1) { }
725
726 sub any_priority_chain :Chained(chain_base) PathPart('') Args(1) { }
727
728 sub int_priority_chain :Chained(chain_base) PathPart('') Args(Int) { }
729
730See L<Catalyst::RouteMatching> for more.
731
05a90578 732=item Args
733
734By default, endpoints receive the rest of the arguments in the path. You
735can tell Catalyst through C<:Args> explicitly how many arguments your
736endpoint expects, just like you can with C<:CaptureArgs>. Note that this
67869327 737also affects whether this chain is invoked on a request. A chain with an
05a90578 738endpoint specifying one argument will only match if exactly one argument
739exists in the path.
740
741You can specify an exact number of arguments like C<:Args(3)>, including
742C<0>. If you just say C<:Args> without any arguments, it is the same as
67869327 743leaving it out altogether: The chain is matched regardless of the number
05a90578 744of path parts after the endpoint.
745
67869327 746Just as with C<:CaptureArgs>, the arguments get passed to the action in
05a90578 747C<@_> after the context object. They can also be reached through
748C<$c-E<gt>request-E<gt>arguments>.
749
750=back
751
67869327 752=head2 Auto actions, dispatching and forwarding
05a90578 753
754Note that the list of C<auto> actions called depends on the private path
67869327 755of the endpoint of the chain, not on the chained actions way. The
756C<auto> actions will be run before the chain dispatching begins. In
757every other aspect, C<auto> actions behave as documented.
05a90578 758
64111aca 759The C<forward>ing to other actions does just what you would expect. i.e.
e1207438 760only the target action is run. The actions that that action is chained
761to are not run.
762If you C<detach> out of a chain, the rest of the chain will not get
763called after the C<detach>.
05a90578 764
22faeff5 765=head2 match_captures
766
767A method which can optionally be implemented by actions to
768stop chain matching.
769
770See L<Catalyst::Action> for further details.
771
2f381252 772=head1 AUTHORS
141459fa 773
2f381252 774Catalyst Contributors, see Catalyst.pm
141459fa 775
776=head1 COPYRIGHT
777
536bee89 778This library is free software. You can redistribute it and/or modify it under
141459fa 779the same terms as Perl itself.
780
781=cut
782
7831;