X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSetManager.pm;h=46aa406bebb3009891cb8a275bd682684df78e2f;hb=d09c569a37b1bd7b79bcffd4c638d6816ac6c62a;hp=c8e3bd6a0854379d515329ff31a19acea667313c;hpb=e8861f71b6876901a05c98452b8bce5d84ca6420;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSetManager.pm b/lib/DBIx/Class/ResultSetManager.pm index c8e3bd6..46aa406 100644 --- a/lib/DBIx/Class/ResultSetManager.pm +++ b/lib/DBIx/Class/ResultSetManager.pm @@ -1,22 +1,83 @@ package DBIx::Class::ResultSetManager; use strict; +use warnings; use base 'DBIx::Class'; use Class::Inspector; -__PACKAGE__->mk_classdata($_) for qw/ base_resultset_class table_resultset_class_suffix /; +=head1 NAME + +DBIx::Class::ResultSetManager - helpful methods for managing resultset +classes (EXPERIMENTAL) + +=head1 SYNOPSIS + + # in a table class + __PACKAGE__->load_components(qw/ResultSetManager Core/); # note order! + __PACKAGE__->load_resultset_components(qw/AlwaysRS/); + + # will be removed from the table class and inserted into a + # table-specific resultset class + sub search_by_year_desc : ResultSet { + my $self = shift; + my $cond = shift; + my $attrs = shift || {}; + $attrs->{order_by} = 'year DESC'; + $self->search($cond, $attrs); + } + + $rs = $schema->resultset('CD')->search_by_year_desc({ artist => 'Tool' }); + +=head1 DESCRIPTION + +This package implements two useful features for customizing resultset +classes. C loads components in addition to +C (or whatever you set as +C). Any methods tagged with the C +attribute will be moved into a table-specific resultset class (by +default called C, but configurable via +C). Most of the magic is done when you +call C<< __PACKAGE__->table >>. + +=cut + +__PACKAGE__->mk_classdata($_) + for qw/ base_resultset_class table_resultset_class_suffix /; __PACKAGE__->base_resultset_class('DBIx::Class::ResultSet'); __PACKAGE__->table_resultset_class_suffix('::_resultset'); +=head2 table + +Stacks on top of the normal L C method. Any +methods tagged with the C attribute will be moved into a +table-specific resultset class (by default called +C, but configurable via +C). The magic for this is done within +this C<< __PACKAGE__->table >> call. + +=cut + sub table { my ($self,@rest) = @_; my $ret = $self->next::method(@rest); if (@rest) { $self->_register_attributes; - $self->_register_resultset_class; + $self->_register_resultset_class; } return $ret; } +=head2 load_resultset_components + + # in a table class + __PACKAGE__->load_components(qw/ResultSetManager Core/); # note order! + __PACKAGE__->load_resultset_components(qw/AlwaysRS/); + +C loads components in addition to +C (or whatever you set as +C). + +=cut + sub load_resultset_components { my ($self,@comp) = @_; my $resultset_class = $self->_setup_resultset_class; @@ -25,9 +86,9 @@ sub load_resultset_components { sub _register_attributes { my $self = shift; - return unless $self->can('_attr_cache'); - my $cache = $self->_attr_cache; + return if keys %$cache == 0; + foreach my $meth (@{Class::Inspector->methods($self) || []}) { my $attrs = $cache->{$self->can($meth)}; next unless $attrs; @@ -35,7 +96,7 @@ sub _register_attributes { no strict 'refs'; my $resultset_class = $self->_setup_resultset_class; *{"$resultset_class\::$meth"} = $self->can($meth); - undef *{"$self\::$meth"}; + delete ${"${self}::"}{$meth}; } } } @@ -55,37 +116,15 @@ sub _register_resultset_class { my $resultset_class = $self . $self->table_resultset_class_suffix; no strict 'refs'; if (@{"$resultset_class\::ISA"}) { - $self->result_source_instance->resultset_class($resultset_class); + $self->result_source_instance->resultset_class($resultset_class); } else { - $self->result_source_instance->resultset_class($self->base_resultset_class); + $self->result_source_instance->resultset_class + ($self->base_resultset_class); } } 1; -__END__ - -=head1 NAME - - DBIx::Class::ResultSetManager - helpful methods for managing resultset classes (EXPERIMENTAL) - -=head1 SYNOPSIS - - # in a table class - __PACKAGE__->load_components(qw/ResultSetManager/); - __PACKAGE__->load_resultset_components(qw/AlwaysRS/); - - # will be removed from the table class and inserted into a table-specific resultset class - sub foo : resultset { ... } - -=head1 DESCRIPTION - -This package implements two useful features for customizing resultset classes. -C loads components in addition to C -(or whatever you set as C). Any methods tagged with the C -attribute will be moved into a table-specific resultset class (by default called -C). - =head1 AUTHORS David Kamholz