sub filter_column {
my ($self, $col, $attrs) = @_;
- $self->throw_exception("FilterColumn does not work with InflateColumn")
+ $self->throw_exception('FilterColumn does not work with InflateColumn')
if $self->isa('DBIx::Class::InflateColumn') &&
defined $self->column_info($col)->{_inflate_info};
$self->throw_exception("No such column $col to filter")
unless $self->has_column($col);
- $self->throw_exception("filter_column needs attr hashref")
+ $self->throw_exception('filter_column expects a hashref of filter specifications')
unless ref $attrs eq 'HASH';
+ $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};
$self->mk_group_accessors(filtered_column => [ (defined $acc ? $acc : $col), $col]);
return $value unless exists $info->{_filter_info};
my $filter = $info->{_filter_info}{filter_from_storage};
- $self->throw_exception("No filter for $col") unless defined $filter;
- return $self->$filter($value);
+ return defined $filter ? $self->$filter($value) : $value;
}
sub _column_to_storage {
return $value unless exists $info->{_filter_info};
my $unfilter = $info->{_filter_info}{filter_to_storage};
- $self->throw_exception("No unfilter for $col") unless defined $unfilter;
- return $self->$unfilter($value);
+
+ return defined $unfilter ? $self->$unfilter($value) : $value;
}
sub get_filtered_column {
=head2 filter_column
__PACKAGE__->filter_column( colname => {
- filter_from_storage => 'method',
- filter_to_storage => 'method',
+ filter_from_storage => 'method'|\&coderef,
+ filter_to_storage => 'method'|\&coderef,
})
-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.
+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 hash
+reference with C<filter_from_storage> and C<filter_to_storage> 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)
+
+with C<$filter_specification> being chosen depending on whether the
+C<$value_to_filter> is being retrieved from or written to permanent
+storage.
+
+If a specific directional filter is not specified, the original value will be
+passed to/from storage unfiltered.
=head2 get_filtered_column
$obj->set_filtered_column(colname => 'new_value')
Sets the filtered value of the column
+
+=head1 EXAMPLE OF USE
+
+Some databases have restrictions on values that can be passed to
+boolean columns, and problems can be caused by passing value that
+perl considers to be false (such as C<undef>).
+
+One solution to this is to ensure that the boolean values are set
+to something that the database can handle - such as numeric zero
+and one, using code like this:-
+
+ __PACKAGE__->filter_column(
+ my_boolean_column => {
+ filter_to_storage => sub { $_[1] ? 1 : 0 },
+ }
+ );
+
+In this case the C<filter_from_storage> is not required, as just
+passing the database value through to perl does the right thing.
} q(Can't filter column after inflate column);
}
+# test when we do not set both filter_from_storage/filter_to_storage
+DBICTest::Schema::Artist->filter_column(rank => {
+ filter_to_storage => sub { $to_storage_ran++; $_[1] },
+});
+Class::C3->reinitialize();
+
+ASYMMETRIC_TO_TEST: {
+ # initialise value
+ $artist->rank(20);
+ $artist->update;
+
+ my $expected_from = $from_storage_ran;
+ my $expected_to = $to_storage_ran;
+
+ $artist->rank(10);
+ ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value');
+ is ($artist->rank, '10', 'Column set properly');
+ is $from_storage_ran, $expected_from, 'from did not run';
+ is $to_storage_ran, ++$expected_to, 'to did run';
+
+ $artist->discard_changes;
+
+ is ($artist->rank, '20', 'Column set properly');
+ is $from_storage_ran, $expected_from, 'from did not run';
+ is $to_storage_ran, $expected_to, 'to did not run';
+}
+
+DBICTest::Schema::Artist->filter_column(rank => {
+ filter_from_storage => sub { $from_storage_ran++; $_[1] },
+});
+Class::C3->reinitialize();
+
+ASYMMETRIC_FROM_TEST: {
+ # initialise value
+ $artist->rank(23);
+ $artist->update;
+
+ my $expected_from = $from_storage_ran;
+ my $expected_to = $to_storage_ran;
+
+ $artist->rank(13);
+ ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value');
+ is ($artist->rank, '13', 'Column set properly');
+ is $from_storage_ran, $expected_from, 'from did not run';
+ is $to_storage_ran, $expected_to, 'to did not run';
+
+ $artist->discard_changes;
+
+ is ($artist->rank, '23', 'Column set properly');
+ is $from_storage_ran, ++$expected_from, 'from did run';
+ is $to_storage_ran, $expected_to, 'to did not run';
+}
+
+throws_ok { DBICTest::Schema::Artist->filter_column( rank => {} ) }
+ qr/\QAn invocation of filter_column() must specify either a filter_from_storage or filter_to_storage/,
+ 'Correctly throws exception for empty attributes'
+;
+
done_testing;
projects / dbsrgits/DBIx-Class.git / commitdiff