lib/Catalyst/DispatchType/Index.pm

   1 package Catalyst::DispatchType::Index;
   2
   3 use strict;
   4 use base qw/Catalyst::DispatchType/;
   5
   6 =head1 NAME
   7
   8 Catalyst::DispatchType::Index - Index DispatchType
   9
  10 =head1 SYNOPSIS
  11
  12 See L<Catalyst>.
  13
  14 =head1 DESCRIPTION
  15
  16 =head1 METHODS
  17
  18 =head2 $self->match( $c, $path )
  19
  20 Check if there's an index action for a given path, and set it up to use it
  21 if there is; only matches a full URI - if $c->req->args is already set
  22 this DispatchType is guaranteed not to match.
  23
  24 =cut
  25
  26 sub match {
  27     my ( $self, $c, $path ) = @_;
  28     return if @{ $c->req->args };
  29     my $result = $c->get_action( 'index', $path );
  30
  31     if ($result && $result->match($c)) {
  32         $c->action($result);
  33         $c->namespace( $result->namespace );
  34         $c->req->action('index');
  35         $c->req->match( $c->req->path );
  36         return 1;
  37     }
  38     return 0;
  39 }
  40
  41 =head2 $self->uri_for_action( $action, $captures )
  42
  43 get a URI part for an action; always returns undef is $captures is set
  44 since index actions don't have captures
  45
  46 =cut
  47
  48 sub uri_for_action {
  49     my ( $self, $action, $captures ) = @_;
  50
  51     return undef if @$captures;
  52
  53     return undef unless $action->name eq 'index';
  54
  55     return "/".$action->namespace;
  56 }
  57
  58 =head1 AUTHORS
  59
  60 Catalyst Contributors, see Catalyst.pm
  61
  62 =head1 COPYRIGHT
  63
  64 This program is free software, you can redistribute it and/or modify it under
  65 the same terms as Perl itself.
  66
  67 =cut
  68
  69 1;