use warnings;
use base qw/DBIx::Class/;
use Carp::Clan qw/^DBIx::Class/;
+use Try::Tiny;
+use namespace::clean;
=head1 NAME
=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<must> load C<InflateColumn::DateTime> B<before> C<Core>. See
-L<DBIx::Class::Manual::Component> for details.
-
Then you can treat the specified column as a L<DateTime> object.
print "This event starts the month of ".
=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<date>, C<datetime> or C<timestamp> (or
+a derivative of these datatypes, e.g. C<timestamp with timezone>), this
+module will automatically call the appropriate parse/format method for
+deflation/inflation as defined in the storage class. For instance, for
+a C<datetime> field the methods C<parse_datetime> and C<format_datetime>
+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<DateTime::Format> for more information on
+date formatting.
+
For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
=cut
__PACKAGE__->load_components(qw/InflateColumn/);
-__PACKAGE__->mk_group_accessors('simple' => '__datetime_parser');
-
=head2 register_column
Chains with the L<DBIx::Class::Row/register_column> method, and sets
sub register_column {
my ($self, $column, $info, @rest) = @_;
+
$self->next::method($column, $info, @rest);
- return unless defined($info->{data_type});
- my $type;
+ return unless defined($info->{data_type});
+ my $requested_type;
for (qw/date datetime timestamp/) {
my $key = "inflate_${_}";
next unless exists $info->{$key};
- return unless $info->{$key};
- $type = $_;
+ return if ! $info->{$key};
+
+ $requested_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 $data_type = lc($info->{data_type} || '');
- 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};
+ # _ic_dt_method will follow whatever the registration requests
+ # thus = instead of ||=
+ if ($data_type eq 'timestamp with time zone' || $data_type eq 'timestamptz') {
+ $info->{_ic_dt_method} = 'timestamp_with_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};
+ elsif ($data_type eq 'timestamp without time zone') {
+ $info->{_ic_dt_method} = 'timestamp_without_timezone';
+ }
+ elsif ($data_type eq 'smalldatetime') {
+ $info->{_ic_dt_method} = 'smalldatetime';
+ }
+ elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) {
+ $info->{_ic_dt_method} = $data_type;
+ }
+ else {
+ $info->{_ic_dt_method} = $requested_type;
}
- $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 } );
+ return unless $info->{_ic_dt_method};
- 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};
+ if ($info->{extra}) {
+ for my $slot (qw/timezone locale floating_tz_ok/) {
+ if ( defined $info->{extra}{$slot} ) {
+ carp "Putting $slot into extra => { $slot => '...' } has been deprecated, ".
+ "please put it directly into the '$column' column definition.";
+ $info->{$slot} = $info->{extra}{$slot} unless defined $info->{$slot};
+ }
}
-
- $self->inflate_column(
- $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;
- },
- 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;
- }
- $obj->_deflate_from_datetime( $value, \%info );
- },
- }
- );
}
+
+ # shallow copy to avoid unfounded(?) Devel::Cycle complaints
+ my $infcopy = {%$info};
+
+ $self->inflate_column(
+ $column =>
+ {
+ inflate => sub {
+ my ($value, $obj) = @_;
+
+ my $dt = try
+ { $obj->_inflate_to_datetime( $value, $infcopy ) }
+ catch {
+ $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $_")
+ unless $infcopy->{datetime_undef_if_invalid};
+ undef; # rv
+ };
+
+ return (defined $dt)
+ ? $obj->_post_inflate_datetime( $dt, $infcopy )
+ : undef
+ ;
+ },
+ deflate => sub {
+ my ($value, $obj) = @_;
+
+ $value = $obj->_pre_deflate_datetime( $value, $infcopy );
+ $obj->_deflate_from_datetime( $value, $infcopy );
+ },
+ }
+ );
}
sub _flate_or_fallback
}
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;
=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<DBIx::Class::ResultSource>.
=item Further discussion of problems inherent to the Floating timezone:
- L<Floating DateTimes|DateTime/Floating_DateTimes>
+ L<Floating DateTimes|DateTime/Floating_DateTimes>
and L<< $dt->set_time_zone|DateTime/"Set" Methods >>
=back
projects / dbsrgits/DBIx-Class.git / blobdiff