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