Commit | Line | Data |
---|---|---|
b96f127f | 1 | package Catalyst::DispatchType; |
2 | ||
3 | use strict; | |
2633d7dc | 4 | use base 'Class::Accessor::Fast'; |
b96f127f | 5 | |
2633d7dc | 6 | =head1 NAME |
b96f127f | 7 | |
2633d7dc | 8 | Catalyst::DispatchType - DispatchType Base Class |
b96f127f | 9 | |
2633d7dc | 10 | =head1 SYNOPSIS |
11 | ||
12 | See L<Catalyst>. | |
13 | ||
14 | =head1 DESCRIPTION | |
15 | ||
16 | =head1 METHODS | |
17 | ||
b5ecfcf0 | 18 | =head2 $self->list($c) |
a9cbd748 | 19 | |
4ab87e27 | 20 | abstract method, to be implemented by dispatchtypes. Called to display |
21 | info in debug log. | |
22 | ||
a9cbd748 | 23 | =cut |
24 | ||
25 | sub list { } | |
26 | ||
b5ecfcf0 | 27 | =head2 $self->match( $c, $path ) |
2633d7dc | 28 | |
4ab87e27 | 29 | abstract method, to be implemented by dispatchtypes. Returns true if the |
30 | dispatch type matches the given path | |
31 | ||
2633d7dc | 32 | =cut |
33 | ||
34 | sub match { die "Abstract method!" } | |
35 | ||
b5ecfcf0 | 36 | =head2 $self->register( $c, $action ) |
2633d7dc | 37 | |
4ab87e27 | 38 | abstract method, to be implemented by dispatchtypes. Takes a |
39 | context object and a L<Catalyst::Action> object. | |
40 | ||
41 | Should return true if it registers something, or false otherwise. | |
42 | ||
2633d7dc | 43 | =cut |
44 | ||
a9cbd748 | 45 | sub register { } |
2633d7dc | 46 | |
2633d7dc | 47 | =head1 AUTHOR |
48 | ||
49 | Matt S Trout | |
50 | Sebastian Riedel, C<sri@cpan.org> | |
51 | ||
52 | =head1 COPYRIGHT | |
53 | ||
54 | This program is free software, you can redistribute it and/or modify it under | |
55 | the same terms as Perl itself. | |
56 | ||
57 | =cut | |
b96f127f | 58 | |
59 | 1; |