X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn.pm;h=6b06cb091fba89f50f395efd9c955caa3c98979a;hb=096f421241;hp=013c724f8a0e72770522e6b2339d829d969a79df;hpb=75d079145a507a0e5ff89b2676d383f4fd1a5511;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 013c724..6b06cb0 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -2,7 +2,7 @@ package DBIx::Class::InflateColumn; use strict; use warnings; - +use Scalar::Util qw/blessed/; use base qw/DBIx::Class::Row/; @@ -50,6 +50,11 @@ corresponding table class using something like: (Replace L with the appropriate module for your database, or consider L.) +The coderefs you set for inflate and deflate are called with two parameters, +the first is the value of the column to be inflated/deflated, the second is the +row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> on +it, to feed to L. + In this example, calls to an event's C accessor return a L object. This L object is later "deflated" when used in the database layer. @@ -89,68 +94,152 @@ sub _deflated_column { return $deflate->($value, $self); } +=head2 get_inflated_column + + my $val = $obj->get_inflated_column($col); + +Fetch a column value in its inflated state. This is directly +analogous to L in that it only fetches a +column already retreived from the database, and then inflates it. +Throws an exception if the column requested is not an inflated column. + +=cut + sub get_inflated_column { my ($self, $col) = @_; $self->throw_exception("$col is not an inflated column") unless exists $self->column_info($col)->{_inflate_info}; - return $self->{_inflated_column}{$col} if exists $self->{_inflated_column}{$col}; return $self->{_inflated_column}{$col} = $self->_inflated_column($col, $self->get_column($col)); } +=head2 set_inflated_column + + my $copy = $obj->set_inflated_column($col => $val); + +Sets a column value from an inflated value. This is directly +analogous to L. + +=cut + sub set_inflated_column { - my ($self, $col, @rest) = @_; - my $ret = $self->_inflated_column_op('set', $col, @rest); - return $ret; + my ($self, $col, $obj) = @_; + $self->set_column($col, $self->_deflated_column($col, $obj)); + if (blessed $obj) { + $self->{_inflated_column}{$col} = $obj; + } else { + delete $self->{_inflated_column}{$col}; + } + return $obj; } +=head2 store_inflated_column + + my $copy = $obj->store_inflated_column($col => $val); + +Sets a column value from an inflated value without marking the column +as dirty. This is directly analogous to L. + +=cut + sub store_inflated_column { - my ($self, $col, @rest) = @_; - my $ret = $self->_inflated_column_op('store', $col, @rest); - return $ret; + my ($self, $col, $obj) = @_; + unless (blessed $obj) { + delete $self->{_inflated_column}{$col}; + $self->store_column($col => $obj); + return $obj; + } + delete $self->{_column_data}{$col}; + return $self->{_inflated_column}{$col} = $obj; +} + +=head2 get_column + +Gets a column value in the same way as L. If there +is an inflated value stored that has not yet been deflated, it is deflated +when the method is invoked. + +=cut + +sub get_column { + my ($self, $col) = @_; + if (exists $self->{_inflated_column}{$col} + && !exists $self->{_column_data}{$col}) { + $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})); + } + return $self->next::method($col); } -sub _inflated_column_op { - my ($self, $op, $col, $obj) = @_; - my $meth = "${op}_column"; - unless (ref $obj) { - delete $self->{_inflated_column}{$col}; - return $self->$meth($col, $obj); +=head2 get_columns + +Returns the get_column info for all columns as a hash, +just like L. Handles inflation just +like L. + +=cut + +sub get_columns { + my $self = shift; + if (exists $self->{_inflated_column}) { + foreach my $col (keys %{$self->{_inflated_column}}) { + $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})) + unless exists $self->{_column_data}{$col}; + } } + return $self->next::method; +} - my $deflated = $self->_deflated_column($col, $obj); - # Do this now so we don't store if it's invalid +=head2 has_column_loaded - $self->{_inflated_column}{$col} = $obj; - $self->$meth($col, $deflated); - return $obj; +Like L, but also returns true if there +is an inflated value stored. + +=cut + +sub has_column_loaded { + my ($self, $col) = @_; + return 1 if exists $self->{_inflated_column}{$col}; + return $self->next::method($col); } +=head2 update + +Updates a row in the same way as L, handling +inflation and deflation of columns appropriately. + +=cut + sub update { my ($class, $attrs, @rest) = @_; - $attrs ||= {}; - foreach my $key (keys %$attrs) { - if (ref $attrs->{$key} + foreach my $key (keys %{$attrs||{}}) { + if (ref $attrs->{$key} && $class->has_column($key) && exists $class->column_info($key)->{_inflate_info}) { -# $attrs->{$key} = $class->_deflated_column($key, $attrs->{$key}); - $class->set_inflated_column ($key, delete $attrs->{$key}); + $class->set_inflated_column($key, delete $attrs->{$key}); } } return $class->next::method($attrs, @rest); } +=head2 new + +Creates a row in the same way as L, handling +inflation and deflation of columns appropriately. + +=cut + sub new { my ($class, $attrs, @rest) = @_; - $attrs ||= {}; - foreach my $key (keys %$attrs) { - if (ref $attrs->{$key} - && exists $class->column_info($key)->{_inflate_info}) { - $attrs->{$key} = $class->_deflated_column($key, $attrs->{$key}); - } + my $inflated; + foreach my $key (keys %{$attrs||{}}) { + $inflated->{$key} = delete $attrs->{$key} + if ref $attrs->{$key} && $class->has_column($key) + && exists $class->column_info($key)->{_inflate_info}; } - return $class->next::method($attrs, @rest); + my $obj = $class->next::method($attrs, @rest); + $obj->{_inflated_column} = $inflated if $inflated; + return $obj; } =head1 SEE ALSO