1 package DBIx::Class::FilterColumn;
5 use base qw/DBIx::Class::Row/;
8 my ($self, $col, $attrs) = @_;
10 $self->throw_exception("FilterColumn does not work with InflateColumn")
11 if $self->isa('DBIx::Class::InflateColumn') &&
12 defined $self->column_info($col)->{_inflate_info};
14 $self->throw_exception("No such column $col to filter")
15 unless $self->has_column($col);
17 $self->throw_exception("filter_column needs attr hashref")
18 unless ref $attrs eq 'HASH';
20 $self->column_info($col)->{_filter_info} = $attrs;
21 my $acc = $self->column_info($col)->{accessor};
22 $self->mk_group_accessors(filtered_column => [ (defined $acc ? $acc : $col), $col]);
26 sub _column_from_storage {
27 my ($self, $col, $value) = @_;
29 return $value unless defined $value;
31 my $info = $self->column_info($col)
32 or $self->throw_exception("No column info for $col");
34 return $value unless exists $info->{_filter_info};
36 my $filter = $info->{_filter_info}{filter_from_storage};
37 $self->throw_exception("No filter for $col") unless defined $filter;
39 return $self->$filter($value);
42 sub _column_to_storage {
43 my ($self, $col, $value) = @_;
45 my $info = $self->column_info($col) or
46 $self->throw_exception("No column info for $col");
48 return $value unless exists $info->{_filter_info};
50 my $unfilter = $info->{_filter_info}{filter_to_storage};
51 $self->throw_exception("No unfilter for $col") unless defined $unfilter;
52 return $self->$unfilter($value);
55 sub get_filtered_column {
56 my ($self, $col) = @_;
58 $self->throw_exception("$col is not a filtered column")
59 unless exists $self->column_info($col)->{_filter_info};
61 return $self->{_filtered_column}{$col}
62 if exists $self->{_filtered_column}{$col};
64 my $val = $self->get_column($col);
66 return $self->{_filtered_column}{$col} = $self->_column_from_storage($col, $val);
70 my ($self, $col) = (shift, @_);
73 delete $self->{_filtered_column}{$col};
75 $self->next::method(@_);
78 sub set_filtered_column {
79 my ($self, $col, $filtered) = @_;
81 # do not blow up the cache via set_column unless necessary
82 # (filtering may be expensive!)
83 if (exists $self->{_filtered_column}{$col}) {
85 if ($self->_eq_column_values ($col, $filtered, $self->{_filtered_column}{$col} ) );
87 $self->make_column_dirty ($col); # so the comparison won't run again
90 $self->set_column($col, $self->_column_to_storage($col, $filtered));
96 my ($self, $attrs, @rest) = @_;
97 foreach my $key (keys %{$attrs||{}}) {
98 if ($self->has_column($key) &&
99 exists $self->column_info($key)->{_filter_info}) {
100 my $val = delete $attrs->{$key};
101 $self->set_filtered_column($key, $val);
102 $attrs->{$key} = $self->_column_to_storage($key, $val)
105 return $self->next::method($attrs, @rest);
109 my ($class, $attrs, @rest) = @_;
110 my $source = $attrs->{-result_source}
111 or $class->throw_exception('Sourceless rows are not supported with DBIx::Class::FilterColumn');
113 my $obj = $class->next::method($attrs, @rest);
114 foreach my $key (keys %{$attrs||{}}) {
115 if ($obj->has_column($key) &&
116 exists $obj->column_info($key)->{_filter_info} ) {
117 my $val = delete $attrs->{$key};
118 $obj->set_filtered_column($key, $val);
128 DBIx::Class::FilterColumn - Automatically convert column data
132 # In your result classes
133 __PACKAGE__->filter_column( money => {
134 filter_to_storage => 'to_pennies',
135 filter_from_storage => 'from_pennies',
138 sub to_pennies { $_[1] * 100 }
140 sub from_pennies { $_[1] / 100 }
146 This component is meant to be a more powerful, but less DWIM-y,
147 L<DBIx::Class::InflateColumn>. One of the major issues with said component is
148 that it B<only> works with references. Generally speaking anything that can
149 be done with L<DBIx::Class::InflateColumn> can be done with this component.
155 __PACKAGE__->filter_column( colname => {
156 filter_from_storage => 'method',
157 filter_to_storage => 'method',
160 This is the method that you need to call to set up a filtered column. It takes
161 exactly two arguments; the first being the column name the second being a
162 C<HashRef> with C<filter_from_storage> and C<filter_to_storage> having
163 something that can be called as a method. The method will be called with
164 the value of the column as the first non-C<$self> argument.
166 =head2 get_filtered_column
168 $obj->get_filtered_column('colname')
170 Returns the filtered value of the column
172 =head2 set_filtered_column
174 $obj->set_filtered_column(colname => 'new_value')
176 Sets the filtered value of the column