1 package Catalyst::Action;
5 Catalyst::Action - Catalyst Action
9 <form action="[%c.uri_for(c.action)%]">
11 $c->forward( $action->private_path );
15 This class represents a Catalyst Action. You can access the object for the
16 currently dispatched action via $c->action. See the L<Catalyst::Dispatcher>
17 for more information on how actions are dispatched. Actions are defined in
18 L<Catalyst::Controller> subclasses.
23 use Scalar::Util 'looks_like_number';
24 with 'MooseX::Emulate::Class::Accessor::Fast';
25 use namespace::clean -except => 'meta';
27 has class => (is => 'rw');
28 has namespace => (is => 'rw');
29 has 'reverse' => (is => 'rw');
30 has attributes => (is => 'rw');
31 has name => (is => 'rw');
32 has code => (is => 'rw');
34 reader => 'private_path',
38 default => sub { '/'.shift->reverse },
43 # Stringify to reverse for debug output etc.
44 q{""} => sub { shift->{reverse} },
46 # Codulate to execute to invoke the encapsulated action coderef
47 '&{}' => sub { my $self = shift; sub { $self->execute(@_); }; },
49 # Make general $stuff still work
56 no warnings 'recursion';
58 sub dispatch { # Execute ourselves against a context
59 my ( $self, $c ) = @_;
60 return $c->execute( $self->class, $self );
69 my ( $self, $c ) = @_;
70 #would it be unreasonable to store the number of arguments
71 #the action has as its own attribute?
72 #it would basically eliminate the code below. ehhh. small fish
73 return 1 unless exists $self->attributes->{Args};
74 my $args = $self->attributes->{Args}[0];
75 return 1 unless defined($args) && length($args);
76 return scalar( @{ $c->req->args } ) == $args;
82 my ($a1_args) = @{ $a1->attributes->{Args} || [] };
83 my ($a2_args) = @{ $a2->attributes->{Args} || [] };
85 $_ = looks_like_number($_) ? $_ : ~0
86 for $a1_args, $a2_args;
88 return $a1_args <=> $a2_args;
91 __PACKAGE__->meta->make_immutable;
101 The sub attributes that are set for this action, like Local, Path, Private
102 and so on. This determines how the action is dispatched to.
106 Returns the name of the component where this action is defined.
107 Derived by calling the L<Catalyst::Component/catalyst_component_name|catalyst_component_name>
108 method on each component.
112 Returns a code reference to this action.
114 =head2 dispatch( $c )
116 Dispatch this action against a context.
118 =head2 execute( $controller, $c, @args )
120 Execute this action's coderef against a given controller with a given
121 context and arguments
125 Check Args attribute, and makes sure number of args matches the setting.
126 Always returns true if Args is omitted.
130 Compares 2 actions based on the value of the C<Args> attribute, with no C<Args>
131 having the highest precedence.
135 Returns the private namespace this action lives in.
139 Returns the private path for this action.
143 Returns absolute private path for this action. Unlike C<reverse>, the
144 C<private_path> of an action is always suitable for passing to C<forward>.
148 Returns the sub name of this action.
156 Catalyst Contributors, see Catalyst.pm
160 This library is free software. You can redistribute it and/or modify it under
161 the same terms as Perl itself.