lib/Catalyst/Action.pm

   1 package Catalyst::Action;
   2
   3 =head1 NAME
   4
   5 Catalyst::Action - Catalyst Action
   6
   7 =head1 SYNOPSIS
   8
   9     <form action="[%c.uri_for(c.action.reverse)%]">
  10
  11 =head1 DESCRIPTION
  12
  13 This class represents a Catalyst Action. You can access the object for the
  14 currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
  15 for more information on how actions are dispatched. Actions are defined in
  16 L<Catalyst::Controller> subclasses.
  17
  18 =cut
  19
  20 use Moose;
  21
  22 has class => (is => 'rw');
  23 has namespace => (is => 'rw');
  24 has 'reverse' => (is => 'rw');
  25 has attributes => (is => 'rw');
  26 has name => (is => 'rw');
  27 has code => (is => 'rw');
  28
  29 no Moose;
  30
  31 no warnings 'recursion';
  32
  33 #__PACKAGE__->mk_accessors(qw/class namespace reverse attributes name code/);
  34
  35 sub dispatch {    # Execute ourselves against a context
  36     my ( $self, $c ) = @_;
  37     #Moose todo: grrrrrr. this is no good. i don't know enough about it to
  38     # debug it though. why can't we just call the accessor?
  39     #local $c->{namespace} = $self->namespace;
  40     #return $c->execute( $self->class, $self );
  41
  42     #believed to be equivalent:
  43     my $orig = $c->namespace;
  44     $c->namespace($self->namespace);
  45     my $ret = $c->execute( $self->class, $self );
  46     $c->namespace($orig);
  47     return $ret;
  48 }
  49
  50 sub execute {
  51   my $self = shift;
  52   $self->code->(@_);
  53 }
  54
  55 sub match {
  56     my ( $self, $c ) = @_;
  57     #would it be unreasonable to store the number of arguments
  58     #the action has as it's own attribute?
  59     #it would basically eliminate the code below.  ehhh. small fish
  60     return 1 unless exists $self->attributes->{Args};
  61     my $args = $self->attributes->{Args}[0];
  62     return 1 unless defined($args) && length($args);
  63     return scalar( @{ $c->req->args } ) == $args;
  64 }
  65
  66 __PACKAGE__->meta->make_immutable;
  67
  68 1;
  69
  70 __END__
  71
  72 =head1 METHODS
  73
  74 =head2 attributes
  75
  76 The sub attributes that are set for this action, like Local, Path, Private
  77 and so on. This determines how the action is dispatched to.
  78
  79 =head2 class
  80
  81 Returns the class name where this action is defined.
  82
  83 =head2 code
  84
  85 Returns a code reference to this action.
  86
  87 =head2 dispatch( $c )
  88
  89 Dispatch this action against a context
  90
  91 =head2 execute( $controller, $c, @args )
  92
  93 Execute this action's coderef against a given controller with a given
  94 context and arguments
  95
  96 =head2 match( $c )
  97
  98 Check Args attribute, and makes sure number of args matches the setting.
  99 Always returns true if Args is omitted.
 100
 101 =head2 namespace
 102
 103 Returns the private namespace this action lives in.
 104
 105 =head2 reverse
 106
 107 Returns the private path for this action.
 108
 109 =head2 name
 110
 111 returns the sub name of this action.
 112
 113 =head2 meta
 114
 115 Provided by Moose
 116
 117 =head1 AUTHOR
 118
 119 Matt S. Trout
 120
 121 =head1 COPYRIGHT
 122
 123 This program is free software, you can redistribute it and/or modify it under
 124 the same terms as Perl itself.
 125
 126 =cut