lib/DBIx/Class/Serialize/Storable.pm

   1 package DBIx::Class::Serialize::Storable;
   2 use strict;
   3 use warnings;
   4 use Storable;
   5
   6 use Carp::Clan qw/^DBIx::Class/;
   7 use namespace::clean;
   8
   9 carp 'The Serialize::Storable component is now *DEPRECATED*. It has not '
  10     .'been providing any useful functionality for quite a while, and in fact '
  11     .'destroys prefetched results in its current implementation. Do not use!';
  12
  13
  14 sub STORABLE_freeze {
  15     my ($self, $cloning) = @_;
  16     my $to_serialize = { %$self };
  17
  18     # Dynamic values, easy to recalculate
  19     delete $to_serialize->{$_} for qw/related_resultsets _inflated_column/;
  20
  21     return (Storable::nfreeze($to_serialize));
  22 }
  23
  24 sub STORABLE_thaw {
  25     my ($self, $cloning, $serialized) = @_;
  26
  27     %$self = %{ Storable::thaw($serialized) };
  28 }
  29
  30 1;
  31
  32 __END__
  33
  34 =head1 NAME
  35
  36     DBIx::Class::Serialize::Storable - hooks for Storable nfreeze/thaw
  37
  38 =head1 DEPRECATION NOTE
  39
  40 This component is now B<DEPRECATED>. It has not been providing any useful
  41 functionality for quite a while, and in fact destroys prefetched results
  42 in its current implementation. Do not use!
  43
  44 =head1 SYNOPSIS
  45
  46     # in a table class definition
  47     __PACKAGE__->load_components(qw/Serialize::Storable/);
  48
  49     # meanwhile, in a nearby piece of code
  50     my $cd = $schema->resultset('CD')->find(12);
  51     # if the cache uses Storable, this will work automatically
  52     $cache->set($cd->ID, $cd);
  53
  54 =head1 DESCRIPTION
  55
  56 This component adds hooks for Storable so that row objects can be
  57 serialized. It assumes that your row object class (C<result_class>) is
  58 the same as your table class, which is the normal situation.
  59
  60 =head1 HOOKS
  61
  62 The following hooks are defined for L<Storable> - see the
  63 documentation for L<Storable/Hooks> for detailed information on these
  64 hooks.
  65
  66 =head2 STORABLE_freeze
  67
  68 The serializing hook, called on the object during serialization. It
  69 can be inherited, or defined in the class itself, like any other
  70 method.
  71
  72 =head2 STORABLE_thaw
  73
  74 The deserializing hook called on the object during deserialization.
  75
  76 =head1 AUTHORS
  77
  78 David Kamholz <dkamholz@cpan.org>
  79
  80 =head1 LICENSE
  81
  82 You may distribute this code under the same terms as Perl itself.
  83
  84 =cut