X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=cf5e28c150914d439645fc73664c370aac54aaf1;hb=d4daee7b54e38e4b3d3d0a77759bddc1a4ede6e5;hp=8e2e2d5d2480d03e17985f0eda2c2158ee09bfd9;hpb=2c96eeed34d7fa42dbb9dbae04a93a9dc0048e2e;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index 8e2e2d5..cf5e28c 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 @@ -27,10 +28,10 @@ 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', timezone => "America/Chicago", locale => "de_DE" } ); If you want to inflate no matter what data_type your column is, @@ -39,17 +40,26 @@ 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 } ); +NOTE: Don't rely on C to parse date strings for you. +The column is set directly for any non-references and C +is completely bypassed. Instead, use an input parser to create a DateTime +object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can +use C thusly: + + use DateTime::Format::ISO8601; + my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD'); + =head1 DESCRIPTION This module figures out the type of DateTime::Format::* class to @@ -76,7 +86,7 @@ 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", @@ -94,7 +104,7 @@ sub register_column { my $type; - for (qw/date datetime/) { + for (qw/date datetime timestamp/) { my $key = "inflate_${_}"; next unless exists $info->{$key}; @@ -106,62 +116,96 @@ sub register_column { unless ($type) { $type = lc($info->{data_type}); - $type = 'datetime' if ($type =~ /^timestamp/); + if ($type eq "timestamp with time zone" || $type eq "timestamptz") { + $type = "timestamp"; + $info->{_ic_dt_method} ||= "timestamp_with_timezone"; + } } my $timezone; - if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) { + if ( defined $info->{extra}{timezone} ) { + carp "Putting timezone into extra => { timezone => '...' } has been deprecated, ". + "please put it directly into the '$column' column 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 '$column' column 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') { - 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}; + 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 '$column' column definition."; + $info{floating_tz_ok} = $info->{extra}{floating_tz_ok}; + } $self->inflate_column( $column => { inflate => sub { my ($value, $obj) = @_; - my $dt = eval { $obj->_datetime_parser->$parse($value); }; - die "Error while inflating ${value} for ${column} on ${self}: $@" - if $@ and not $undef_if_invalid; + + my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) }; + if (my $err = $@ ) { + return undef if ($undef_if_invalid); + $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $err"); + } + $dt->set_time_zone($timezone) if $timezone; + $dt->set_locale($locale) if $locale; return $dt; }, deflate => sub { my ($value, $obj) = @_; if ($timezone) { - warn "You're using a floating timezone, please see the documentation of" + 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 $floating_tz_ok + 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->_datetime_parser->$format($value); + $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) { @@ -176,13 +220,13 @@ __END__ =head1 USAGE NOTES -If you have a datetime column with the C extra setting, and subsenquently +If you have a datetime column with an associated C, and subsequently 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" } } + starts_when => { data_type => 'datetime', timezone => "America/Chicago" } ); my $event = $schema->resultset('EventTZ')->create({ @@ -206,7 +250,7 @@ to be supply explicit times to the database: =item Suppress the check on per-column basis __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago", floating_tz_ok => 1 } } + starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 } ); =item Suppress the check globally @@ -215,7 +259,10 @@ 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