=head1 NAME
-DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from datetime columns.
+DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
=head1 SYNOPSIS
Load this component and then declare one or more
-columns to be of the datetime datatype.
+columns to be of the datetime, timestamp or date datatype.
package Event;
- __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
+ __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/);
__PACKAGE__->add_columns(
starts_when => { data_type => 'datetime' }
);
print "This event starts the month of ".
$event->starts_when->month_name();
+If you want to set a specific timezone for that field, use:
+
+ __PACKAGE__->add_columns(
+ starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } }
+ );
+
+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
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 will continue to work without modification.
+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).
+
+For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
=cut
up datetime columns appropriately. This would not normally be
directly called by end users.
+In the case of an invalid date, L<DateTime> will throw an exception. To
+bypass these exceptions and just have the inflation return undef, use
+the C<datetime_undef_if_invalid> 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);
- if (defined($info->{data_type}) && $info->{data_type} =~ /^datetime$/i) {
+ return unless defined($info->{data_type});
+ my $type = lc($info->{data_type});
+ $type = 'datetime' if ($type =~ /^timestamp/);
+ $type = 'datetime' if $info->{inflate_datetime};
+ $type = 'date' if $info->{inflate_date};
+ my $timezone;
+ if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) {
+ $timezone = $info->{extra}{timezone};
+ }
+
+ my $undef_if_invalid = $info->{datetime_undef_if_invalid};
+
+ my $do_inflate = 1;
+ $do_inflate = 0 if exists $info->{inflate_datetime} and $info->{inflate_datetime} == 0;
+ $do_inflate = 0 if exists $info->{inflate_date} and $info->{inflate_date} == 0;
+
+ if ($do_inflate and ($type eq 'datetime' || $type eq 'date')) {
+ my ($parse, $format) = ("parse_${type}", "format_${type}");
$self->inflate_column(
$column =>
{
inflate => sub {
my ($value, $obj) = @_;
- $obj->_datetime_parser->parse_datetime($value);
+ my $dt = eval { $obj->_datetime_parser->$parse($value); };
+ die "Error while inflating ${value} for ${column} on ${self}: $@"
+ if $@ and not $undef_if_invalid;
+ $dt->set_time_zone($timezone) if $timezone;
+ return $dt;
},
deflate => sub {
my ($value, $obj) = @_;
- $obj->_datetime_parser->format_datetime($value);
+ $value->set_time_zone($timezone) if $timezone;
+ $obj->_datetime_parser->$format($value);
},
}
);