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