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 NOTE: You B<must> load C<InflateColumn::DateTime> B<before> C<Core>. See
23 L<DBIx::Class::Manual::Component> for details.
25 Then you can treat the specified column as a L<DateTime> object.
27 print "This event starts the month of ".
28 $event->starts_when->month_name();
30 If you want to set a specific timezone and locale for that field, use:
32 __PACKAGE__->add_columns(
33 starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" }
36 If you want to inflate no matter what data_type your column is,
37 use inflate_datetime or inflate_date:
39 __PACKAGE__->add_columns(
40 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
43 __PACKAGE__->add_columns(
44 starts_when => { data_type => 'varchar', inflate_date => 1 }
47 It's also possible to explicitly skip inflation:
49 __PACKAGE__->add_columns(
50 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
55 This module figures out the type of DateTime::Format::* class to
56 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
57 that you are using. If you switch from one database to a different
58 one your code should continue to work without modification (though note
59 that this feature is new as of 0.07, so it may not be perfect yet - bug
60 reports to the list very much welcome).
62 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
66 __PACKAGE__->load_components(qw/InflateColumn/);
68 __PACKAGE__->mk_group_accessors('simple' => '__datetime_parser');
70 =head2 register_column
72 Chains with the L<DBIx::Class::Row/register_column> method, and sets
73 up datetime columns appropriately. This would not normally be
74 directly called by end users.
76 In the case of an invalid date, L<DateTime> will throw an exception. To
77 bypass these exceptions and just have the inflation return undef, use
78 the C<datetime_undef_if_invalid> option in the column info:
82 data_type => "datetime",
83 default_value => '0000-00-00',
85 datetime_undef_if_invalid => 1
91 my ($self, $column, $info, @rest) = @_;
92 $self->next::method($column, $info, @rest);
93 return unless defined($info->{data_type});
97 for (qw/date datetime timestamp/) {
98 my $key = "inflate_${_}";
100 next unless exists $info->{$key};
101 return unless $info->{$key};
108 $type = lc($info->{data_type});
112 if ( defined $info->{extra}{timezone} ) {
113 warn "Putting timezone into extra => { timezone => '...' } has been deprecated, ".
114 "please put it directly into the columns definition.";
115 $timezone = $info->{extra}{timezone};
119 if ( defined $info->{extra}{locale} ) {
120 warn "Putting locale into extra => { locale => '...' } has been deprecated, ".
121 "please put it directly into the columns definition.";
122 $locale = $info->{extra}{locale};
125 $locale = $info->{locale} if defined $info->{locale};
126 $timezone = $info->{timezone} if defined $info->{timezone};
128 my $undef_if_invalid = $info->{datetime_undef_if_invalid};
130 if ($type eq 'datetime' || $type eq 'date' || $type eq 'timestamp') {
131 # This shallow copy of %info avoids t/52_cycle.t treating
132 # the resulting deflator as a circular reference.
133 my %info = ( '_ic_dt_method' => $type , %{ $info } );
136 if (defined $info->{extra}{floating_tz_ok}) {
137 warn "Putting floating_tz_ok into extra => { floating_tz_ok => 1 } has been deprecated, ".
138 "please put it directly into the columns definition.";
139 $floating_tz_ok = $info->{extra}{floating_tz_ok};
141 $info{floating_tz_ok} = $floating_tz_ok unless defined $info{floating_tz_ok};
143 $self->inflate_column(
147 my ($value, $obj) = @_;
148 my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) };
149 die "Error while inflating ${value} for ${column} on ${self}: $@"
150 if $@ and not $undef_if_invalid;
151 $dt->set_time_zone($timezone) if $timezone;
152 $dt->set_locale($locale) if $locale;
156 my ($value, $obj) = @_;
158 warn "You're using a floating timezone, please see the documentation of"
159 . " DBIx::Class::InflateColumn::DateTime for an explanation"
160 if ref( $value->time_zone ) eq 'DateTime::TimeZone::Floating'
161 and not $info{floating_tz_ok}
162 and not $ENV{DBIC_FLOATING_TZ_OK};
163 $value->set_time_zone($timezone);
164 $value->set_locale($locale) if $locale;
166 $obj->_deflate_from_datetime( $value, \%info );
173 sub _flate_or_fallback
175 my( $self, $value, $info, $method_fmt ) = @_;
177 my $parser = $self->_datetime_parser;
178 my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method });
179 my $method = $parser->can($preferred_method) ? $preferred_method : sprintf($method_fmt, 'datetime');
180 return $parser->$method($value);
183 sub _inflate_to_datetime {
184 my( $self, $value, $info ) = @_;
185 return $self->_flate_or_fallback( $value, $info, 'parse_%s' );
188 sub _deflate_from_datetime {
189 my( $self, $value, $info ) = @_;
190 return $self->_flate_or_fallback( $value, $info, 'format_%s' );
193 sub _datetime_parser {
195 if (my $parser = $self->__datetime_parser) {
198 my $parser = $self->result_source->storage->datetime_parser(@_);
199 return $self->__datetime_parser($parser);
207 If you have a datetime column with the C<timezone> extra setting, and subsenquently
208 create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating>
209 timezone, you will get a warning (as there is a very good chance this will not have the
210 result you expect). For example:
212 __PACKAGE__->add_columns(
213 starts_when => { data_type => 'datetime', timezone => "America/Chicago" }
216 my $event = $schema->resultset('EventTZ')->create({
217 starts_at => DateTime->new(year=>2007, month=>12, day=>31, ),
220 The warning can be avoided in several ways:
224 =item Fix your broken code
226 When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply
227 set to the requested value, and B<no time conversion takes place>. It is always a good idea
228 to be supply explicit times to the database:
230 my $event = $schema->resultset('EventTZ')->create({
231 starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ),
234 =item Suppress the check on per-column basis
236 __PACKAGE__->add_columns(
237 starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 }
240 =item Suppress the check globally
242 Set the environment variable DBIC_FLOATING_TZ_OK to some true value.
246 Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been
247 B<DEPRECATED> because this gets you into trouble using L<DBIx::Class::Schema::Versioned>.
248 Instead put it directly into the columns definition like in the examples above. If you still
249 use the old way you'll see a warning - please fix your code then!
255 =item More information about the add_columns method, and column metadata,
256 can be found in the documentation for L<DBIx::Class::ResultSource>.
258 =item Further discussion of problems inherent to the Floating timezone:
259 L<Floating DateTimes|DateTime/Floating_DateTimes>
260 and L<< $dt->set_time_zone|DateTime/"Set" Methods >>
266 Matt S. Trout <mst@shadowcatsystems.co.uk>
270 Aran Deltac <bluefeet@cpan.org>
274 You may distribute this code under the same terms as Perl itself.