X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FFilterColumn.pm;h=c280b47a65463538efc395f598f2f64c19b34be3;hb=f4dc39d649672ff4452cf827ca204a1e937bc8b7;hp=196b3ee17e5419b49fbf5384955b969646bf3bd5;hpb=eec182b6efc0f565751f2c81ce25ee419ebb133e;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/FilterColumn.pm b/lib/DBIx/Class/FilterColumn.pm index 196b3ee..c280b47 100644 --- a/lib/DBIx/Class/FilterColumn.pm +++ b/lib/DBIx/Class/FilterColumn.pm @@ -2,17 +2,17 @@ package DBIx::Class::FilterColumn; use strict; use warnings; -use base qw/DBIx::Class::Row/; +use base 'DBIx::Class::Row'; +use SQL::Abstract 'is_literal_value'; +use namespace::clean; sub filter_column { my ($self, $col, $attrs) = @_; - $self->throw_exception('FilterColumn does not work with InflateColumn') - if $self->isa('DBIx::Class::InflateColumn') && - defined $self->column_info($col)->{_inflate_info}; + my $colinfo = $self->result_source->columns_info([$col])->{$col}; - $self->throw_exception("No such column $col to filter") - unless $self->has_column($col); + $self->throw_exception("FilterColumn can not be used on a column with a declared InflateColumn inflator") + if defined $colinfo->{_inflate_info} and $self->isa('DBIx::Class::InflateColumn'); $self->throw_exception('filter_column expects a hashref of filter specifications') unless ref $attrs eq 'HASH'; @@ -20,8 +20,8 @@ sub filter_column { $self->throw_exception('An invocation of filter_column() must specify either a filter_from_storage or filter_to_storage') unless $attrs->{filter_from_storage} || $attrs->{filter_to_storage}; - $self->column_info($col)->{_filter_info} = $attrs; - my $acc = $self->column_info($col)->{accessor}; + $colinfo->{_filter_info} = $attrs; + my $acc = $colinfo->{accessor}; $self->mk_group_accessors(filtered_column => [ (defined $acc ? $acc : $col), $col]); return 1; } @@ -29,10 +29,9 @@ sub filter_column { sub _column_from_storage { my ($self, $col, $value) = @_; - return $value unless defined $value; + return $value if is_literal_value($value); - my $info = $self->column_info($col) - or $self->throw_exception("No column info for $col"); + my $info = $self->result_source->columns_info([$col])->{$col}; return $value unless exists $info->{_filter_info}; @@ -44,8 +43,9 @@ sub _column_from_storage { sub _column_to_storage { my ($self, $col, $value) = @_; - my $info = $self->column_info($col) or - $self->throw_exception("No column info for $col"); + return $value if is_literal_value($value); + + my $info = $self->result_source->columns_info([$col])->{$col}; return $value unless exists $info->{_filter_info}; @@ -58,21 +58,28 @@ sub get_filtered_column { my ($self, $col) = @_; $self->throw_exception("$col is not a filtered column") - unless exists $self->column_info($col)->{_filter_info}; + unless exists $self->result_source->columns_info->{$col}{_filter_info}; return $self->{_filtered_column}{$col} if exists $self->{_filtered_column}{$col}; my $val = $self->get_column($col); - return $self->{_filtered_column}{$col} = $self->_column_from_storage($col, $val); + return $self->{_filtered_column}{$col} = $self->_column_from_storage( + $col, $val + ); } sub get_column { my ($self, $col) = @_; - if (exists $self->{_filtered_column}{$col}) { - return $self->{_column_data}{$col} ||= $self->_column_to_storage ($col, $self->{_filtered_column}{$col}); - } + + ! exists $self->{_column_data}{$col} + and + exists $self->{_filtered_column}{$col} + and + $self->{_column_data}{$col} = $self->_column_to_storage ( + $col, $self->{_filtered_column}{$col} + ); return $self->next::method ($col); } @@ -81,14 +88,32 @@ sub get_column { sub get_columns { my $self = shift; - foreach my $col (keys %{$self->{_filtered_column}||{}}) { - $self->{_column_data}{$col} ||= $self->_column_to_storage ($col, $self->{_filtered_column}{$col}) - if exists $self->{_filtered_column}{$col}; - } + $self->{_column_data}{$_} = $self->_column_to_storage ( + $_, $self->{_filtered_column}{$_} + ) for grep + { ! exists $self->{_column_data}{$_} } + keys %{$self->{_filtered_column}||{}} + ; $self->next::method (@_); } +# and *another* separate codepath, argh! +sub get_dirty_columns { + my $self = shift; + + $self->{_dirty_columns}{$_} + and + ! exists $self->{_column_data}{$_} + and + $self->{_column_data}{$_} = $self->_column_to_storage ( + $_, $self->{_filtered_column}{$_} + ) + for keys %{$self->{_filtered_column}||{}}; + + $self->next::method(@_); +} + sub store_column { my ($self, $col) = (shift, @_); @@ -98,54 +123,65 @@ sub store_column { $self->next::method(@_); } +sub has_column_loaded { + my ($self, $col) = @_; + return 1 if exists $self->{_filtered_column}{$col}; + return $self->next::method($col); +} + sub set_filtered_column { my ($self, $col, $filtered) = @_; - # do not blow up the cache via set_column unless necessary - # (filtering may be expensive!) - if (exists $self->{_filtered_column}{$col}) { - return $filtered - if ($self->_eq_column_values ($col, $filtered, $self->{_filtered_column}{$col} ) ); - - $self->make_column_dirty ($col); # so the comparison won't run again + # unlike IC, FC does not need to deal with the 'filter' abomination + # thus we can short-curcuit filtering entirely and never call set_column + # in case this is already a dirty change OR the row never touched storage + if ( + ! $self->in_storage + or + $self->is_column_changed($col) + ) { + $self->make_column_dirty($col); + delete $self->{_column_data}{$col}; } - - $self->set_column($col, $self->_column_to_storage($col, $filtered)); + else { + $self->set_column($col, $self->_column_to_storage($col, $filtered)); + }; return $self->{_filtered_column}{$col} = $filtered; } sub update { - my ($self, $attrs, @rest) = @_; + my ($self, $data, @rest) = @_; - foreach my $key (keys %{$attrs||{}}) { - if ( - $self->has_column($key) - && - exists $self->column_info($key)->{_filter_info} - ) { - $self->set_filtered_column($key, delete $attrs->{$key}); + my $colinfos = $self->result_source->columns_info; + + foreach my $col (keys %{$data||{}}) { + if ( exists $colinfos->{$col}{_filter_info} ) { + $self->set_filtered_column($col, delete $data->{$col}); # FIXME update() reaches directly into the object-hash # and we may *not* have a filtered value there - thus # the void-ctx filter-trigger - $self->get_column($key) unless exists $self->{_column_data}{$key}; + $self->get_column($col) unless exists $self->{_column_data}{$col}; } } - return $self->next::method($attrs, @rest); + return $self->next::method($data, @rest); } sub new { - my ($class, $attrs, @rest) = @_; - my $source = $attrs->{-result_source} + my ($class, $data, @rest) = @_; + + my $rsrc = $data->{-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 ($obj->has_column($key) && - exists $obj->column_info($key)->{_filter_info} ) { - $obj->set_filtered_column($key, $attrs->{$key}); + my $obj = $class->next::method($data, @rest); + + my $colinfos = $rsrc->columns_info; + + foreach my $col (keys %{$data||{}}) { + if (exists $colinfos->{$col}{_filter_info} ) { + $obj->set_filtered_column($col, $data->{$col}); } } @@ -154,6 +190,8 @@ sub new { 1; +__END__ + =head1 NAME DBIx::Class::FilterColumn - Automatically convert column data @@ -199,7 +237,7 @@ exactly two arguments; the first being the column name the second being a hash reference with C and C set to either a method name or a code reference. In either case the filter is invoked as: - $row_obj->$filter_specification ($value_to_filter) + $result->$filter_specification ($value_to_filter) with C<$filter_specification> being chosen depending on whether the C<$value_to_filter> is being retrieved from or written to permanent @@ -238,3 +276,14 @@ and one, using code like this:- In this case the C is not required, as just passing the database value through to perl does the right thing. + +=head1 FURTHER QUESTIONS? + +Check the list of L. + +=head1 COPYRIGHT AND LICENSE + +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L.