- add docs to Serialize and ResultSetManager

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

diff --git a/lib/DBIx/Class/Serialize.pm b/lib/DBIx/Class/Serialize.pm
index 0db5176..86e3d2f 100644 (file)
--- a/lib/DBIx/Class/Serialize.pm
+++ b/lib/DBIx/Class/Serialize.pm
@@ -14,10 +14,37 @@ sub STORABLE_thaw {
     my ($self,$cloning,$serialized) = @_;
     %$self = %{ thaw($serialized) };
     $self->result_source($self->result_source_instance);
-#    no strict 'refs';
-#    my $class = ${(ref $self) . '::ISA'}[0];
-#    my $schema = $self->result_source_instance->schema;
-#    $self->result_source($schema->source($class));
 }
 
-1;
\ No newline at end of file
+1;
+
+__END__
+
+=head1 NAME 
+
+    DBIx::Class::Serialize - hooks for Storable freeze/thaw (EXPERIMENTAL)
+
+=head1 SYNOPSIS
+
+    # in a table class definition
+    __PACKAGE__->load_components(qw/Serialize/);
+    
+    # meanwhile, in a nearby piece of code
+    my $obj = $schema->resultset('Foo')->find(12);
+    $cache->set($obj->ID, $obj); # if the cache uses Storable, this will work automatically
+
+=head1 DESCRIPTION
+
+This component adds hooks for Storable so that row objects can be serialized. It assumes that
+your row object class (C<result_class>) is the same as your table class, which is the normal
+situation. However, this code is not yet well tested, and so should be considered experimental.
+
+=head1 AUTHORS
+
+David Kamholz <dkamholz@cpan.org>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut