X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=54e66f5c454e6bd5448480ca7e3f41ed0ef0ec87;hb=6c99a3eea0da8f254e67fdda21e27f9ef9fbeec3;hp=f92481db22be0b97b88d01f26fc6ae664ce17f80;hpb=517d5d64cfee2594c6f68d8bf6a498d88ea878f6;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index f92481d..54e66f5 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -3,6 +3,7 @@ package DBIx::Class::InflateColumn::DateTime; use strict; use warnings; use base qw/DBIx::Class/; +use Carp::Clan qw/^DBIx::Class/; =head1 NAME @@ -19,11 +20,37 @@ columns to be of the datetime, timestamp or date datatype. starts_when => { data_type => 'datetime' } ); +NOTE: You B load C B C. See +L for details. + Then you can treat the specified column as a L object. print "This event starts the month of ". $event->starts_when->month_name(); +If you want to set a specific timezone and locale for that field, use: + + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" } + ); + +If you want to inflate no matter what data_type your column is, +use inflate_datetime or inflate_date: + + __PACKAGE__->add_columns( + starts_when => { data_type => 'varchar', inflate_datetime => 1 } + ); + + __PACKAGE__->add_columns( + starts_when => { data_type => 'varchar', inflate_date => 1 } + ); + +It's also possible to explicitly skip inflation: + + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', inflate_datetime => 0 } + ); + =head1 DESCRIPTION This module figures out the type of DateTime::Format::* class to @@ -47,32 +74,125 @@ Chains with the L method, and sets up datetime columns appropriately. This would not normally be directly called by end users. +In the case of an invalid date, L will throw an exception. To +bypass these exceptions and just have the inflation return undef, use +the C option in the column info: + + "broken_date", + { + data_type => "datetime", + default_value => '0000-00-00', + is_nullable => 1, + datetime_undef_if_invalid => 1 + } + =cut sub register_column { my ($self, $column, $info, @rest) = @_; $self->next::method($column, $info, @rest); return unless defined($info->{data_type}); - my $type = lc($info->{data_type}); - $type = 'datetime' if ($type eq 'timestamp'); - if ($type eq 'datetime' || $type eq 'date') { - my ($parse, $format) = ("parse_${type}", "format_${type}"); + + my $type; + + for (qw/date datetime timestamp/) { + my $key = "inflate_${_}"; + + next unless exists $info->{$key}; + return unless $info->{$key}; + + $type = $_; + last; + } + + unless ($type) { + $type = lc($info->{data_type}); + if ($type eq "timestamp with time zone" || $type eq "timestamptz") { + $type = "timestamp"; + $info->{_ic_dt_method} ||= "timestamp_with_timezone"; + } + } + + my $timezone; + if ( defined $info->{extra}{timezone} ) { + carp "Putting timezone into extra => { timezone => '...' } has been deprecated, ". + "please put it directly into the columns definition."; + $timezone = $info->{extra}{timezone}; + } + + my $locale; + if ( defined $info->{extra}{locale} ) { + carp "Putting locale into extra => { locale => '...' } has been deprecated, ". + "please put it directly into the columns definition."; + $locale = $info->{extra}{locale}; + } + + $locale = $info->{locale} if defined $info->{locale}; + $timezone = $info->{timezone} if defined $info->{timezone}; + + my $undef_if_invalid = $info->{datetime_undef_if_invalid}; + + if ($type eq 'datetime' || $type eq 'date' || $type eq 'timestamp') { + # This shallow copy of %info avoids t/52_cycle.t treating + # the resulting deflator as a circular reference. + my %info = ( '_ic_dt_method' => $type , %{ $info } ); + + if (defined $info->{extra}{floating_tz_ok}) { + carp "Putting floating_tz_ok into extra => { floating_tz_ok => 1 } has been deprecated, ". + "please put it directly into the columns definition."; + $info{floating_tz_ok} = $info->{extra}{floating_tz_ok}; + } + $self->inflate_column( $column => { inflate => sub { my ($value, $obj) = @_; - $obj->_datetime_parser->$parse($value); + my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) }; + $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $@") + if $@ and not $undef_if_invalid; + $dt->set_time_zone($timezone) if $timezone; + $dt->set_locale($locale) if $locale; + return $dt; }, deflate => sub { my ($value, $obj) = @_; - $obj->_datetime_parser->$format($value); + if ($timezone) { + carp "You're using a floating timezone, please see the documentation of" + . " DBIx::Class::InflateColumn::DateTime for an explanation" + if ref( $value->time_zone ) eq 'DateTime::TimeZone::Floating' + and not $info{floating_tz_ok} + and not $ENV{DBIC_FLOATING_TZ_OK}; + $value->set_time_zone($timezone); + $value->set_locale($locale) if $locale; + } + $obj->_deflate_from_datetime( $value, \%info ); }, } ); } } +sub _flate_or_fallback +{ + my( $self, $value, $info, $method_fmt ) = @_; + + my $parser = $self->_datetime_parser; + my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method }); + my $method = $parser->can($preferred_method) ? $preferred_method : sprintf($method_fmt, 'datetime'); + return $parser->$method($value); +} + +sub _inflate_to_datetime { + my( $self, $value, $info ) = @_; + return $self->_flate_or_fallback( $value, $info, 'parse_%s' ); +} + +sub _deflate_from_datetime { + my( $self, $value, $info ) = @_; + return $self->_flate_or_fallback( $value, $info, 'format_%s' ); +} + sub _datetime_parser { my $self = shift; if (my $parser = $self->__datetime_parser) { @@ -85,6 +205,52 @@ sub _datetime_parser { 1; __END__ +=head1 USAGE NOTES + +If you have a datetime column with the C extra setting, and subsenquently +create/update this column with a DateTime object in the L +timezone, you will get a warning (as there is a very good chance this will not have the +result you expect). For example: + + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', timezone => "America/Chicago" } + ); + + my $event = $schema->resultset('EventTZ')->create({ + starts_at => DateTime->new(year=>2007, month=>12, day=>31, ), + }); + +The warning can be avoided in several ways: + +=over + +=item Fix your broken code + +When calling C on a Floating DateTime object, the timezone is simply +set to the requested value, and B. It is always a good idea +to be supply explicit times to the database: + + my $event = $schema->resultset('EventTZ')->create({ + starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ), + }); + +=item Suppress the check on per-column basis + + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 } + ); + +=item Suppress the check globally + +Set the environment variable DBIC_FLOATING_TZ_OK to some true value. + +=back + +Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been +B because this gets you into trouble using L. +Instead put it directly into the columns definition like in the examples above. If you still +use the old way you'll see a warning - please fix your code then! + =head1 SEE ALSO =over 4 @@ -92,6 +258,10 @@ __END__ =item More information about the add_columns method, and column metadata, can be found in the documentation for L. +=item Further discussion of problems inherent to the Floating timezone: + L + and L<< $dt->set_time_zone|DateTime/"Set" Methods >> + =back =head1 AUTHOR