DBIx/Class/InflateColumn.pm

filter: Statementstmt 87.0% 47 / 54 Branchbran 67.8% 19 / 28 Conditioncond 47.6% 10 / 21 MC/DCmcdc 28.5% 4 / 14 Subroutinesub 90.9% 10 / 11 Podpod 100% 4 / 4 totaltotal 71.2% 94 / 132 CC 22 SCAR 17.2
CC
22
Cov
74%
store_inflated_column
12.0
_inflated_column
6.9
_deflated_column
6.9
CRAP 5.6
« DBIx/Class/Ordered.pm ↑ Summary DBIx/Class/Relationship/CascadeActions.pm »
1 package DBIx::Class::InflateColumn;
2  
3 379 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 379 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 379 ▶use base 'DBIx::Class::Row';
Subroutine BEGIN: called CC=1 SCAR=0.0
7 379 ▶use SQL::Abstract::Util 'is_literal_value';
Subroutine BEGIN: called CC=1 SCAR=0.0
8 379 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 =head1 NAME
11  
12 DBIx::Class::InflateColumn - Automatically create references from column data
13  
14 =head1 SYNOPSIS
15  
16 # In your table classes
17 __PACKAGE__->inflate_column('column_name', {
18 inflate => sub {
19 my ($raw_value_from_db, $result_object) = @_;
20 ...
21 },
22 deflate => sub {
23 my ($inflated_value_from_user, $result_object) = @_;
24 ...
25 },
26 });
27  
28 =head1 DESCRIPTION
29  
30 This component translates column data into references, i.e. "inflating"
31 the column data. It also "deflates" references into an appropriate format
32 for the database.
33  
34 It can be used, for example, to automatically convert to and from
35 L<DateTime> objects for your date and time fields. There's a
36 convenience component to actually do that though, try
37 L<DBIx::Class::InflateColumn::DateTime>.
38  
39 It will handle all types of references except scalar references. It
40 will not handle scalar values, these are ignored and thus passed
41 through to L<SQL::Abstract::Classic>. This is to allow setting raw
42 values to "just work". Scalar references are passed through to the
43 database to deal with, to allow such settings as C< \'year + 1'> and
44 C< \'DEFAULT' > to work.
45  
46 If you want to filter plain scalar values and replace them with
47 something else, see L<DBIx::Class::FilterColumn>.
48  
49 =head1 METHODS
50  
51 =head2 inflate_column
52  
53 Instruct L<DBIx::Class> to inflate the given column.
54  
55 In addition to the column name, you must provide C<inflate> and
56 C<deflate> methods. The C<inflate> method is called when you access
57 the field, while the C<deflate> method is called when the field needs
58 to used by the database.
59  
60 For example, if you have a table C<events> with a timestamp field
61 named C<insert_time>, you could inflate the column in the
62 corresponding table class using something like:
63  
64 __PACKAGE__->inflate_column('insert_time', {
65 inflate => sub {
66 my ($insert_time_raw_value, $event_result_object) = @_;
67 DateTime->from_epoch( epoch => $insert_time_raw_value );
68 },
69 deflate => sub {
70 my ($insert_time_dt_object, $event_result_object) = @_;
71 $insert_time_dt_object->epoch;
72 },
73 });
74  
75 The coderefs you set for inflate and deflate are called with two parameters,
76 the first is the value of the column to be inflated/deflated, the second is
77 the result object itself.
78  
79 In this example, calls to an event's C<insert_time> accessor return a
80 L<DateTime> object. This L<DateTime> object is later "deflated" back
81 to the integer epoch representation when used in the database layer.
82 For a much more thorough handling of the above example, please see
83 L<DBIx::Class::DateTime::Epoch>
84  
85 =cut
86  
87 8506 ▶sub inflate_column {
Subroutine inflate_column: called CC=6 SCAR=18.1
Pod documented
88 8506 my ($self, $col, $attrs) = @_;
89  
90 8506 my $colinfo = $self->column_info($col);
91  
92 $self->throw_exception("InflateColumn can not be used on a column with a declared FilterColumn filter")
93 8506 ▶ if defined $colinfo->{_filter_info} and $self->isa('DBIx::Class::FilterColumn');
Branch: 1 branch
BranchTrueFalseTotal
if defined $colinfo->{"_filter_info"} and $self->isa("DBIx::Class::FilterColumn") 1 8505 8506
Condition66%2/3
defined $colinfo->{"_filter_info"} and $self->isa("DBIx::Class::FilterColumn")
!ll&&!rl&&r
850501
MC/DC50%1/2
defined $colinfo->{"_filter_info"} and $self->isa("DBIx::Class::FilterColumn")
defined $colinfo->{"_filter_info"} $self->isa("DBIx::Class::FilterColumn")
Truth table66%2/3
A and B
A= defined $colinfo->{"_filter_info"}B= $self->isa("DBIx::Class::FilterColumn")
ABresult
0X0
100
111
94  
95 8505 ▶ $self->throw_exception("No such column $col to inflate")
Branch: 1 branch
BranchTrueFalseTotal
unless $self->has_column($col) 0 8505 8505
96 unless $self->has_column($col);
97 8505 ▶ $self->throw_exception("inflate_column needs attr hashref")
Branch: 1 branch
BranchTrueFalseTotal
unless ref $attrs eq "HASH" 0 8505 8505
98 unless ref $attrs eq 'HASH';
99 8505 $colinfo->{_inflate_info} = $attrs;
100 8505 my $acc = $colinfo->{accessor};
101 8505 ▶ $self->mk_group_accessors('inflated_column' => [ (defined $acc ? $acc : $col), $col]);
Branch: 1 branch
BranchTrueFalseTotal
defined $acc ? : 327 8178 8505
102 8505 return 1;
103 }
104  
105 319 ▶sub _inflated_column {
Subroutine _inflated_column: called CC=6 SCAR=19.3
106 319 my ($self, $col, $value) = @_;
107  
108 319 ▶ return $value if (
Branch: 1 branch
BranchTrueFalseTotal
if not defined $value or &is_literal_value($value) 4 315 319
Condition66%2/3
not defined $value or &is_literal_value($value)
l!l&&r!l&&!r
40315
MC/DC50%1/2
not defined $value or &is_literal_value($value)
not defined $value &is_literal_value($value)
Truth table66%2/3
not(A) or B
A= not defined $valueB= &is_literal_value($value)
ABresult
1X1
011
000
109 ! defined $value # NULL is NULL is NULL
110 or
111 is_literal_value($value) #that would be a not-yet-reloaded literal update
112 );
113  
114 315 ▶ my $info = $self->result_source->column_info($col)
Branch: 1 branch
BranchTrueFalseTotal
my $info = $self->result_source->column_info($col) or $self->throw_exception("No column info for $col") 315 0 315
115 or $self->throw_exception("No column info for $col");
116  
117 315 ▶ return $value unless exists $info->{_inflate_info};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $info->{"_inflate_info"} 0 315 315
118  
119 return (
120 $info->{_inflate_info}{inflate}
121 ||
122 315 ▶ $self->throw_exception("No inflator found for '$col'")
Condition33%1/3
$info->{'_inflate_info'}{'inflate'} || $self->throw_exception("No inflator found for '${col}'")
l!l&&r!l&&!r
31500
MC/DC0%0/2
$info->{'_inflate_info'}{'inflate'} || $self->throw_exception("No inflator found for '${col}'")
$info->{'_inflate_info'}{'inflate'} $self->throw_exception("No inflator found for '${col}'")
Truth table33%1/3
A || B
A= $info->{'_inflate_info'}{'inflate'}B= $self->throw_exception("No inflator found for '${col}'")
ABresult
1X1
011
000
123 )->($value, $self);
124 }
125  
126 129 ▶sub _deflated_column {
Subroutine _deflated_column: called CC=6 SCAR=19.3
127 129 my ($self, $col, $value) = @_;
128  
129 ## Deflate any refs except for literals, pass through plain values
130 129 ▶ return $value if (
Branch: 1 branch
BranchTrueFalseTotal
if not length ref $value or &is_literal_value($value) 1 128 129
Condition66%2/3
not length ref $value or &is_literal_value($value)
l!l&&r!l&&!r
10128
MC/DC50%1/2
not length ref $value or &is_literal_value($value)
not length ref $value &is_literal_value($value)
Truth table66%2/3
not(A) or B
A= not length ref $valueB= &is_literal_value($value)
ABresult
1X1
011
000
131 ! length ref $value
132 or
133 is_literal_value($value)
134 );
135  
136 128 ▶ my $info = $self->result_source->column_info($col) or
Branch: 1 branch
BranchTrueFalseTotal
my $info = $self->result_source->column_info($col) or $self->throw_exception("No column info for $col") 128 0 128
137 $self->throw_exception("No column info for $col");
138  
139 128 ▶ return $value unless exists $info->{_inflate_info};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $info->{"_inflate_info"} 0 128 128
140  
141 return (
142 $info->{_inflate_info}{deflate}
143 ||
144 128 ▶ $self->throw_exception("No deflator found for '$col'")
Condition33%1/3
$info->{'_inflate_info'}{'deflate'} || $self->throw_exception("No deflator found for '${col}'")
l!l&&r!l&&!r
12800
MC/DC0%0/2
$info->{'_inflate_info'}{'deflate'} || $self->throw_exception("No deflator found for '${col}'")
$info->{'_inflate_info'}{'deflate'} $self->throw_exception("No deflator found for '${col}'")
Truth table33%1/3
A || B
A= $info->{'_inflate_info'}{'deflate'}B= $self->throw_exception("No deflator found for '${col}'")
ABresult
1X1
011
000
145 )->($value, $self);
146 }
147  
148 =head2 get_inflated_column
149  
150 my $val = $obj->get_inflated_column($col);
151  
152 Fetch a column value in its inflated state. This is directly
153 analogous to L<DBIx::Class::Row/get_column> in that it only fetches a
154 column already retrieved from the database, and then inflates it.
155 Throws an exception if the column requested is not an inflated column.
156  
157 =cut
158  
159 444 ▶sub get_inflated_column {
Subroutine get_inflated_column: called CC=3 SCAR=11.0
Pod documented
160 444 my ($self, $col) = @_;
161  
162 $self->throw_exception("$col is not an inflated column")
163 444 ▶ unless exists $self->result_source->column_info($col)->{_inflate_info};
Branch: 1 branch
BranchTrueFalseTotal
unless exists $self->result_source->column_info($col)->{"_inflate_info"} 0 444 444
164  
165 # we take care of keeping things in sync
166 return $self->{_inflated_column}{$col}
167 444 ▶ if exists $self->{_inflated_column}{$col};
Branch: 1 branch
BranchTrueFalseTotal
if exists $self->{"_inflated_column"}{$col} 125 319 444
168  
169 319 my $val = $self->get_column($col);
170  
171 319 return $self->{_inflated_column}{$col} = $self->_inflated_column($col, $val);
172 }
173  
174 =head2 set_inflated_column
175  
176 my $copy = $obj->set_inflated_column($col => $val);
177  
178 Sets a column value from an inflated value. This is directly
179 analogous to L<DBIx::Class::Row/set_column>.
180  
181 =cut
182  
183 19 ▶sub set_inflated_column {
Subroutine set_inflated_column: called CC=3 SCAR=11.0
Pod documented
184 19 my ($self, $col, $value) = @_;
185  
186 # pass through deflated stuff
187 19 ▶ if (! length ref $value or is_literal_value($value)) {
Branch: 1 branch
BranchTrueFalseTotal
if (not length ref $value or &is_literal_value($value)) { } 3 16 19
Condition66%2/3
not length ref $value or &is_literal_value($value)
l!l&&r!l&&!r
3016
MC/DC50%1/2
not length ref $value or &is_literal_value($value)
not length ref $value &is_literal_value($value)
Truth table66%2/3
not(A) or B
A= not length ref $valueB= &is_literal_value($value)
ABresult
1X1
011
000
188 3 $self->set_column($col, $value);
189 3 delete $self->{_inflated_column}{$col};
190 }
191 # need to call set_column with the deflate cycle so that
192 # relationship caches are nuked if any
193 # also does the compare-for-dirtyness and change tracking dance
194 else {
195 16 $self->set_column($col, $self->_deflated_column($col, $value));
196 16 $self->{_inflated_column}{$col} = $value;
197 }
198  
199 19 return $value;
200 }
201  
202 =head2 store_inflated_column
203  
204 my $copy = $obj->store_inflated_column($col => $val);
205  
206 Sets a column value from an inflated value without marking the column
207 as dirty. This is directly analogous to L<DBIx::Class::Row/store_column>.
208  
209 =cut
210  
211 0 ▶sub store_inflated_column {
Subroutine store_inflated_column: not called CC=3 SCAR=24.8
Pod documented
212 0 my ($self, $col, $value) = @_;
213  
214 0 ▶ if (! length ref $value or is_literal_value($value)) {
Branch: 1 branch
BranchTrueFalseTotal
if (not length ref $value or &is_literal_value($value)) { } 0 0 0
Condition0%0/3
not length ref $value or &is_literal_value($value)
l!l&&r!l&&!r
000
MC/DC0%0/2
not length ref $value or &is_literal_value($value)
not length ref $value &is_literal_value($value)
Truth table0%0/3
not(A) or B
A= not length ref $valueB= &is_literal_value($value)
ABresult
1X1
011
000
215 0 delete $self->{_inflated_column}{$col};
216 0 $self->store_column($col => $value);
217 }
218 else {
219 0 delete $self->{_column_data}{$col};
220 0 $self->{_inflated_column}{$col} = $value;
221 }
222  
223 0 return $value;
224 }
225  
226 =head1 SEE ALSO
227  
228 =over 4
229  
230 =item L<DBIx::Class::Core> - This component is loaded as part of the
231 C<core> L<DBIx::Class> components; generally there is no need to
232 load it directly
233  
234 =back
235  
236 =head1 FURTHER QUESTIONS?
237  
238 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
239  
240 =head1 COPYRIGHT AND LICENSE
241  
242 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
243 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
244 redistribute it and/or modify it under the same terms as the
245 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
246  
247 =cut
248  
249 379 1;
« DBIx/Class/Ordered.pm ↑ Summary DBIx/Class/Relationship/CascadeActions.pm »