1 package DBIx::Class::InflateColumn::DateTime;
5 use base qw/DBIx::Class/;
9 DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
13 Load this component and then declare one or more
14 columns to be of the datetime, timestamp or date datatype.
17 __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/);
18 __PACKAGE__->add_columns(
19 starts_when => { data_type => 'datetime' }
22 Then you can treat the specified column as a L<DateTime> object.
24 print "This event starts the month of ".
25 $event->starts_when->month_name();
27 If you want to set a specific timezone for that field, use:
29 __PACKAGE__->add_columns(
30 starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } }
33 If you want to inflate no matter what data_type your column is,
34 use inflate_datetime or inflate_date:
36 __PACKAGE__->add_columns(
37 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
40 __PACKAGE__->add_columns(
41 starts_when => { data_type => 'varchar', inflate_date => 1 }
44 It's also possible to explicitly skip inflation:
46 __PACKAGE__->add_columns(
47 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
52 This module figures out the type of DateTime::Format::* class to
53 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
54 that you are using. If you switch from one database to a different
55 one your code should continue to work without modification (though note
56 that this feature is new as of 0.07, so it may not be perfect yet - bug
57 reports to the list very much welcome).
59 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
63 __PACKAGE__->load_components(qw/InflateColumn/);
65 __PACKAGE__->mk_group_accessors('simple' => '__datetime_parser');
67 =head2 register_column
69 Chains with the L<DBIx::Class::Row/register_column> method, and sets
70 up datetime columns appropriately. This would not normally be
71 directly called by end users.
73 In the case of an invalid date, L<DateTime> will throw an exception. To
74 bypass these exceptions and just have the inflation return undef, use
75 the C<datetime_undef_if_invalid> option in the column info:
79 data_type => "datetime",
80 default_value => '0000-00-00',
82 datetime_undef_if_invalid => 1
88 my ($self, $column, $info, @rest) = @_;
89 $self->next::method($column, $info, @rest);
90 return unless defined($info->{data_type});
91 my $type = lc($info->{data_type});
92 $type = 'datetime' if ($type =~ /^timestamp/);
93 $type = 'datetime' if $info->{inflate_datetime};
94 $type = 'date' if $info->{inflate_date};
96 if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) {
97 $timezone = $info->{extra}{timezone};
100 my $undef_if_invalid = $info->{datetime_undef_if_invalid};
103 $do_inflate = 0 if exists $info->{inflate_datetime} and $info->{inflate_datetime} == 0;
104 $do_inflate = 0 if exists $info->{inflate_date} and $info->{inflate_date} == 0;
106 if ($do_inflate and ($type eq 'datetime' || $type eq 'date')) {
107 my ($parse, $format) = ("parse_${type}", "format_${type}");
108 $self->inflate_column(
112 my ($value, $obj) = @_;
113 my $dt = eval { $obj->_datetime_parser->$parse($value); };
114 die "Error while inflating ${value} for ${column} on ${self}: $@"
115 if $@ and not $undef_if_invalid;
116 $dt->set_time_zone($timezone) if $timezone;
120 my ($value, $obj) = @_;
121 $value->set_time_zone($timezone) if $timezone;
122 $obj->_datetime_parser->$format($value);
129 sub _datetime_parser {
131 if (my $parser = $self->__datetime_parser) {
134 my $parser = $self->result_source->storage->datetime_parser(@_);
135 return $self->__datetime_parser($parser);
145 =item More information about the add_columns method, and column metadata,
146 can be found in the documentation for L<DBIx::Class::ResultSource>.
152 Matt S. Trout <mst@shadowcatsystems.co.uk>
156 Aran Deltac <bluefeet@cpan.org>
160 You may distribute this code under the same terms as Perl itself.