- add docs to Serialize and ResultSetManager

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSetManager.pm

diff --git a/lib/DBIx/Class/ResultSetManager.pm b/lib/DBIx/Class/ResultSetManager.pm
index 89076a1..9989b2e 100644 (file)
--- a/lib/DBIx/Class/ResultSetManager.pm
+++ b/lib/DBIx/Class/ResultSetManager.pm
@@ -3,10 +3,9 @@ use strict;
 use base 'DBIx::Class';
 use Class::Inspector;
 
-__PACKAGE__->mk_classdata($_) for qw/ _attr_cache base_resultset_class custom_resultset_class_suffix /;
-__PACKAGE__->_attr_cache({});
+__PACKAGE__->mk_classdata($_) for qw/ base_resultset_class table_resultset_class_suffix /;
 __PACKAGE__->base_resultset_class('DBIx::Class::ResultSet');
-__PACKAGE__->custom_resultset_class_suffix('::_resultset');
+__PACKAGE__->table_resultset_class_suffix('::_resultset');
 
 sub table {
     my ($self,@rest) = @_;
@@ -21,14 +20,10 @@ sub load_resultset_components {
     $resultset_class->load_components(@comp);
 }
 
-sub MODIFY_CODE_ATTRIBUTES {
-    my ($class,$code,@attrs) = @_;
-    $class->_attr_cache({ %{$class->_attr_cache}, $code => [@attrs] });
-    return ();
-}
-
 sub _register_attributes {
     my $self = shift;
+    return unless $self->can('_attr_cache');
+
     my $cache = $self->_attr_cache;
     foreach my $meth (@{Class::Inspector->methods($self) || []}) {
         my $attrs = $cache->{$self->can($meth)};
@@ -40,12 +35,11 @@ sub _register_attributes {
             undef *{"$self\::$meth"};
         }
     }
-    $self->_attr_cache(undef);
 }
 
 sub _setup_resultset_class {
     my $self = shift;
-    my $resultset_class = $self . $self->custom_resultset_class_suffix;
+    my $resultset_class = $self . $self->table_resultset_class_suffix;
     no strict 'refs';
     unless (@{"$resultset_class\::ISA"}) {
         @{"$resultset_class\::ISA"} = ($self->base_resultset_class);
@@ -55,7 +49,7 @@ sub _setup_resultset_class {
 
 sub _register_resultset_class {
     my $self = shift;
-    my $resultset_class = $self . $self->custom_resultset_class_suffix;
+    my $resultset_class = $self . $self->table_resultset_class_suffix;
     no strict 'refs';
     if (@{"$resultset_class\::ISA"}) {
         $self->result_source_instance->resultset_class($resultset_class);        
@@ -64,4 +58,37 @@ sub _register_resultset_class {
     }
 }
 
-1;
\ No newline at end of file
+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<load_resultset_components> loads components in addition to C<DBIx::Class::ResultSet>
+(or whatever you set as C<base_resultset_class>). Any methods tagged with the C<resultset>
+attribute will be moved into a table-specific resultset class (by default called
+C<Class::_resultset>).
+
+=head1 AUTHORS
+
+David Kamholz <dkamholz@cpan.org>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut