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" } }
35 This module figures out the type of DateTime::Format::* class to
36 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
37 that you are using. If you switch from one database to a different
38 one your code should continue to work without modification (though note
39 that this feature is new as of 0.07, so it may not be perfect yet - bug
40 reports to the list very much welcome).
42 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
46 __PACKAGE__->load_components(qw/InflateColumn/);
48 __PACKAGE__->mk_group_accessors('simple' => '__datetime_parser');
50 =head2 register_column
52 Chains with the L<DBIx::Class::Row/register_column> method, and sets
53 up datetime columns appropriately. This would not normally be
54 directly called by end users.
56 In the case of an invalid date, L<DateTime> will throw an exception. To
57 bypass these exceptions and just have the inflation return undef, use
58 the C<datetime_undef_if_invalid> option in the column info:
62 data_type => "datetime",
63 default_value => '0000-00-00',
65 datetime_undef_if_invalid => 1
71 my ($self, $column, $info, @rest) = @_;
72 $self->next::method($column, $info, @rest);
73 return unless defined($info->{data_type});
74 my $type = lc($info->{data_type});
75 $type = 'datetime' if ($type =~ /^timestamp/);
77 if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) {
78 $timezone = $info->{extra}{timezone};
81 my $undef_if_invalid = $info->{datetime_undef_if_invalid};
83 if ($type eq 'datetime' || $type eq 'date') {
84 my ($parse, $format) = ("parse_${type}", "format_${type}");
85 $self->inflate_column(
89 my ($value, $obj) = @_;
90 my $dt = eval { $obj->_datetime_parser->$parse($value); };
91 die "Error while inflating ${value} for ${column} on ${self}: $@"
92 if $@ and not $undef_if_invalid;
93 $dt->set_time_zone($timezone) if $timezone;
97 my ($value, $obj) = @_;
98 $value->set_time_zone($timezone) if $timezone;
99 $obj->_datetime_parser->$format($value);
106 sub _datetime_parser {
108 if (my $parser = $self->__datetime_parser) {
111 my $parser = $self->result_source->storage->datetime_parser(@_);
112 return $self->__datetime_parser($parser);
122 =item More information about the add_columns method, and column metadata,
123 can be found in the documentation for L<DBIx::Class::ResultSource>.
129 Matt S. Trout <mst@shadowcatsystems.co.uk>
133 Aran Deltac <bluefeet@cpan.org>
137 You may distribute this code under the same terms as Perl itself.