X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=30242411c374a82c3e75a50093c4e7a6bd2db48e;hb=cdacba7e0c9b7bc947ae47238be4c6a25f9c7b13;hp=2340f11e946f022263b01db62c5da6f93af5d575;hpb=bc54fd79e9d59a9c360e0c0128bb8f5775213ab7;p=dbsrgits%2FDBIx-Class-Historic.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index 2340f11..3024241 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -19,15 +19,18 @@ 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 for that field, use: +If you want to set a specific timezone and locale for that field, use: __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } } + starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago", locale => "de_DE" } } ); If you want to inflate no matter what data_type your column is, @@ -47,44 +50,6 @@ It's also possible to explicitly skip inflation: starts_when => { data_type => 'datetime', inflate_datetime => 0 } ); -=head1 WARNING - -You'll notice some warning about floating timezone if you set timezone in your schema but -didn't set it when creating/updating a row: - - __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } } - ); - - my $event = $schema->resultset('EventTZ')->create({ - starts_at => DateTime->new(year=>2007, month=>12, day=>31, ), - }); - -To avoid this, you have three options: - -=over - -=item Fix your broken code - - my $event = $schema->resultset('EventTZ')->create({ - starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ), - }); - -=item Suppress the warning by doing either ... - - __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago", floating_tz_ok => 1 } } - ); - -=item ... or ... - -Set environment variable DBIC_FLOATING_TZ_OK to some true value. - -=back - -Please take a look at L for further information about floating -timezone. - =head1 DESCRIPTION This module figures out the type of DateTime::Format::* class to @@ -145,15 +110,35 @@ sub register_column { } my $timezone; - if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) { + if ( defined $info->{extra}{timezone} ) { $timezone = $info->{extra}{timezone}; } - my $floating_tz_ok = $info->{extra}{floating_tz_ok} ? 1 : 0; + my $locale; + if ( defined $info->{extra}{locale} ) { + $locale = $info->{extra}{locale}; + } + my $undef_if_invalid = $info->{datetime_undef_if_invalid}; if ($type eq 'datetime' || $type eq 'date') { my ($parse, $format) = ("parse_${type}", "format_${type}"); + + # This assignment must happen here, otherwise Devel::Cycle treats + # the resulting deflator as a circular reference (go figure): + # + # Cycle #1 + # DBICTest::Schema A->{source_registrations} => %B + # %B->{Event} => DBIx::Class::ResultSource::Table C + # DBIx::Class::ResultSource::Table C->{_columns} => %D + # %D->{created_on} => %E + # %E->{_inflate_info} => %F + # %F->{deflate} => &G + # closure &G, $info => $H + # $H => %E + # + my $floating_tz_ok = $info->{extra}{floating_tz_ok}; + $self->inflate_column( $column => { @@ -163,6 +148,7 @@ sub register_column { die "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 { @@ -174,6 +160,7 @@ sub register_column { and not $floating_tz_ok and not $ENV{DBIC_FLOATING_TZ_OK}; $value->set_time_zone($timezone); + $value->set_locale($locale) if $locale; } $obj->_datetime_parser->$format($value); }, @@ -194,6 +181,49 @@ 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', extra => { 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', extra => { 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 + + + =head1 SEE ALSO =over 4 @@ -201,6 +231,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