doc, removal of source stuff, and Changes

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / FilterColumn.pm

diff --git a/lib/DBIx/Class/FilterColumn.pm b/lib/DBIx/Class/FilterColumn.pm
index 35389ea..9ae5007 100644 (file)
--- a/lib/DBIx/Class/FilterColumn.pm
+++ b/lib/DBIx/Class/FilterColumn.pm
@@ -1,5 +1,4 @@
 package DBIx::Class::FilterColumn;
-
 use strict;
 use warnings;
 
@@ -16,11 +15,11 @@ sub filter_column {
 
   $self->column_info($col)->{_filter_info} = $attrs;
   my $acc = $self->column_info($col)->{accessor};
-  $self->mk_group_accessors('value' => [ (defined $acc ? $acc : $col), $col]);
+  $self->mk_group_accessors(filtered_column => [ (defined $acc ? $acc : $col), $col]);
   return 1;
 }
 
-sub _filtered_column {
+sub _column_from_storage {
   my ($self, $col, $value) = @_;
 
   return $value unless defined $value;
@@ -30,13 +29,13 @@ sub _filtered_column {
 
   return $value unless exists $info->{_filter_info};
 
-  my $filter = $info->{_filter_info}{filter};
+  my $filter = $info->{_filter_info}{filter_from_storage};
   $self->throw_exception("No inflator for $col") unless defined $filter;
 
   return $self->$filter($value);
 }
 
-sub _unfiltered_column {
+sub _column_to_storage {
   my ($self, $col, $value) = @_;
 
   my $info = $self->column_info($col) or
@@ -44,12 +43,12 @@ sub _unfiltered_column {
 
   return $value unless exists $info->{_filter_info};
 
-  my $unfilter = $info->{_filter_info}{unfilter};
+  my $unfilter = $info->{_filter_info}{filter_to_storage};
   $self->throw_exception("No unfilter for $col") unless defined $unfilter;
   return $self->$unfilter($value);
 }
 
-sub get_value {
+sub get_filtered_column {
   my ($self, $col) = @_;
 
   $self->throw_exception("$col is not a filtered column")
@@ -60,13 +59,13 @@ sub get_value {
 
   my $val = $self->get_column($col);
 
-  return $self->{_filtered_column}{$col} = $self->_filtered_column($col, $val);
+  return $self->{_filtered_column}{$col} = $self->_column_from_storage($col, $val);
 }
 
-sub set_value {
+sub set_filtered_column {
   my ($self, $col, $filtered) = @_;
 
-  $self->set_column($col, $self->_unfiltered_column($col, $filtered));
+  $self->set_column($col, $self->_column_to_storage($col, $filtered));
 
   delete $self->{_filtered_column}{$col};
 
@@ -79,26 +78,87 @@ sub update {
     if ($self->has_column($key) &&
           exists $self->column_info($key)->{_filter_info}) {
       my $val = delete $attrs->{$key};
-      $self->set_value($key, $val);
-      $attrs->{$key} = $self->_unfiltered_column($key, $val)
+      $self->set_filtered_column($key, $val);
+      $attrs->{$key} = $self->_column_to_storage($key, $val)
     }
   }
   return $self->next::method($attrs, @rest);
 }
 
-
 sub new {
   my ($class, $attrs, @rest) = @_;
-  my $filtered;
+  my $source = $attrs->{-result_source}
+    or $class->throw_exception('Sourceless rows are not supported with DBIx::Class::FilterColumn');
+
+  my $obj = $class->next::method($attrs, @rest);
   foreach my $key (keys %{$attrs||{}}) {
-    if ($class->has_column($key) &&
-          exists $class->column_info($key)->{_filter_info} ) {
-      $attrs->{$key} = $class->_unfiltered_column($key, delete $attrs->{$key})
+    if ($obj->has_column($key) &&
+          exists $obj->column_info($key)->{_filter_info} ) {
+      my $val = delete $attrs->{$key};
+      $obj->set_filtered_column($key, $val);
     }
   }
-  my $obj = $class->next::method($attrs, @rest);
   return $obj;
 }
 
-
 1;
+
+=head1 NAME
+
+DBIx::Class::FilterColumn - Automatically convert column data
+
+=head1 SYNOPSIS
+
+ # In your result classes
+ __PACKAGE__->filter_column( money => {
+     filter_to_storage => 'to_pennies',
+     filter_from_storage => 'from_pennies',
+ });
+
+ sub to_pennies   { $_[1] * 100 }
+
+ sub from_pennies { $_[1] / 100 }
+
+ 1;
+
+=head1 DESCRIPTION
+
+This component is meant to be a more powerful, but less DWIM-y,
+L<DBIx::Class::InflateColumn>.  One of the major issues with said component is
+that it B<only> works with references.  Generally speaking anything that can
+be done with L<DBIx::Class::InflateColumn> can be done with this component.
+
+=head1 METHODS
+
+=head2 filter_column
+
+ __PACKAGE__->filter_column( colname => {
+     filter_from_storage => 'method',
+     filter_to_storage   => 'method',
+ })
+
+This is the method that you need to call to set up a filtered column.  It takes
+exactly two arguments; the first being the column name the second being a
+C<HashRef> with C<filter_from_storage> and C<filter_to_storage> having
+something that can be called as a method.  The method will be called with
+the value of the column as the first non-C<$self> argument.
+
+=head2 get_filtered_column
+
+ $obj->get_filtered_column('colname')
+
+Returns the filtered value of the column
+
+=head2 set_filtered_column
+
+ $obj->set_filtered_column(colname => 'new_value')
+
+Sets the filtered value of the column
+
+=head2 update
+
+Just overridden to filter changed columns through this component
+
+=head2 new
+
+Just overridden to filter columns through this component