lib/DBIx/Class/InflateColumn.pm

   1 package DBIx::Class::InflateColumn;
   2
   3 use strict;
   4 use warnings;
   5
   6
   7 use base qw/DBIx::Class::Row/;
   8
   9 =head1 NAME
  10
  11 DBIx::Class::InflateColumn - Automatically create objects from column data
  12
  13 =head1 SYNOPSIS
  14
  15     # In your table classes
  16     __PACKAGE__->inflate_column('column_name', {
  17         inflate => sub { ... },
  18         deflate => sub { ... },
  19     });
  20
  21 =head1 DESCRIPTION
  22
  23 This component translates column data into objects, i.e. "inflating"
  24 the column data. It also "deflates" objects into an appropriate format
  25 for the database.
  26
  27 It can be used, for example, to automatically convert to and from
  28 L<DateTime> objects for your date and time fields.
  29
  30 =head1 METHODS
  31
  32 =head2 inflate_column
  33
  34 Instruct L<DBIx::Class> to inflate the given column.
  35
  36 In addition to the column name, you must provide C<inflate> and
  37 C<deflate> methods. The C<inflate> method is called when you access
  38 the field, while the C<deflate> method is called when the field needs
  39 to used by the database.
  40
  41 For example, if you have a table C<events> with a timestamp field
  42 named C<insert_time>, you could inflate the column in the
  43 corresponding table class using something like:
  44
  45     __PACKAGE__->inflate_column('insert_time', {
  46         inflate => sub { DateTime::Format::Pg->parse_datetime(shift); },
  47         deflate => sub { DateTime::Format::Pg->format_datetime(shift); },
  48     });
  49
  50 (Replace L<DateTime::Format::Pg> with the appropriate module for your
  51 database, or consider L<DateTime::Format::DBI>.)
  52
  53 The coderefs you set for inflate and deflate are called with two parameters,
  54 the first is the value of the column to be inflated/deflated, the second is the
  55 row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> on
  56 it, to feed to L<DateTime::Format::DBI>.
  57
  58 In this example, calls to an event's C<insert_time> accessor return a
  59 L<DateTime> object. This L<DateTime> object is later "deflated" when
  60 used in the database layer.
  61
  62 =cut
  63
  64 sub inflate_column {
  65   my ($self, $col, $attrs) = @_;
  66   $self->throw_exception("No such column $col to inflate")
  67     unless $self->has_column($col);
  68   $self->throw_exception("inflate_column needs attr hashref")
  69     unless ref $attrs eq 'HASH';
  70   $self->column_info($col)->{_inflate_info} = $attrs;
  71   $self->mk_group_accessors('inflated_column' => $col);
  72   return 1;
  73 }
  74
  75 sub _inflated_column {
  76   my ($self, $col, $value) = @_;
  77   return $value unless defined $value; # NULL is NULL is NULL
  78   my $info = $self->column_info($col)
  79     or $self->throw_exception("No column info for $col");
  80   return $value unless exists $info->{_inflate_info};
  81   my $inflate = $info->{_inflate_info}{inflate};
  82   $self->throw_exception("No inflator for $col") unless defined $inflate;
  83   return $inflate->($value, $self);
  84 }
  85
  86 sub _deflate_column {
  87   my ($self, $col) = @_;
  88   return if exists $self->{_column_data}{$col};
  89   my $value = $self->{_inflated_column}{$col};
  90   if (ref $value) {
  91     my $info = $self->column_info($col) or
  92       $self->throw_exception("No column info for $col");
  93     if (exists $info->{_inflate_info}) {
  94       my $deflate = $info->{_inflate_info}{deflate};
  95       $self->throw_exception("No deflator for $col") unless defined $deflate;
  96       $value = $deflate->($value, $self);
  97     }
  98   }
  99   $self->store_column($col, $value);
 100 }
 101
 102 =head2 get_inflated_column
 103
 104   my $val = $obj->get_inflated_column($col);
 105
 106 Fetch a column value in its inflated state.  This is directly
 107 analogous to L<DBIx::Class::Row/get_column> in that it only fetches a
 108 column already retreived from the database, and then inflates it.
 109 Throws an exception if the column requested is not an inflated column.
 110
 111 =cut
 112
 113 sub get_inflated_column {
 114   my ($self, $col) = @_;
 115   $self->throw_exception("$col is not an inflated column")
 116     unless exists $self->column_info($col)->{_inflate_info};
 117
 118   return $self->{_inflated_column}{$col}
 119     if exists $self->{_inflated_column}{$col};
 120   return $self->{_inflated_column}{$col} =
 121            $self->_inflated_column($col, $self->get_column($col));
 122 }
 123
 124 =head2 set_inflated_column
 125
 126   my $copy = $obj->set_inflated_column($col => $val);
 127
 128 Sets a column value from an inflated value.  This is directly
 129 analogous to L<DBIx::Class::Row/set_column>.
 130
 131 =cut
 132
 133 sub set_inflated_column {
 134   my ($self, $col, $obj) = @_;
 135   my $old = $self->get_inflated_column($col);
 136   my $ret = $self->store_inflated_column($col, $obj);
 137   $self->{_dirty_columns}{$col} = 1
 138     if (defined $old ^ defined $ret) || (defined $old && $old ne $ret);
 139   return $ret;
 140 }
 141
 142 =head2 store_inflated_column
 143
 144   my $copy = $obj->store_inflated_column($col => $val);
 145
 146 Sets a column value from an inflated value without marking the column
 147 as dirty.  This is directly analogous to
 148 L<DBIx::Class::Row/store_column>.
 149
 150 =cut
 151
 152 sub store_inflated_column {
 153   my ($self, $col, $obj) = @_;
 154   unless (ref $obj) {
 155     delete $self->{_inflated_column}{$col};
 156     return $self->store_column($col, $obj);
 157   }
 158   delete $self->{_column_data}{$col};
 159   return $self->{_inflated_column}{$col} = $obj;
 160 }
 161
 162 sub get_column {
 163   my ($self, $col) = @_;
 164   $self->_deflate_column($col);
 165   return $self->next::method($col);
 166 }
 167
 168 sub get_columns {
 169   my $self = shift;
 170   if (exists $self->{_inflated_column}) {
 171     $self->_deflate_column($_) for keys %{$self->{_inflated_column}};
 172   }
 173   return $self->next::method;
 174 }
 175
 176 sub has_column_loaded {
 177   my ($self, $col) = @_;
 178   return 1 if exists $self->{_inflated_column}{$col};
 179   return $self->next::method($col);
 180 }
 181
 182 =head2 update
 183
 184 Updates a row in the same way as L<DBIx::Class::Row/update>, handling
 185 inflation and deflation of columns appropriately.
 186
 187 =cut
 188
 189 sub update {
 190   my ($class, $attrs, @rest) = @_;
 191   foreach my $key (keys %{$attrs||{}}) {
 192     if (ref $attrs->{$key}
 193           && exists $class->column_info($key)->{_inflate_info}) {
 194       $class->set_inflated_column($key, delete $attrs->{$key});
 195     }
 196   }
 197   return $class->next::method($attrs, @rest);
 198 }
 199
 200 =head2 new
 201
 202 Creates a row in the same way as L<DBIx::Class::Row/new>, handling
 203 inflation and deflation of columns appropriately.
 204
 205 =cut
 206
 207 sub new {
 208   my ($class, $attrs, @rest) = @_;
 209   my $inflated;
 210   foreach my $key (keys %{$attrs||{}}) {
 211     $inflated->{$key} = delete $attrs->{$key}
 212       if ref $attrs->{$key} && exists $class->column_info($key)->{_inflate_info};
 213   }
 214   my $obj = $class->next::method($attrs, @rest);
 215   $obj->{_inflated_column} = $inflated if $inflated;
 216   return $obj;
 217 }
 218
 219 =head1 SEE ALSO
 220
 221 =over 4
 222
 223 =item L<DBIx::Class::Core> - This component is loaded as part of the
 224       "core" L<DBIx::Class> components; generally there is no need to
 225       load it directly
 226
 227 =back
 228
 229 =head1 AUTHOR
 230
 231 Matt S. Trout <mst@shadowcatsystems.co.uk>
 232
 233 =head1 CONTRIBUTORS
 234
 235 Daniel Westermann-Clark <danieltwc@cpan.org> (documentation)
 236
 237 =head1 LICENSE
 238
 239 You may distribute this code under the same terms as Perl itself.
 240
 241 =cut
 242
 243 1;