Commit | Line | Data |
445e5e31 |
1 | package DBIx::Class::InflateColumn::DateTime; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | use base qw/DBIx::Class/; |
6 | |
0b375b68 |
7 | =head1 NAME |
8 | |
5d0a2955 |
9 | DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns. |
0b375b68 |
10 | |
11 | =head1 SYNOPSIS |
12 | |
13 | Load this component and then declare one or more |
679a304a |
14 | columns to be of the datetime, timestamp or date datatype. |
0b375b68 |
15 | |
16 | package Event; |
517d5d64 |
17 | __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/); |
0b375b68 |
18 | __PACKAGE__->add_columns( |
19 | starts_when => { data_type => 'datetime' } |
20 | ); |
21 | |
22 | Then you can treat the specified column as a L<DateTime> object. |
23 | |
24 | print "This event starts the month of ". |
25 | $event->starts_when->month_name(); |
26 | |
dda9af55 |
27 | If you want to set a specific timezone for that field, use: |
28 | |
29 | __PACKAGE__->add_columns( |
30 | starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } } |
31 | ); |
32 | |
a97fe7e0 |
33 | If you want to inflate no matter what data_type your column is, |
34 | use inflate_datetime or inflate_date: |
35 | |
36 | __PACKAGE__->add_columns( |
37 | starts_when => { data_type => 'varchar', inflate_datetime => 1 } |
38 | ); |
39 | |
40 | __PACKAGE__->add_columns( |
41 | starts_when => { data_type => 'varchar', inflate_date => 1 } |
42 | ); |
43 | |
ff8a6e3b |
44 | It's also possible to explicitly skip inflation: |
45 | |
46 | __PACKAGE__->add_columns( |
47 | starts_when => { data_type => 'datetime', inflate_datetime => 0 } |
48 | ); |
49 | |
0b375b68 |
50 | =head1 DESCRIPTION |
51 | |
52 | This module figures out the type of DateTime::Format::* class to |
53 | inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* |
54 | that you are using. If you switch from one database to a different |
5d0a2955 |
55 | one your code should continue to work without modification (though note |
56 | that this feature is new as of 0.07, so it may not be perfect yet - bug |
57 | reports to the list very much welcome). |
0b375b68 |
58 | |
943f93f2 |
59 | For more help with using components, see L<DBIx::Class::Manual::Component/USING>. |
de78905b |
60 | |
0b375b68 |
61 | =cut |
62 | |
445e5e31 |
63 | __PACKAGE__->load_components(qw/InflateColumn/); |
64 | |
65 | __PACKAGE__->mk_group_accessors('simple' => '__datetime_parser'); |
66 | |
9b83fccd |
67 | =head2 register_column |
68 | |
69 | Chains with the L<DBIx::Class::Row/register_column> method, and sets |
70 | up datetime columns appropriately. This would not normally be |
71 | directly called by end users. |
72 | |
33a126ef |
73 | In the case of an invalid date, L<DateTime> will throw an exception. To |
74 | bypass these exceptions and just have the inflation return undef, use |
75 | the C<datetime_undef_if_invalid> option in the column info: |
76 | |
77 | "broken_date", |
78 | { |
79 | data_type => "datetime", |
80 | default_value => '0000-00-00', |
81 | is_nullable => 1, |
82 | datetime_undef_if_invalid => 1 |
83 | } |
84 | |
9b83fccd |
85 | =cut |
86 | |
445e5e31 |
87 | sub register_column { |
88 | my ($self, $column, $info, @rest) = @_; |
89 | $self->next::method($column, $info, @rest); |
c209c4fd |
90 | return unless defined($info->{data_type}); |
bb90689c |
91 | |
92 | my $type; |
93 | |
94 | for (qw/date datetime/) { |
95 | my $key = "inflate_${_}"; |
96 | |
97 | next unless exists $info->{$key}; |
98 | return unless $info->{$key}; |
99 | |
100 | $type = $_; |
101 | last; |
102 | } |
103 | |
104 | unless ($type) { |
105 | $type = lc($info->{data_type}); |
106 | $type = 'datetime' if ($type =~ /^timestamp/); |
107 | } |
108 | |
dda9af55 |
109 | my $timezone; |
110 | if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) { |
111 | $timezone = $info->{extra}{timezone}; |
112 | } |
113 | |
dceeddc7 |
114 | my $undef_if_invalid = $info->{datetime_undef_if_invalid}; |
115 | |
bb90689c |
116 | if ($type eq 'datetime' || $type eq 'date') { |
c209c4fd |
117 | my ($parse, $format) = ("parse_${type}", "format_${type}"); |
45147005 |
118 | |
119 | # This assignment must happen here, otherwise Devel::Cycle treats |
120 | # the resulting deflator as a circular reference (go figure): |
121 | # |
122 | # Cycle #1 |
123 | # DBICTest::Schema A->{source_registrations} => %B |
124 | # %B->{Event} => DBIx::Class::ResultSource::Table C |
125 | # DBIx::Class::ResultSource::Table C->{_columns} => %D |
126 | # %D->{created_on} => %E |
127 | # %E->{_inflate_info} => %F |
128 | # %F->{deflate} => &G |
129 | # closure &G, $info => $H |
130 | # $H => %E |
131 | # |
132 | my $floating_tz_ok = $info->{extra}{floating_tz_ok}; |
133 | |
445e5e31 |
134 | $self->inflate_column( |
135 | $column => |
136 | { |
137 | inflate => sub { |
138 | my ($value, $obj) = @_; |
33a126ef |
139 | my $dt = eval { $obj->_datetime_parser->$parse($value); }; |
dceeddc7 |
140 | die "Error while inflating ${value} for ${column} on ${self}: $@" |
141 | if $@ and not $undef_if_invalid; |
dda9af55 |
142 | $dt->set_time_zone($timezone) if $timezone; |
143 | return $dt; |
445e5e31 |
144 | }, |
145 | deflate => sub { |
146 | my ($value, $obj) = @_; |
47cd9169 |
147 | if ($timezone) { |
148 | warn "You're using a floating timezone, please see the documentation of" |
149 | . " DBIx::Class::InflateColumn::DateTime for an explanation" |
150 | if ref( $value->time_zone ) eq 'DateTime::TimeZone::Floating' |
151 | and not $floating_tz_ok |
152 | and not $ENV{DBIC_FLOATING_TZ_OK}; |
153 | $value->set_time_zone($timezone); |
154 | } |
c209c4fd |
155 | $obj->_datetime_parser->$format($value); |
445e5e31 |
156 | }, |
157 | } |
158 | ); |
159 | } |
160 | } |
161 | |
162 | sub _datetime_parser { |
163 | my $self = shift; |
164 | if (my $parser = $self->__datetime_parser) { |
165 | return $parser; |
166 | } |
167 | my $parser = $self->result_source->storage->datetime_parser(@_); |
168 | return $self->__datetime_parser($parser); |
169 | } |
170 | |
171 | 1; |
0b375b68 |
172 | __END__ |
173 | |
45147005 |
174 | =head1 USAGE NOTES |
175 | |
176 | If you have a datetime column with the C<timezone> extra setting, and subsenquently |
177 | create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating> |
178 | timezone, you will get a warning (as there is a very good chance this will not have the |
179 | result you expect). For example: |
180 | |
181 | __PACKAGE__->add_columns( |
182 | starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } } |
183 | ); |
184 | |
185 | my $event = $schema->resultset('EventTZ')->create({ |
186 | starts_at => DateTime->new(year=>2007, month=>12, day=>31, ), |
187 | }); |
188 | |
189 | The warning can be avoided in several ways: |
190 | |
191 | =over |
192 | |
193 | =item Fix your broken code |
194 | |
195 | When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply |
196 | set to the requested value, and B<no time conversion takes place>. It is always a good idea |
197 | to be supply explicit times to the database: |
198 | |
199 | my $event = $schema->resultset('EventTZ')->create({ |
200 | starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ), |
201 | }); |
202 | |
203 | =item Suppress the check on per-column basis |
204 | |
205 | __PACKAGE__->add_columns( |
206 | starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago", floating_tz_ok => 1 } } |
207 | ); |
208 | |
209 | =item Suppress the check globally |
210 | |
211 | Set the environment variable DBIC_FLOATING_TZ_OK to some true value. |
212 | |
213 | =back |
214 | |
215 | |
216 | |
0b375b68 |
217 | =head1 SEE ALSO |
218 | |
219 | =over 4 |
220 | |
221 | =item More information about the add_columns method, and column metadata, |
222 | can be found in the documentation for L<DBIx::Class::ResultSource>. |
223 | |
45147005 |
224 | =item Further discussion of problems inherent to the Floating timezone: |
225 | L<Floating DateTimes|DateTime/Floating_DateTimes> |
226 | and L<< $dt->set_time_zone|DateTime/"Set" Methods >> |
227 | |
0b375b68 |
228 | =back |
229 | |
230 | =head1 AUTHOR |
231 | |
232 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
233 | |
234 | =head1 CONTRIBUTORS |
235 | |
236 | Aran Deltac <bluefeet@cpan.org> |
237 | |
238 | =head1 LICENSE |
239 | |
240 | You may distribute this code under the same terms as Perl itself. |
241 | |