1Catalyst::DispatchType(U3s)er Contributed Perl DocumentatCiaotnalyst::DispatchType(3)
2
3
4
6 Catalyst::DispatchType - DispatchType Base Class
7
9 See Catalyst.
10
12 This is an abstract base class for Dispatch Types.
13
14 From a code perspective, dispatch types are used to find which actions
15 to call for a given request URL. Website authors will typically work
16 with them via subroutine names attributes; a description of dispatch at
17 the attribute/URL level is given in Catalyst::Manual::Intro.
18
20 $self->list($c)
21 abstract method, to be implemented by dispatchtypes. Called to display
22 info in debug log.
23
24 $self->match( $c, $path )
25 abstract method, to be implemented by dispatchtypes. Returns true if
26 the dispatch type matches the given path
27
28 $self->register( $c, $action )
29 abstract method, to be implemented by dispatchtypes. Takes a context
30 object and a Catalyst::Action object.
31
32 Should return true if it registers something, or false otherwise.
33
34 $self->uri_for_action( $action, \@captures )
35 abstract method, to be implemented by dispatchtypes. Takes a
36 Catalyst::Action object and an arrayref of captures, and should return
37 either a URI part which if placed in $c->req->path would cause
38 $self->match to match this action and set $c->req->captures to the
39 supplied arrayref, or undef if unable to do so.
40
41 $self->expand_action
42 Default fallback, returns nothing. See Catalyst::Dispatcher for more
43 info about expand_action.
44
46 Catalyst Contributors, see Catalyst.pm
47
49 This library is free software. You can redistribute it and/or modify it
50 under the same terms as Perl itself.
51
52
53
54perl v5.32.0 2020-07-28 Catalyst::DispatchType(3)