Commit | Line | Data |
0e5c2582 |
1 | package DBIx::Class::InflateColumn; |
2 | |
3 | use strict; |
4 | use warnings; |
ba026511 |
5 | use Scalar::Util qw/blessed/; |
aa562407 |
6 | |
75a23b3e |
7 | use base qw/DBIx::Class::Row/; |
0e5c2582 |
8 | |
75d07914 |
9 | =head1 NAME |
bcae85db |
10 | |
11 | DBIx::Class::InflateColumn - Automatically create objects from column data |
12 | |
13 | =head1 SYNOPSIS |
14 | |
15 | # In your table classes |
16 | __PACKAGE__->inflate_column('column_name', { |
17 | inflate => sub { ... }, |
18 | deflate => sub { ... }, |
19 | }); |
20 | |
21 | =head1 DESCRIPTION |
22 | |
23 | This component translates column data into objects, i.e. "inflating" |
24 | the column data. It also "deflates" objects into an appropriate format |
25 | for the database. |
26 | |
27 | It can be used, for example, to automatically convert to and from |
75d07914 |
28 | L<DateTime> objects for your date and time fields. |
bcae85db |
29 | |
30 | =head1 METHODS |
31 | |
32 | =head2 inflate_column |
33 | |
75d07914 |
34 | Instruct L<DBIx::Class> to inflate the given column. |
bcae85db |
35 | |
36 | In addition to the column name, you must provide C<inflate> and |
37 | C<deflate> methods. The C<inflate> method is called when you access |
38 | the field, while the C<deflate> method is called when the field needs |
39 | to used by the database. |
40 | |
41 | For example, if you have a table C<events> with a timestamp field |
42 | named C<insert_time>, you could inflate the column in the |
43 | corresponding table class using something like: |
44 | |
45 | __PACKAGE__->inflate_column('insert_time', { |
46 | inflate => sub { DateTime::Format::Pg->parse_datetime(shift); }, |
47 | deflate => sub { DateTime::Format::Pg->format_datetime(shift); }, |
48 | }); |
49 | |
50 | (Replace L<DateTime::Format::Pg> with the appropriate module for your |
51 | database, or consider L<DateTime::Format::DBI>.) |
52 | |
06fc5fc9 |
53 | The coderefs you set for inflate and deflate are called with two parameters, |
54 | the first is the value of the column to be inflated/deflated, the second is the |
55 | row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> on |
56 | it, to feed to L<DateTime::Format::DBI>. |
57 | |
bcae85db |
58 | In this example, calls to an event's C<insert_time> accessor return a |
59 | L<DateTime> object. This L<DateTime> object is later "deflated" when |
60 | used in the database layer. |
61 | |
62 | =cut |
63 | |
0e5c2582 |
64 | sub inflate_column { |
65 | my ($self, $col, $attrs) = @_; |
bc0c9800 |
66 | $self->throw_exception("No such column $col to inflate") |
67 | unless $self->has_column($col); |
68 | $self->throw_exception("inflate_column needs attr hashref") |
69 | unless ref $attrs eq 'HASH'; |
103647d5 |
70 | $self->column_info($col)->{_inflate_info} = $attrs; |
0e5c2582 |
71 | $self->mk_group_accessors('inflated_column' => $col); |
72 | return 1; |
73 | } |
74 | |
4a07648a |
75 | sub _inflated_column { |
0e5c2582 |
76 | my ($self, $col, $value) = @_; |
9f300b1b |
77 | return $value unless defined $value; # NULL is NULL is NULL |
bc0c9800 |
78 | my $info = $self->column_info($col) |
79 | or $self->throw_exception("No column info for $col"); |
103647d5 |
80 | return $value unless exists $info->{_inflate_info}; |
81 | my $inflate = $info->{_inflate_info}{inflate}; |
701da8c4 |
82 | $self->throw_exception("No inflator for $col") unless defined $inflate; |
0e5c2582 |
83 | return $inflate->($value, $self); |
84 | } |
85 | |
89279e9d |
86 | sub _deflated_column { |
87 | my ($self, $col, $value) = @_; |
88 | return $value unless ref $value; # If it's not an object, don't touch it |
89 | my $info = $self->column_info($col) or |
90 | $self->throw_exception("No column info for $col"); |
91 | return $value unless exists $info->{_inflate_info}; |
92 | my $deflate = $info->{_inflate_info}{deflate}; |
93 | $self->throw_exception("No deflator for $col") unless defined $deflate; |
94 | return $deflate->($value, $self); |
0e5c2582 |
95 | } |
96 | |
7eb4ecc8 |
97 | =head2 get_inflated_column |
98 | |
99 | my $val = $obj->get_inflated_column($col); |
100 | |
101 | Fetch a column value in its inflated state. This is directly |
102 | analogous to L<DBIx::Class::Row/get_column> in that it only fetches a |
103 | column already retreived from the database, and then inflates it. |
104 | Throws an exception if the column requested is not an inflated column. |
105 | |
106 | =cut |
107 | |
0e5c2582 |
108 | sub get_inflated_column { |
109 | my ($self, $col) = @_; |
bc0c9800 |
110 | $self->throw_exception("$col is not an inflated column") |
111 | unless exists $self->column_info($col)->{_inflate_info}; |
0e5c2582 |
112 | return $self->{_inflated_column}{$col} |
113 | if exists $self->{_inflated_column}{$col}; |
0e5c2582 |
114 | return $self->{_inflated_column}{$col} = |
4a07648a |
115 | $self->_inflated_column($col, $self->get_column($col)); |
0e5c2582 |
116 | } |
117 | |
7eb4ecc8 |
118 | =head2 set_inflated_column |
119 | |
120 | my $copy = $obj->set_inflated_column($col => $val); |
121 | |
122 | Sets a column value from an inflated value. This is directly |
123 | analogous to L<DBIx::Class::Row/set_column>. |
124 | |
125 | =cut |
126 | |
0e5c2582 |
127 | sub set_inflated_column { |
180c7679 |
128 | my ($self, $col, $obj) = @_; |
89279e9d |
129 | $self->set_column($col, $self->_deflated_column($col, $obj)); |
130 | return $self->store_inflated_column($col, $obj); |
0e5c2582 |
131 | } |
132 | |
7eb4ecc8 |
133 | =head2 store_inflated_column |
134 | |
135 | my $copy = $obj->store_inflated_column($col => $val); |
136 | |
137 | Sets a column value from an inflated value without marking the column |
47c56124 |
138 | as dirty. This is directly analogous to L<DBIx::Class::Row/store_column>. |
7eb4ecc8 |
139 | |
140 | =cut |
141 | |
0e5c2582 |
142 | sub store_inflated_column { |
180c7679 |
143 | my ($self, $col, $obj) = @_; |
ba026511 |
144 | unless (blessed($obj)) { |
145 | delete $self->{_inflated_column}{$col}; |
146 | return undef; |
147 | } |
89279e9d |
148 | return $self->{_inflated_column}{$col} = $obj; |
180c7679 |
149 | } |
4a07648a |
150 | |
47c56124 |
151 | =head2 get_column |
152 | |
153 | Gets a column value in the same way as L<DBIx::Class::Row/get_column>. If there |
154 | is an inflated value stored that has not yet been deflated, it is deflated |
155 | when the method is invoked. |
156 | |
157 | =cut |
158 | |
180c7679 |
159 | sub get_column { |
160 | my ($self, $col) = @_; |
89279e9d |
161 | if (exists $self->{_inflated_column}{$col} |
162 | && !exists $self->{_column_data}{$col}) { |
163 | $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})); |
164 | } |
180c7679 |
165 | return $self->next::method($col); |
166 | } |
4a07648a |
167 | |
180c7679 |
168 | sub get_columns { |
169 | my $self = shift; |
170 | if (exists $self->{_inflated_column}) { |
89279e9d |
171 | foreach my $col (keys %{$self->{_inflated_column}}) { |
425f2ea9 |
172 | $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})) |
89279e9d |
173 | unless exists $self->{_column_data}{$col}; |
174 | } |
180c7679 |
175 | } |
176 | return $self->next::method; |
177 | } |
178 | |
179 | sub has_column_loaded { |
180 | my ($self, $col) = @_; |
181 | return 1 if exists $self->{_inflated_column}{$col}; |
182 | return $self->next::method($col); |
0e5c2582 |
183 | } |
184 | |
7eb4ecc8 |
185 | =head2 update |
186 | |
187 | Updates a row in the same way as L<DBIx::Class::Row/update>, handling |
188 | inflation and deflation of columns appropriately. |
189 | |
190 | =cut |
191 | |
9fcda149 |
192 | sub update { |
193 | my ($class, $attrs, @rest) = @_; |
180c7679 |
194 | foreach my $key (keys %{$attrs||{}}) { |
9fcda149 |
195 | if (ref $attrs->{$key} |
196 | && exists $class->column_info($key)->{_inflate_info}) { |
180c7679 |
197 | $class->set_inflated_column($key, delete $attrs->{$key}); |
9fcda149 |
198 | } |
199 | } |
200 | return $class->next::method($attrs, @rest); |
201 | } |
202 | |
7eb4ecc8 |
203 | =head2 new |
204 | |
205 | Creates a row in the same way as L<DBIx::Class::Row/new>, handling |
206 | inflation and deflation of columns appropriately. |
207 | |
208 | =cut |
209 | |
0e5c2582 |
210 | sub new { |
211 | my ($class, $attrs, @rest) = @_; |
180c7679 |
212 | my $inflated; |
213 | foreach my $key (keys %{$attrs||{}}) { |
214 | $inflated->{$key} = delete $attrs->{$key} |
215 | if ref $attrs->{$key} && exists $class->column_info($key)->{_inflate_info}; |
0e5c2582 |
216 | } |
180c7679 |
217 | my $obj = $class->next::method($attrs, @rest); |
218 | $obj->{_inflated_column} = $inflated if $inflated; |
219 | return $obj; |
0e5c2582 |
220 | } |
221 | |
bcae85db |
222 | =head1 SEE ALSO |
223 | |
224 | =over 4 |
225 | |
226 | =item L<DBIx::Class::Core> - This component is loaded as part of the |
227 | "core" L<DBIx::Class> components; generally there is no need to |
228 | load it directly |
229 | |
230 | =back |
231 | |
232 | =head1 AUTHOR |
233 | |
234 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
235 | |
236 | =head1 CONTRIBUTORS |
237 | |
238 | Daniel Westermann-Clark <danieltwc@cpan.org> (documentation) |
239 | |
240 | =head1 LICENSE |
241 | |
242 | You may distribute this code under the same terms as Perl itself. |
243 | |
244 | =cut |
245 | |
0e5c2582 |
246 | 1; |