- move Serialize.pm to Serialize/Storable.pm

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

diff --git a/lib/DBIx/Class/Serialize/Storable.pm b/lib/DBIx/Class/Serialize/Storable.pm
new file mode 100644 (file)
index 0000000..48c4597
--- /dev/null
+++ b/lib/DBIx/Class/Serialize/Storable.pm
@@ -0,0 +1,49 @@
+package DBIx::Class::Serialize::Storable;
+use strict;
+use Storable;
+
+sub STORABLE_freeze {
+    my ($self,$cloning) = @_;
+    my $to_serialize = { %$self };
+    delete $to_serialize->{result_source};
+    return (Storable::freeze($to_serialize));
+}
+
+sub STORABLE_thaw {
+    my ($self,$cloning,$serialized) = @_;
+    %$self = %{ Storable::thaw($serialized) };
+    $self->result_source($self->result_source_instance);
+}
+
+1;
+
+__END__
+
+=head1 NAME 
+
+    DBIx::Class::Serialize::Storable - hooks for Storable freeze/thaw (EXPERIMENTAL)
+
+=head1 SYNOPSIS
+
+    # in a table class definition
+    __PACKAGE__->load_components(qw/Serialize::Storable/);
+    
+    # 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