mro compat stuff

[catagits/Catalyst-Runtime.git] / lib / Catalyst / DispatchType.pm

diff --git a/lib/Catalyst/DispatchType.pm b/lib/Catalyst/DispatchType.pm
index 4adba13..874963a 100644 (file)
--- a/lib/Catalyst/DispatchType.pm
+++ b/lib/Catalyst/DispatchType.pm
@@ -1,14 +1,77 @@
 package Catalyst::DispatchType;
 
-use strict;
+use MRO::Compat;
+use mro 'c3';
+use Moose; # using it to add Moose::Object to @ISA ...
+no Moose;
 
-sub new {        # Dumbass constructor
-    my ( $class, $attrs ) = @_;
-    return bless { %{ $attrs || {} } }, $class;
-}
+=head1 NAME
 
-sub prepare_action { die "Abstract method!"; }
+Catalyst::DispatchType - DispatchType Base Class
 
-sub register_action { return; }
+=head1 SYNOPSIS
+
+See L<Catalyst>.
+
+=head1 DESCRIPTION
+
+This is an abstract base class for Dispatch Types. 
+
+=head1 METHODS
+
+=head2 $self->list($c)
+
+abstract method, to be implemented by dispatchtypes. Called to display
+info in debug log.
+
+=cut
+
+sub list { }
+
+=head2 $self->match( $c, $path )
+
+abstract method, to be implemented by dispatchtypes. Returns true if the
+dispatch type matches the given path
+
+=cut
+
+sub match { die "Abstract method!" }
+
+=head2 $self->register( $c, $action )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+context object and a L<Catalyst::Action> object. 
+
+Should return true if it registers something, or false otherwise.
+
+=cut
+
+sub register { }
+
+=head2 $self->uri_for_action( $action, \@captures )
+
+abstract method, to be implemented by dispatchtypes. Takes a
+L<Catalyst::Action> object and an arrayref of captures, and should
+return either a URI part which if placed in $c->req->path would cause
+$self->match to match this action and set $c->req->captures to the supplied
+arrayref, or undef if unable to do so.
+
+=cut
+
+sub uri_for_action { }
+
+=head1 AUTHOR
+
+Matt S Trout
+Sebastian Riedel, C<sri@cpan.org>
+
+=head1 COPYRIGHT
+
+This program is free software, you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=cut
+
+__PACKAGE__->meta->make_immutable;
 
 1;