File Coverage

blib/lib/Catalyst/DispatchType.pm
Criterion Covered Total %
statement 8 10 80.0
branch n/a
condition n/a
subroutine 4 6 66.7
pod 4 4 100.0
total 16 20 80.0


line stmt bran cond sub pod time code
1             package Catalyst::DispatchType;
2              
3 48     48   654 use strict;
  48         443  
  48         843  
4 48     48   1488 use base 'Class::Accessor::Fast';
  48         521  
  48         823  
5              
6             =head1 NAME
7            
8             Catalyst::DispatchType - DispatchType Base Class
9            
10             =head1 SYNOPSIS
11            
12             See L<Catalyst>.
13            
14             =head1 DESCRIPTION
15            
16             This is an abstract base class for Dispatch Types.
17            
18             =head1 METHODS
19            
20             =head2 $self->list($c)
21            
22             abstract method, to be implemented by dispatchtypes. Called to display
23             info in debug log.
24            
25             =cut
26              
27 0     0 1 0 sub list { }
28              
29             =head2 $self->match( $c, $path )
30            
31             abstract method, to be implemented by dispatchtypes. Returns true if the
32             dispatch type matches the given path
33            
34             =cut
35              
36 0     0 1 0 sub match { die "Abstract method!" }
37              
38             =head2 $self->register( $c, $action )
39            
40             abstract method, to be implemented by dispatchtypes. Takes a
41             context object and a L<Catalyst::Action> object.
42            
43             Should return true if it registers something, or false otherwise.
44            
45             =cut
46              
47 25049     25049 1 357909 sub register { }
48              
49             =head2 $self->uri_for_action( $action, \@captures )
50            
51             abstract method, to be implemented by dispatchtypes. Takes a
52             L<Catalyst::Action> object and an arrayref of captures, and should
53             return either a URI part which if placed in $c->req->path would cause
54             $self->match to match this action and set $c->req->captures to the supplied
55             arrayref, or undef if unable to do so.
56            
57             =cut
58              
59 10     10 1 101 sub uri_for_action { }
60              
61             =head1 AUTHOR
62            
63             Matt S Trout
64             Sebastian Riedel, C<sri@cpan.org>
65            
66             =head1 COPYRIGHT
67            
68             This program is free software, you can redistribute it and/or modify it under
69             the same terms as Perl itself.
70            
71             =cut
72              
73             1;
74