X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=dda4a1031071966b61241b5396fe190feac71348;hb=1c2ffef943bebdfb33eaf7217f171cb7fcfbced8;hp=fbdccbce874c8de1fdc23df162e59bc1d293009b;hpb=8bf37b16729d6f5e2bf5f583a91d6f032a27a1f4;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index fbdccbc..dda4a10 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -4,6 +4,8 @@ use strict; use warnings; use base qw/DBIx::Class/; use Carp::Clan qw/^DBIx::Class/; +use Try::Tiny; +use namespace::clean; =head1 NAME @@ -11,18 +13,18 @@ DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date an =head1 SYNOPSIS -Load this component and then declare one or more +Load this component and then declare one or more columns to be of the datetime, timestamp or date datatype. package Event; - __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/); + use base 'DBIx::Class::Core'; + + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); __PACKAGE__->add_columns( starts_when => { data_type => 'datetime' } + create_date => { data_type => 'date' } ); -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 ". @@ -40,13 +42,13 @@ 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 } ); @@ -62,21 +64,29 @@ use C thusly: =head1 DESCRIPTION -This module figures out the type of DateTime::Format::* class to -inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* -that you are using. If you switch from one database to a different +This module figures out the type of DateTime::Format::* class to +inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* +that you are using. If you switch from one database to a different one your code should continue to work without modification (though note that this feature is new as of 0.07, so it may not be perfect yet - bug reports to the list very much welcome). +If the data_type of a field is C, C or C (or +a derivative of these datatypes, e.g. C), this +module will automatically call the appropriate parse/format method for +deflation/inflation as defined in the storage class. For instance, for +a C field the methods C and C +would be called on deflation/inflation. If the storage class does not +provide a specialized inflator/deflator, C<[parse|format]_datetime> will +be used as a fallback. See L for more information on +date formatting. + For more help with using components, see L. =cut __PACKAGE__->load_components(qw/InflateColumn/); -__PACKAGE__->mk_group_accessors('simple' => '__datetime_parser'); - =head2 register_column Chains with the L method, and sets @@ -86,7 +96,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", @@ -119,25 +129,28 @@ sub register_column { if ($type eq "timestamp with time zone" || $type eq "timestamptz") { $type = "timestamp"; $info->{_ic_dt_method} ||= "timestamp_with_timezone"; + } elsif ($type eq "timestamp without time zone") { + $type = "timestamp"; + $info->{_ic_dt_method} ||= "timestamp_without_timezone"; + } elsif ($type eq "smalldatetime") { + $type = "datetime"; + $info->{_ic_dt_method} ||= "smalldatetime"; } } - my $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}; - } + if ($info->{extra}) { + if ( defined $info->{extra}{timezone} ) { + carp "Putting timezone into extra => { timezone => '...' } has been deprecated, ". + "please put it directly into the '$column' column definition."; + $info->{timezone} = $info->{extra}{timezone} unless defined $info->{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}; + if ( defined $info->{extra}{locale} ) { + carp "Putting locale into extra => { locale => '...' } has been deprecated, ". + "please put it directly into the '$column' column definition."; + $info->{locale} = $info->{extra}{locale} unless defined $info->{locale}; + } } - - $locale = $info->{locale} if defined $info->{locale}; - $timezone = $info->{timezone} if defined $info->{timezone}; my $undef_if_invalid = $info->{datetime_undef_if_invalid}; @@ -158,27 +171,23 @@ sub register_column { inflate => sub { my ($value, $obj) = @_; - 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; + my $dt = try + { $obj->_inflate_to_datetime( $value, \%info ) } + catch { + $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $_") + unless $undef_if_invalid; + undef; # rv + }; + + return (defined $dt) + ? $obj->_post_inflate_datetime( $dt, \%info ) + : undef + ; }, deflate => sub { my ($value, $obj) = @_; - 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; - } + + $value = $obj->_pre_deflate_datetime( $value, \%info ); $obj->_deflate_from_datetime( $value, \%info ); }, } @@ -207,12 +216,34 @@ sub _deflate_from_datetime { } sub _datetime_parser { - my $self = shift; - if (my $parser = $self->__datetime_parser) { - return $parser; + shift->result_source->storage->datetime_parser (@_); +} + +sub _post_inflate_datetime { + my( $self, $dt, $info ) = @_; + + $dt->set_time_zone($info->{timezone}) if defined $info->{timezone}; + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; +} + +sub _pre_deflate_datetime { + my( $self, $dt, $info ) = @_; + + if (defined $info->{timezone}) { + carp "You're using a floating timezone, please see the documentation of" + . " DBIx::Class::InflateColumn::DateTime for an explanation" + if ref( $dt->time_zone ) eq 'DateTime::TimeZone::Floating' + and not $info->{floating_tz_ok} + and not $ENV{DBIC_FLOATING_TZ_OK}; + + $dt->set_time_zone($info->{timezone}); } - my $parser = $self->result_source->storage->datetime_parser(@_); - return $self->__datetime_parser($parser); + + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; } 1; @@ -268,11 +299,11 @@ use the old way you'll see a warning - please fix your code then! =over 4 -=item More information about the add_columns method, and column metadata, +=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 + L and L<< $dt->set_time_zone|DateTime/"Set" Methods >> =back