refactored to leave synopsis to the top, and move the rest of the pod to the

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

diff --git a/lib/Catalyst/ActionContainer.pm b/lib/Catalyst/ActionContainer.pm
index 4dd4500..63b8fc9 100644 (file)
--- 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<Catalyst>.
+
+=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,21 +27,15 @@ use overload (
 
 );
 
-=head1 NAME
-
-Catalyst::ActionContainer - Catalyst Action Container
+sub new {
+    my ( $class, $fields ) = @_;
 
-=head1 SYNOPSIS
+    $fields = { part => $fields, actions => {} } unless ref $fields;
 
-See L<Catalyst>.
-
-=head1 DESCRIPTION
+    $class->SUPER::new($fields);
+}
 
-=head1 METHODS
 
-=head2 get_action
-
-=cut
 
 sub get_action {
     my ( $self, $name ) = @_;
@@ -34,13 +43,44 @@ sub get_action {
     return;
 }
 
+sub add_action {
+    my ( $self, $action, $name ) = @_;
+    $name ||= $action->name;
+    $self->actions->{$name} = $action;
+}
+
+1;
+
+__END__
+
+=head1 METHODS
+
+=head2 new(\%data | $part)
+
+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
+
+=head2 get_action($name)
+
+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
 
+Accessor to the actions hashref, containing all actions in this container.
+
 =head2 part
 
+Accessor to the path part this container resolves to. Also what the container
+stringifies to.
+
 =head1 AUTHOR
 
-Matt S. Trout
+Matt S. Trout 
 
 =head1 COPYRIGHT