diff options
author | groditi <groditi@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2009-12-15 21:06:24 +0000 |
---|---|---|
committer | groditi <groditi@03d0b0b2-0e1a-0410-a411-fdb2f4bd65d7> | 2009-12-15 21:06:24 +0000 |
commit | aff8f204bc4c7651c9b801a0bee12605b88a706a (patch) | |
tree | e80625ba56510628730b69e5efca1cbf92df4d45 /lib/Reaction/UI/Controller/Role/GetCollection.pm | |
parent | a722f3e3e226a7319f69722de01c06792b3cf2c3 (diff) | |
parent | 931cbc8d6673ec352b369ae2f70f01ff96b4f507 (diff) | |
download | reaction-aff8f204bc4c7651c9b801a0bee12605b88a706a.tar.gz reaction-aff8f204bc4c7651c9b801a0bee12605b88a706a.zip |
r31501@martha (orig r1230): groditi | 2009-09-11 09:36:16 -0400
initial refactor of CRUD controller actions as roles
Diffstat (limited to 'lib/Reaction/UI/Controller/Role/GetCollection.pm')
-rw-r--r-- | lib/Reaction/UI/Controller/Role/GetCollection.pm | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/lib/Reaction/UI/Controller/Role/GetCollection.pm b/lib/Reaction/UI/Controller/Role/GetCollection.pm new file mode 100644 index 0000000..8f40ce2 --- /dev/null +++ b/lib/Reaction/UI/Controller/Role/GetCollection.pm @@ -0,0 +1,104 @@ +package Reaction::UI::Controller::Role::GetCollection; + +use Moose::Role -traits => 'MethodAttributes'; + +has model_name => (isa => 'Str', is => 'rw', required => 1); +has collection_name => (isa => 'Str', is => 'rw', required => 1); + +sub get_collection { + my ($self, $c) = @_; + my $model = $c->model( $self->model_name ); + confess "Failed to find Catalyst model named: " . $self->model_name + unless $model; + my $collection = $self->collection_name; + if( my $meth = $model->can( $collection ) ){ + return $model->$meth; + } elsif ( my $meta = $model->can('meta') ){ + if ( my $attr = $model->$meta->find_attribute_by_name($collection) ) { + my $reader = $attr->get_read_method; + return $model->$reader; + } + } + confess "Failed to find collection $collection"; +} + +1; + +__END__; + +=head1 NAME + +Reaction::UI::Controller::Role::GetCollection + +=head1 DESCRIPTION + +Provides a C<get_collection> method, which fetches an C<Collection> object +from a specified model. + +=head1 SYNOPSYS + + package MyApp::Controller::Foo; + + use base 'Reaction::Controller'; + use Reaction::Class; + + with 'Reaction::UI::Controller::Role::GetCollection'; + + __PACKAGE__->config( model_name => 'MyAppIM', collection_name => 'foos' ); + + sub bar :Local { + my($self, $c) = @_; + my $obj = $self->get_collection($c)->find( $some_key ); + } + +=head1 ATTRIBUTES + +=head2 model_name + +The name of the model this controller will use as it's data source. Should be a +name that can be passed to C<$C-E<gt>model> + +=head2 collection_name + +The name of the collection whithin the model that this Controller will be +utilizing. + +=head1 METHODS + +=head2 get_collection $c + +Returns an instance of the collection this controller uses. + +=head1 SEE ALSO + +=over4 + +=item L<Reaction::UI::Controller> + +=item L<Reaction::UI::Controller::Role::Action::Simple> + +=item L<Reaction::UI::Controller::Role::Action::Object> + +=item L<Reaction::UI::Controller::Role::Action::List> + +=item L<Reaction::UI::Controller::Role::Action::View> + +=item L<Reaction::UI::Controller::Role::Action::Create> + +=item L<Reaction::UI::Controller::Role::Action::Update> + +=item L<Reaction::UI::Controller::Role::Action::Delete> + +=item L<Reaction::UI::Controller::Role::Action::DeleteAll> + +=back + +=head1 AUTHORS + +See L<Reaction::Class> for authors. + +=head1 LICENSE + +See L<Reaction::Class> for the license. + +=cut |