X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FActionContainer.pm;h=9adab59a23e820068695238cd41e6c23856d9184;hb=e16a6c4e6c4d49e73b5286b3186616af14f3f554;hp=14a2fcc49045fc701bd3e4c79053eb8a120d72b5;hpb=79a3189aaa44faea53317e3166ccd36d7603add8;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/ActionContainer.pm b/lib/Catalyst/ActionContainer.pm index 14a2fcc..9adab59 100644 --- a/lib/Catalyst/ActionContainer.pm +++ b/lib/Catalyst/ActionContainer.pm @@ -3,6 +3,21 @@ package Catalyst::ActionContainer; use strict; use base qw/Class::Accessor::Fast/; +=head1 NAME + +Catalyst::ActionContainer - Catalyst Action Container + +=head1 SYNOPSIS + +See L. + +=head1 DESCRIPTION + +This is a container for actions. The dispatcher sets up a tree of these +to represent the various dispatch points in your application. + +=cut + __PACKAGE__->mk_accessors(qw/part actions/); use overload ( @@ -12,39 +27,60 @@ use overload ( ); -=head1 NAME +sub new { + my ( $class, $fields ) = @_; -Catalyst::ActionContainer - Catalyst Action Container + $fields = { part => $fields, actions => {} } unless ref $fields; -=head1 SYNOPSIS + $class->SUPER::new($fields); +} -See L. -=head1 DESCRIPTION + +sub get_action { + my ( $self, $name ) = @_; + return $self->actions->{$name} if defined $self->actions->{$name}; + return; +} + +sub add_action { + my ( $self, $action, $name ) = @_; + $name ||= $action->name; + $self->actions->{$name} = $action; +} + +1; + +__END__ =head1 METHODS -=over 4 +=head2 new(\%data | $part) -=item get_action +Can be called with { part => $part, actions => \%actions } for full +construction or with just a part, which will result in an empty actions +hashref to be populated via add_action later -=cut +=head2 get_action($name) -sub get_action { - my ( $self, $c, $name ) = @_; - return $self->actions->{$name} if defined $self->actions->{$name}; - return; -} +Returns an action from this container based on the action name, or undef + +=head2 add_action($action, [ $name ]) + +Adds an action, optionally providing a name to override $action->name + +=head2 actions -=item actions +Accessor to the actions hashref, containing all actions in this container. -=item part +=head2 part -=back +Accessor to the path part this container resolves to. Also what the container +stringifies to. -=head1 AUTHOR +=head1 AUTHORS -Matt S. Trout +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT