FAQ update: Minor correction from Richard Jolly, mention search_rs, wrap lines, and...
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / InflateColumn.pm
index db61d50..de68b23 100644 (file)
@@ -2,7 +2,7 @@ package DBIx::Class::InflateColumn;
 
 use strict;
 use warnings;
-
+use Scalar::Util qw/blessed/;
 
 use base qw/DBIx::Class::Row/;
 
@@ -83,20 +83,15 @@ sub _inflated_column {
   return $inflate->($value, $self);
 }
 
-sub _deflate_column {
-  my ($self, $col) = @_;
-  return if exists $self->{_column_data}{$col};
-  my $value = $self->{_inflated_column}{$col};
-  if (ref $value) {
-    my $info = $self->column_info($col) or
-      $self->throw_exception("No column info for $col");
-    if (exists $info->{_inflate_info}) {
-      my $deflate = $info->{_inflate_info}{deflate};
-      $self->throw_exception("No deflator for $col") unless defined $deflate;
-      $value = $deflate->($value, $self);          
-    }
-  }
-  $self->store_column($col, $value);
+sub _deflated_column {
+  my ($self, $col, $value) = @_;
+  return $value unless ref $value; # If it's not an object, don't touch it
+  my $info = $self->column_info($col) or
+    $self->throw_exception("No column info for $col");
+  return $value unless exists $info->{_inflate_info};
+  my $deflate = $info->{_inflate_info}{deflate};
+  $self->throw_exception("No deflator for $col") unless defined $deflate;
+  return $deflate->($value, $self);
 }
 
 =head2 get_inflated_column
@@ -114,7 +109,6 @@ 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} =
@@ -132,11 +126,13 @@ analogous to L<DBIx::Class::Row/set_column>.
 
 sub set_inflated_column {
   my ($self, $col, $obj) = @_;
-  my $old = $self->get_inflated_column($col);
-  my $ret = $self->store_inflated_column($col, $obj);
-  $self->{_dirty_columns}{$col} = 1
-    if (defined $old ^ defined $ret) || (defined $old && $old ne $ret);
-  return $ret;
+  $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
@@ -144,35 +140,64 @@ sub set_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<DBIx::Class::Row/store_column>.
+as dirty. This is directly analogous to L<DBIx::Class::Row/store_column>.
 
 =cut
 
 sub store_inflated_column {
   my ($self, $col, $obj) = @_;
-  unless (ref $obj) {
-    delete $self->{_inflated_column}{$col};
-    return $self->store_column($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<DBIx::Class::Row/get_column>. 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) = @_;
-  $self->_deflate_column($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);
 }
 
+=head2 get_columns 
+
+Returns the get_column info for all columns as a hash,
+just like L<DBIx::Class::Row/get_columns>.  Handles inflation just
+like L</get_column>.
+
+=cut
+
 sub get_columns {
   my $self = shift;
   if (exists $self->{_inflated_column}) {
-    $self->_deflate_column($_) for keys %{$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;
 }
 
+=head2 has_column_loaded
+
+Like L<DBIx::Class::Row/has_column_loaded>, 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};