Remove TODO labels from blocks not using todo_skip() - no test changes
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / InflateColumn / DateTime.pm
CommitLineData
445e5e31 1package DBIx::Class::InflateColumn::DateTime;
2
3use strict;
4use warnings;
5use base qw/DBIx::Class/;
70c28808 6use DBIx::Class::Carp;
ed7ab0f4 7use Try::Tiny;
fd323bf1 8use namespace::clean;
445e5e31 9
0b375b68 10=head1 NAME
11
5d0a2955 12DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
0b375b68 13
14=head1 SYNOPSIS
15
fd323bf1 16Load this component and then declare one or more
679a304a 17columns to be of the datetime, timestamp or date datatype.
0b375b68 18
19 package Event;
d88ecca6 20 use base 'DBIx::Class::Core';
21
22 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
0b375b68 23 __PACKAGE__->add_columns(
24 starts_when => { data_type => 'datetime' }
9c71b5e2 25 create_date => { data_type => 'date' }
0b375b68 26 );
27
28Then you can treat the specified column as a L<DateTime> object.
29
30 print "This event starts the month of ".
31 $event->starts_when->month_name();
32
8d689133 33If you want to set a specific timezone and locale for that field, use:
dda9af55 34
35 __PACKAGE__->add_columns(
92ed0695 36 starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" }
dda9af55 37 );
38
a97fe7e0 39If you want to inflate no matter what data_type your column is,
40use inflate_datetime or inflate_date:
41
42 __PACKAGE__->add_columns(
43 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
44 );
d4daee7b 45
a97fe7e0 46 __PACKAGE__->add_columns(
47 starts_when => { data_type => 'varchar', inflate_date => 1 }
48 );
49
ff8a6e3b 50It's also possible to explicitly skip inflation:
d4daee7b 51
ff8a6e3b 52 __PACKAGE__->add_columns(
53 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
54 );
55
8bf37b16 56NOTE: Don't rely on C<InflateColumn::DateTime> to parse date strings for you.
57The column is set directly for any non-references and C<InflateColumn::DateTime>
58is completely bypassed. Instead, use an input parser to create a DateTime
59object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can
60use C<DateTime::Format::ISO8601> thusly:
d6aed638 61
62 use DateTime::Format::ISO8601;
63 my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD');
64
0b375b68 65=head1 DESCRIPTION
66
fd323bf1 67This module figures out the type of DateTime::Format::* class to
68inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
69that you are using. If you switch from one database to a different
5d0a2955 70one your code should continue to work without modification (though note
71that this feature is new as of 0.07, so it may not be perfect yet - bug
72reports to the list very much welcome).
0b375b68 73
9c71b5e2 74If the data_type of a field is C<date>, C<datetime> or C<timestamp> (or
f59e543b 75a derivative of these datatypes, e.g. C<timestamp with timezone>), this
9c71b5e2 76module will automatically call the appropriate parse/format method for
77deflation/inflation as defined in the storage class. For instance, for
78a C<datetime> field the methods C<parse_datetime> and C<format_datetime>
79would be called on deflation/inflation. If the storage class does not
80provide a specialized inflator/deflator, C<[parse|format]_datetime> will
81be used as a fallback. See L<DateTime::Format> for more information on
82date formatting.
83
943f93f2 84For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
de78905b 85
0b375b68 86=cut
87
445e5e31 88__PACKAGE__->load_components(qw/InflateColumn/);
89
9b83fccd 90=head2 register_column
91
92Chains with the L<DBIx::Class::Row/register_column> method, and sets
93up datetime columns appropriately. This would not normally be
94directly called by end users.
95
33a126ef 96In the case of an invalid date, L<DateTime> will throw an exception. To
97bypass these exceptions and just have the inflation return undef, use
98the C<datetime_undef_if_invalid> option in the column info:
d4daee7b 99
33a126ef 100 "broken_date",
101 {
102 data_type => "datetime",
103 default_value => '0000-00-00',
104 is_nullable => 1,
105 datetime_undef_if_invalid => 1
106 }
107
9b83fccd 108=cut
109
445e5e31 110sub register_column {
111 my ($self, $column, $info, @rest) = @_;
49bceca3 112
445e5e31 113 $self->next::method($column, $info, @rest);
bb90689c 114
49bceca3 115 my $requested_type;
bbe0a14d 116 for (qw/datetime timestamp date/) {
bb90689c 117 my $key = "inflate_${_}";
bbe0a14d 118 if (exists $info->{$key}) {
bb90689c 119
bbe0a14d 120 # this bailout is intentional
121 return unless $info->{$key};
49bceca3 122
bbe0a14d 123 $requested_type = $_;
124 last;
125 }
bb90689c 126 }
127
bbe0a14d 128 return if (!$requested_type and !$info->{data_type});
129
130 my $data_type = lc( $info->{data_type} || '' );
49bceca3 131
132 # _ic_dt_method will follow whatever the registration requests
133 # thus = instead of ||=
134 if ($data_type eq 'timestamp with time zone' || $data_type eq 'timestamptz') {
135 $info->{_ic_dt_method} = 'timestamp_with_timezone';
136 }
137 elsif ($data_type eq 'timestamp without time zone') {
138 $info->{_ic_dt_method} = 'timestamp_without_timezone';
139 }
140 elsif ($data_type eq 'smalldatetime') {
141 $info->{_ic_dt_method} = 'smalldatetime';
142 }
143 elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) {
144 $info->{_ic_dt_method} = $data_type;
145 }
bbe0a14d 146 elsif ($requested_type) {
49bceca3 147 $info->{_ic_dt_method} = $requested_type;
bb90689c 148 }
bbe0a14d 149 else {
150 return;
151 }
dda9af55 152
226d1c35 153 if ($info->{extra}) {
154 for my $slot (qw/timezone locale floating_tz_ok/) {
155 if ( defined $info->{extra}{$slot} ) {
156 carp "Putting $slot into extra => { $slot => '...' } has been deprecated, ".
157 "please put it directly into the '$column' column definition.";
158 $info->{$slot} = $info->{extra}{$slot} unless defined $info->{$slot};
159 }
1c2ffef9 160 }
8d689133 161 }
d4daee7b 162
226d1c35 163 # shallow copy to avoid unfounded(?) Devel::Cycle complaints
164 my $infcopy = {%$info};
165
166 $self->inflate_column(
167 $column =>
168 {
169 inflate => sub {
170 my ($value, $obj) = @_;
171
24f5cbcb 172 # propagate for error reporting
173 $infcopy->{__dbic_colname} = $column;
174
175 my $dt = $obj->_inflate_to_datetime( $value, $infcopy );
226d1c35 176
177 return (defined $dt)
178 ? $obj->_post_inflate_datetime( $dt, $infcopy )
179 : undef
180 ;
181 },
182 deflate => sub {
183 my ($value, $obj) = @_;
184
185 $value = $obj->_pre_deflate_datetime( $value, $infcopy );
186 $obj->_deflate_from_datetime( $value, $infcopy );
187 },
188 }
189 );
445e5e31 190}
191
ab969dd4 192sub _flate_or_fallback
193{
194 my( $self, $value, $info, $method_fmt ) = @_;
195
196 my $parser = $self->_datetime_parser;
197 my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method });
24f5cbcb 198 my $method = $parser->can($preferred_method) || sprintf($method_fmt, 'datetime');
199
200 return try {
201 $parser->$method($value);
202 }
203 catch {
204 $self->throw_exception ("Error while inflating ${value} for $info->{__dbic_colname} on ${self}: $_")
205 unless $info->{datetime_undef_if_invalid};
206 undef; # rv
207 };
ab969dd4 208}
209
210sub _inflate_to_datetime {
211 my( $self, $value, $info ) = @_;
212 return $self->_flate_or_fallback( $value, $info, 'parse_%s' );
213}
214
215sub _deflate_from_datetime {
216 my( $self, $value, $info ) = @_;
217 return $self->_flate_or_fallback( $value, $info, 'format_%s' );
218}
abc914bd 219
445e5e31 220sub _datetime_parser {
f568d83b 221 shift->result_source->storage->datetime_parser (@_);
445e5e31 222}
223
f856fe01 224sub _post_inflate_datetime {
225 my( $self, $dt, $info ) = @_;
226
c3ed0bde 227 $dt->set_time_zone($info->{timezone}) if defined $info->{timezone};
228 $dt->set_locale($info->{locale}) if defined $info->{locale};
f856fe01 229
230 return $dt;
231}
232
233sub _pre_deflate_datetime {
234 my( $self, $dt, $info ) = @_;
235
c3ed0bde 236 if (defined $info->{timezone}) {
f856fe01 237 carp "You're using a floating timezone, please see the documentation of"
238 . " DBIx::Class::InflateColumn::DateTime for an explanation"
239 if ref( $dt->time_zone ) eq 'DateTime::TimeZone::Floating'
240 and not $info->{floating_tz_ok}
241 and not $ENV{DBIC_FLOATING_TZ_OK};
242
c3ed0bde 243 $dt->set_time_zone($info->{timezone});
f856fe01 244 }
245
c3ed0bde 246 $dt->set_locale($info->{locale}) if defined $info->{locale};
f856fe01 247
248 return $dt;
249}
250
445e5e31 2511;
0b375b68 252__END__
253
45147005 254=head1 USAGE NOTES
255
97983826 256If you have a datetime column with an associated C<timezone>, and subsequently
45147005 257create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating>
258timezone, you will get a warning (as there is a very good chance this will not have the
259result you expect). For example:
260
261 __PACKAGE__->add_columns(
92ed0695 262 starts_when => { data_type => 'datetime', timezone => "America/Chicago" }
45147005 263 );
264
265 my $event = $schema->resultset('EventTZ')->create({
266 starts_at => DateTime->new(year=>2007, month=>12, day=>31, ),
267 });
268
269The warning can be avoided in several ways:
270
271=over
272
273=item Fix your broken code
274
275When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply
276set to the requested value, and B<no time conversion takes place>. It is always a good idea
277to be supply explicit times to the database:
278
279 my $event = $schema->resultset('EventTZ')->create({
280 starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ),
281 });
282
283=item Suppress the check on per-column basis
284
285 __PACKAGE__->add_columns(
92ed0695 286 starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 }
45147005 287 );
288
289=item Suppress the check globally
290
291Set the environment variable DBIC_FLOATING_TZ_OK to some true value.
292
293=back
294
92ed0695 295Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been
296B<DEPRECATED> because this gets you into trouble using L<DBIx::Class::Schema::Versioned>.
297Instead put it directly into the columns definition like in the examples above. If you still
298use the old way you'll see a warning - please fix your code then!
45147005 299
0b375b68 300=head1 SEE ALSO
301
302=over 4
303
fd323bf1 304=item More information about the add_columns method, and column metadata,
0b375b68 305 can be found in the documentation for L<DBIx::Class::ResultSource>.
306
45147005 307=item Further discussion of problems inherent to the Floating timezone:
9361b05d 308 L<Floating DateTimes|DateTime/Floating DateTimes>
45147005 309 and L<< $dt->set_time_zone|DateTime/"Set" Methods >>
310
0b375b68 311=back
312
313=head1 AUTHOR
314
315Matt S. Trout <mst@shadowcatsystems.co.uk>
316
317=head1 CONTRIBUTORS
318
319Aran Deltac <bluefeet@cpan.org>
320
321=head1 LICENSE
322
323You may distribute this code under the same terms as Perl itself.
324