a bit of cleanup as we ponder stable
[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) {
905679b8 250
251
1c34f703 252 if (my $capture_attr = $action->attributes->{CaptureArgs}) {
a82c96cf 253 my $capture_count = $action->number_of_captures|| 0;
f505df49 254
255 # Short-circuit if not enough remaining parts
3f91cb25 256 next TRY_ACTION unless @parts >= $capture_count;
f505df49 257
141459fa 258 my @captures;
259 my @parts = @parts; # localise
7a7ac23c 260
1c34f703 261 # strip CaptureArgs into list
3f91cb25 262 push(@captures, splice(@parts, 0, $capture_count));
7a7ac23c 263
1279064a 264 # check if the action may fit, depending on a given test by the app
a82c96cf 265 next TRY_ACTION unless $action->match_captures($c, \@captures);
1279064a 266
141459fa 267 # try the remaining parts against children of this action
0c78acb6 268 my ($actions, $captures, $action_parts, $n_pathparts) = $self->recurse_match(
141459fa 269 $c, '/'.$action->reverse, \@parts
270 );
2f381252 271 # No best action currently
272 # OR The action has less parts
273 # OR The action has equal parts but less captured data (ergo more defined)
274 if ($actions &&
275 (!$best_action ||
f4dbb497 276 $#$action_parts < $#{$best_action->{parts}} ||
2f381252 277 ($#$action_parts == $#{$best_action->{parts}} &&
0c78acb6 278 $#$captures < $#{$best_action->{captures}} &&
279 $n_pathparts > $best_action->{n_pathparts}))) {
280 my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
6b495723 281 $best_action = {
282 actions => [ $action, @$actions ],
283 captures=> [ @captures, @$captures ],
0c78acb6 284 parts => $action_parts,
285 n_pathparts => scalar(@pathparts) + $n_pathparts,
286 };
6b495723 287 }
288 }
289 else {
7a7ac23c 290 {
291 local $c->req->{arguments} = [ @{$c->req->args}, @parts ];
905679b8 292warn $action;
293
7a7ac23c 294 next TRY_ACTION unless $action->match($c);
295 }
5c6d829d 296 my $args_attr = $action->attributes->{Args}->[0];
2a1c08c0 297 my $args_count = $action->normalized_arg_number;
0c78acb6 298 my @pathparts = split /\//, $action->attributes->{PathPart}->[0];
953c176d 299 # No best action currently
300 # OR This one matches with fewer parts left than the current best action,
301 # And therefore is a better match
b0ad47c1 302 # OR No parts and this expects 0
953c176d 303 # The current best action might also be Args(0),
304 # but we couldn't chose between then anyway so we'll take the last seen
219b4f88 305 if (
306 !$best_action ||
953c176d 307 @parts < @{$best_action->{parts}} ||
219b4f88 308 (
309 !@parts &&
310 defined($args_attr) &&
09914a47 311 (
2a1c08c0 312 $args_count eq "0" &&
7a504990 313 (
314 ($c->config->{use_chained_args_0_special_case}||0) ||
315 (
2a1c08c0 316 exists($best_action->{args_count}) && defined($best_action->{args_count}) ?
317 ($best_action->{args_count} ne 0) : 1
7a504990 318 )
319 )
09914a47 320 )
219b4f88 321 )
322 ){
6b495723 323 $best_action = {
324 actions => [ $action ],
325 captures=> [],
0c78acb6 326 parts => \@parts,
2a1c08c0 327 args_count => $args_count,
0c78acb6 328 n_pathparts => scalar(@pathparts),
329 };
953c176d 330 }
141459fa 331 }
332 }
333 }
0c78acb6 334 return @$best_action{qw/actions captures parts n_pathparts/} if $best_action;
141459fa 335 return ();
336}
337
338=head2 $self->register( $c, $action )
339
05a90578 340Calls register_path for every Path attribute for the given $action.
141459fa 341
342=cut
343
344sub register {
345 my ( $self, $c, $action ) = @_;
346
1dc8af44 347 my @chained_attr = @{ $action->attributes->{Chained} || [] };
141459fa 348
1dc8af44 349 return 0 unless @chained_attr;
141459fa 350
2f381252 351 if (@chained_attr > 1) {
141459fa 352 Catalyst::Exception->throw(
5882c86e 353 "Multiple Chained attributes not supported registering ${action}"
141459fa 354 );
355 }
13c6b4cc 356 my $chained_to = $chained_attr[0];
141459fa 357
13c6b4cc 358 Catalyst::Exception->throw(
359 "Actions cannot chain to themselves registering /${action}"
360 ) if ($chained_to eq '/' . $action);
361
362 my $children = ($self->_children_of->{ $chained_to } ||= {});
141459fa 363
364 my @path_part = @{ $action->attributes->{PathPart} || [] };
365
09461385 366 my $part = $action->name;
141459fa 367
09461385 368 if (@path_part == 1 && defined $path_part[0]) {
369 $part = $path_part[0];
141459fa 370 } elsif (@path_part > 1) {
371 Catalyst::Exception->throw(
f3414019 372 "Multiple PathPart attributes not supported registering " . $action->reverse()
141459fa 373 );
374 }
375
8a6a6581 376 if ($part =~ m(^/)) {
377 Catalyst::Exception->throw(
f3414019 378 "Absolute parameters to PathPart not allowed registering " . $action->reverse()
8a6a6581 379 );
380 }
381
0ca510f0 382 my $encoded_part = URI->new($part)->canonical;
383 $encoded_part =~ s{(?<=[^/])/+\z}{};
792b40ac 384
0ca510f0 385 $action->attributes->{PathPart} = [ $encoded_part ];
386
387 unshift(@{ $children->{$encoded_part} ||= [] }, $action);
141459fa 388
be5cb4e4 389 $self->_actions->{'/'.$action->reverse} = $action;
792b40ac 390
2e29aec2 391 if (exists $action->attributes->{Args} and exists $action->attributes->{CaptureArgs}) {
392 Catalyst::Exception->throw(
bc71493a 393 "Combining Args and CaptureArgs attributes not supported registering " .
394 $action->reverse()
2e29aec2 395 );
dd97c1ac 396 }
397
1c34f703 398 unless ($action->attributes->{CaptureArgs}) {
be5cb4e4 399 unshift(@{ $self->_endpoints }, $action);
792b40ac 400 }
401
402 return 1;
141459fa 403}
404
405=head2 $self->uri_for_action($action, $captures)
406
05a90578 407Get the URI part for the action, using C<$captures> to fill
408the capturing parts.
141459fa 409
410=cut
411
412sub uri_for_action {
413 my ( $self, $action, $captures ) = @_;
414
5882c86e 415 return undef unless ($action->attributes->{Chained}
8b13f357 416 && !$action->attributes->{CaptureArgs});
792b40ac 417
418 my @parts = ();
419 my @captures = @$captures;
420 my $parent = "DUMMY";
421 my $curr = $action;
b6847871 422 # If this is an action chain get the last action in the chain
423 if($curr->can('chain') ) {
424 $curr = ${$curr->chain}[-1];
425 }
792b40ac 426 while ($curr) {
b6847871 427 if (my $cap = $curr->number_of_captures) {
428 return undef unless @captures >= $cap; # not enough captures
429 if ($cap) {
430 unshift(@parts, splice(@captures, -$cap));
8b13f357 431 }
792b40ac 432 }
77771155 433 if (my $pp = $curr->attributes->{PathPart}) {
792b40ac 434 unshift(@parts, $pp->[0])
8b13f357 435 if (defined($pp->[0]) && length($pp->[0]));
792b40ac 436 }
5882c86e 437 $parent = $curr->attributes->{Chained}->[0];
be5cb4e4 438 $curr = $self->_actions->{$parent};
141459fa 439 }
792b40ac 440
441 return undef unless $parent eq '/'; # fail for dangling action
442
443 return undef if @captures; # fail for too many captures
444
445 return join('/', '', @parts);
59d5a638 446
141459fa 447}
448
ae0e35ee 449=head2 $c->expand_action($action)
450
b0ad47c1 451Return a list of actions that represents a chained action. See
ae0e35ee 452L<Catalyst::Dispatcher> for more info. You probably want to
453use the expand_action it provides rather than this directly.
454
455=cut
456
52f71256 457sub expand_action {
458 my ($self, $action) = @_;
459
460 return unless $action->attributes && $action->attributes->{Chained};
461
462 my @chain;
463 my $curr = $action;
464
465 while ($curr) {
466 push @chain, $curr;
467 my $parent = $curr->attributes->{Chained}->[0];
468 $curr = $self->_actions->{$parent};
469 }
470
471 return Catalyst::ActionChain->from_chain([reverse @chain]);
472}
473
e5ecd5bc 474__PACKAGE__->meta->make_immutable;
f4de8c99 4751;
e5ecd5bc 476
05a90578 477=head1 USAGE
478
479=head2 Introduction
480
481The C<Chained> attribute allows you to chain public path parts together
67869327 482by their private names. A chain part's path can be specified with
483C<PathPart> and can be declared to expect an arbitrary number of
484arguments. The endpoint of the chain specifies how many arguments it
485gets through the C<Args> attribute. C<:Args(0)> would be none at all,
486C<:Args> without an integer would be unlimited. The path parts that
487aren't endpoints are using C<CaptureArgs> to specify how many parameters
488they expect to receive. As an example setup:
05a90578 489
490 package MyApp::Controller::Greeting;
491 use base qw/ Catalyst::Controller /;
492
493 # this is the beginning of our chain
494 sub hello : PathPart('hello') Chained('/') CaptureArgs(1) {
495 my ( $self, $c, $integer ) = @_;
496 $c->stash->{ message } = "Hello ";
497 $c->stash->{ arg_sum } = $integer;
498 }
499
500 # this is our endpoint, because it has no :CaptureArgs
501 sub world : PathPart('world') Chained('hello') Args(1) {
502 my ( $self, $c, $integer ) = @_;
503 $c->stash->{ message } .= "World!";
504 $c->stash->{ arg_sum } += $integer;
505
506 $c->response->body( join "<br/>\n" =>
507 $c->stash->{ message }, $c->stash->{ arg_sum } );
508 }
509
510The debug output provides a separate table for chained actions, showing
67869327 511the whole chain as it would match and the actions it contains. Here's an
512example of the startup output with our actions above:
05a90578 513
514 ...
515 [debug] Loaded Path Part actions:
516 .-----------------------+------------------------------.
517 | Path Spec | Private |
518 +-----------------------+------------------------------+
519 | /hello/*/world/* | /greeting/hello (1) |
520 | | => /greeting/world |
521 '-----------------------+------------------------------'
522 ...
523
67869327 524As you can see, Catalyst only deals with chains as whole paths and
525builds one for each endpoint, which are the actions with C<:Chained> but
526without C<:CaptureArgs>.
05a90578 527
528Let's assume this application gets a request at the path
67869327 529C</hello/23/world/12>. What happens then? First, Catalyst will dispatch
530to the C<hello> action and pass the value C<23> as an argument to it
531after the context. It does so because we have previously used
532C<:CaptureArgs(1)> to declare that it has one path part after itself as
533its argument. We told Catalyst that this is the beginning of the chain
534by specifying C<:Chained('/')>. Also note that instead of saying
535C<:PathPart('hello')> we could also just have said C<:PathPart>, as it
536defaults to the name of the action.
05a90578 537
538After C<hello> has run, Catalyst goes on to dispatch to the C<world>
67869327 539action. This is the last action to be called: Catalyst knows this is an
540endpoint because we did not specify a C<:CaptureArgs>
541attribute. Nevertheless we specify that this action expects an argument,
542but at this point we're using C<:Args(1)> to do that. We could also have
543said C<:Args> or left it out altogether, which would mean this action
544would get all arguments that are there. This action's C<:Chained>
545attribute says C<hello> and tells Catalyst that the C<hello> action in
546the current controller is its parent.
05a90578 547
548With this we have built a chain consisting of two public path parts.
67869327 549C<hello> captures one part of the path as its argument, and also
550specifies the path root as its parent. So this part is
551C</hello/$arg>. The next part is the endpoint C<world>, expecting one
552argument. It sums up to the path part C<world/$arg>. This leads to a
553complete chain of C</hello/$arg/world/$arg> which is matched against the
554requested paths.
555
556This example application would, if run and called by e.g.
557C</hello/23/world/12>, set the stash value C<message> to "Hello" and the
558value C<arg_sum> to "23". The C<world> action would then append "World!"
559to C<message> and add C<12> to the stash's C<arg_sum> value. For the
560sake of simplicity no view is shown. Instead we just put the values of
561the stash into our body. So the output would look like:
05a90578 562
563 Hello World!
564 35
565
67869327 566And our test server would have given us this debugging output for the
05a90578 567request:
568
569 ...
570 [debug] "GET" request for "hello/23/world/12" from "127.0.0.1"
571 [debug] Path is "/greeting/world"
572 [debug] Arguments are "12"
573 [info] Request took 0.164113s (6.093/s)
574 .------------------------------------------+-----------.
575 | Action | Time |
576 +------------------------------------------+-----------+
577 | /greeting/hello | 0.000029s |
578 | /greeting/world | 0.000024s |
579 '------------------------------------------+-----------'
580 ...
581
67869327 582What would be common uses of this dispatch technique? It gives the
583possibility to split up logic that contains steps that each depend on
584each other. An example would be, for example, a wiki path like
05a90578 585C</wiki/FooBarPage/rev/23/view>. This chain can be easily built with
586these actions:
587
588 sub wiki : PathPart('wiki') Chained('/') CaptureArgs(1) {
589 my ( $self, $c, $page_name ) = @_;
590 # load the page named $page_name and put the object
591 # into the stash
592 }
593
594 sub rev : PathPart('rev') Chained('wiki') CaptureArgs(1) {
595 my ( $self, $c, $revision_id ) = @_;
67869327 596 # use the page object in the stash to get at its
05a90578 597 # revision with number $revision_id
598 }
599
600 sub view : PathPart Chained('rev') Args(0) {
601 my ( $self, $c ) = @_;
67869327 602 # display the revision in our stash. Another option
05a90578 603 # would be to forward a compatible object to the action
604 # that displays the default wiki pages, unless we want
605 # a different interface here, for example restore
606 # functionality.
607 }
608
67869327 609It would now be possible to add other endpoints, for example C<restore>
610to restore this specific revision as the current state.
05a90578 611
67869327 612You don't have to put all the chained actions in one controller. The
613specification of the parent through C<:Chained> also takes an absolute
614action path as its argument. Just specify it with a leading C</>.
05a90578 615
616If you want, for example, to have actions for the public paths
67869327 617C</foo/12/edit> and C</foo/12>, just specify two actions with
05a90578 618C<:PathPart('foo')> and C<:Chained('/')>. The handler for the former
67869327 619path needs a C<:CaptureArgs(1)> attribute and a endpoint with
05a90578 620C<:PathPart('edit')> and C<:Chained('foo')>. For the latter path give
621the action just a C<:Args(1)> to mark it as endpoint. This sums up to
622this debugging output:
623
624 ...
625 [debug] Loaded Path Part actions:
626 .-----------------------+------------------------------.
627 | Path Spec | Private |
628 +-----------------------+------------------------------+
629 | /foo/* | /controller/foo_view |
630 | /foo/*/edit | /controller/foo_load (1) |
631 | | => /controller/edit |
632 '-----------------------+------------------------------'
633 ...
634
b0ad47c1 635Here's a more detailed specification of the attributes belonging to
05a90578 636C<:Chained>:
637
638=head2 Attributes
639
640=over 8
641
642=item PathPart
643
644Sets the name of this part of the chain. If it is specified without
645arguments, it takes the name of the action as default. So basically
646C<sub foo :PathPart> and C<sub foo :PathPart('foo')> are identical.
647This can also contain slashes to bind to a deeper level. An action
648with C<sub bar :PathPart('foo/bar') :Chained('/')> would bind to
649C</foo/bar/...>. If you don't specify C<:PathPart> it has the same
650effect as using C<:PathPart>, it would default to the action name.
651
d21a2b27 652=item PathPrefix
653
654Sets PathPart to the path_prefix of the current controller.
655
05a90578 656=item Chained
657
658Has to be specified for every child in the chain. Possible values are
d21a2b27 659absolute and relative private action paths or a single slash C</> to
660tell Catalyst that this is the root of a chain. The attribute
661C<:Chained> without arguments also defaults to the C</> behavior.
662Relative action paths may use C<../> to refer to actions in parent
663controllers.
05a90578 664
67869327 665Because you can specify an absolute path to the parent action, it
666doesn't matter to Catalyst where that parent is located. So, if your
667design requests it, you can redispatch a chain through any controller or
668namespace you want.
05a90578 669
670Another interesting possibility gives C<:Chained('.')>, which chains
67869327 671itself to an action with the path of the current controller's namespace.
05a90578 672For example:
673
674 # in MyApp::Controller::Foo
675 sub bar : Chained CaptureArgs(1) { ... }
676
677 # in MyApp::Controller::Foo::Bar
678 sub baz : Chained('.') Args(1) { ... }
679
680This builds up a chain like C</bar/*/baz/*>. The specification of C<.>
67869327 681as the argument to Chained here chains the C<baz> action to an action
682with the path of the current controller namespace, namely
683C</foo/bar>. That action chains directly to C</>, so the C</bar/*/baz/*>
684chain comes out as the end product.
05a90578 685
d21a2b27 686=item ChainedParent
687
688Chains an action to another action with the same name in the parent
689controller. For Example:
690
691 # in MyApp::Controller::Foo
692 sub bar : Chained CaptureArgs(1) { ... }
693
694 # in MyApp::Controller::Foo::Moo
695 sub bar : ChainedParent Args(1) { ... }
696
697This builds a chain like C</bar/*/bar/*>.
698
05a90578 699=item CaptureArgs
700
67869327 701Must be specified for every part of the chain that is not an
05a90578 702endpoint. With this attribute Catalyst knows how many of the following
67869327 703parts of the path (separated by C</>) this action wants to capture as
704its arguments. If it doesn't expect any, just specify
705C<:CaptureArgs(0)>. The captures get passed to the action's C<@_> right
706after the context, but you can also find them as array references in
05a90578 707C<$c-E<gt>request-E<gt>captures-E<gt>[$level]>. The C<$level> is the
708level of the action in the chain that captured the parts of the path.
709
67869327 710An action that is part of a chain (that is, one that has a C<:Chained>
711attribute) but has no C<:CaptureArgs> attribute is treated by Catalyst
712as a chain end.
05a90578 713
480d94b5 714Allowed values for CaptureArgs is a single integer (CaptureArgs(2), meaning two
715allowed) or you can declare a L<Moose>, L<MooseX::Types> or L<Type::Tiny>
716named constraint such as CaptureArgs(Int,Str) would require two args with
717the first being a Integer and the second a string. You may declare your own
718custom type constraints and import them into the controller namespace:
719
720 package MyApp::Controller::Root;
721
722 use Moose;
723 use MooseX::MethodAttributes;
724 use MyApp::Types qw/Int/;
725
726 extends 'Catalyst::Controller';
727
728 sub chain_base :Chained(/) CaptureArgs(1) { }
729
730 sub any_priority_chain :Chained(chain_base) PathPart('') Args(1) { }
731
732 sub int_priority_chain :Chained(chain_base) PathPart('') Args(Int) { }
733
d9f0a350 734If you use a reference type constraint in CaptureArgs, it must be a type
735like Tuple in L<Types::Standard> that allows us to determine the number of
736args to match. Otherwise this will raise an error during startup.
737
480d94b5 738See L<Catalyst::RouteMatching> for more.
739
05a90578 740=item Args
741
742By default, endpoints receive the rest of the arguments in the path. You
743can tell Catalyst through C<:Args> explicitly how many arguments your
744endpoint expects, just like you can with C<:CaptureArgs>. Note that this
67869327 745also affects whether this chain is invoked on a request. A chain with an
05a90578 746endpoint specifying one argument will only match if exactly one argument
747exists in the path.
748
749You can specify an exact number of arguments like C<:Args(3)>, including
750C<0>. If you just say C<:Args> without any arguments, it is the same as
67869327 751leaving it out altogether: The chain is matched regardless of the number
05a90578 752of path parts after the endpoint.
753
67869327 754Just as with C<:CaptureArgs>, the arguments get passed to the action in
05a90578 755C<@_> after the context object. They can also be reached through
756C<$c-E<gt>request-E<gt>arguments>.
757
d9f0a350 758You should see 'Args' in L<Catalyst::Controller> for more details on using
759type constraints in your Args declarations.
760
05a90578 761=back
762
67869327 763=head2 Auto actions, dispatching and forwarding
05a90578 764
765Note that the list of C<auto> actions called depends on the private path
67869327 766of the endpoint of the chain, not on the chained actions way. The
767C<auto> actions will be run before the chain dispatching begins. In
768every other aspect, C<auto> actions behave as documented.
05a90578 769
64111aca 770The C<forward>ing to other actions does just what you would expect. i.e.
e1207438 771only the target action is run. The actions that that action is chained
772to are not run.
773If you C<detach> out of a chain, the rest of the chain will not get
774called after the C<detach>.
05a90578 775
22faeff5 776=head2 match_captures
777
778A method which can optionally be implemented by actions to
779stop chain matching.
780
781See L<Catalyst::Action> for further details.
782
2f381252 783=head1 AUTHORS
141459fa 784
2f381252 785Catalyst Contributors, see Catalyst.pm
141459fa 786
787=head1 COPYRIGHT
788
536bee89 789This library is free software. You can redistribute it and/or modify it under
141459fa 790the same terms as Perl itself.
791
792=cut
793
7941;