1 package DBIx::Class::InflateColumn::DateTime;
5 use base qw/DBIx::Class/;
6 use Carp::Clan qw/^DBIx::Class/;
10 DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
14 Load this component and then declare one or more
15 columns to be of the datetime, timestamp or date datatype.
18 __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/);
19 __PACKAGE__->add_columns(
20 starts_when => { data_type => 'datetime' }
21 create_date => { data_type => 'date' }
24 NOTE: You B<must> load C<InflateColumn::DateTime> B<before> C<Core>. See
25 L<DBIx::Class::Manual::Component> for details.
27 Then you can treat the specified column as a L<DateTime> object.
29 print "This event starts the month of ".
30 $event->starts_when->month_name();
32 If you want to set a specific timezone and locale for that field, use:
34 __PACKAGE__->add_columns(
35 starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" }
38 If you want to inflate no matter what data_type your column is,
39 use inflate_datetime or inflate_date:
41 __PACKAGE__->add_columns(
42 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
45 __PACKAGE__->add_columns(
46 starts_when => { data_type => 'varchar', inflate_date => 1 }
49 It's also possible to explicitly skip inflation:
51 __PACKAGE__->add_columns(
52 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
55 NOTE: Don't rely on C<InflateColumn::DateTime> to parse date strings for you.
56 The column is set directly for any non-references and C<InflateColumn::DateTime>
57 is completely bypassed. Instead, use an input parser to create a DateTime
58 object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can
59 use C<DateTime::Format::ISO8601> thusly:
61 use DateTime::Format::ISO8601;
62 my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD');
66 This module figures out the type of DateTime::Format::* class to
67 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
68 that you are using. If you switch from one database to a different
69 one your code should continue to work without modification (though note
70 that this feature is new as of 0.07, so it may not be perfect yet - bug
71 reports to the list very much welcome).
73 If the data_type of a field is C<date>, C<datetime> or C<timestamp> (or
74 a derivative of these datatypes, e.g. C<timestamp with timezone>), this
75 module will automatically call the appropriate parse/format method for
76 deflation/inflation as defined in the storage class. For instance, for
77 a C<datetime> field the methods C<parse_datetime> and C<format_datetime>
78 would be called on deflation/inflation. If the storage class does not
79 provide a specialized inflator/deflator, C<[parse|format]_datetime> will
80 be used as a fallback. See L<DateTime::Format> for more information on
83 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
87 __PACKAGE__->load_components(qw/InflateColumn/);
89 =head2 register_column
91 Chains with the L<DBIx::Class::Row/register_column> method, and sets
92 up datetime columns appropriately. This would not normally be
93 directly called by end users.
95 In the case of an invalid date, L<DateTime> will throw an exception. To
96 bypass these exceptions and just have the inflation return undef, use
97 the C<datetime_undef_if_invalid> option in the column info:
101 data_type => "datetime",
102 default_value => '0000-00-00',
104 datetime_undef_if_invalid => 1
109 sub register_column {
110 my ($self, $column, $info, @rest) = @_;
111 $self->next::method($column, $info, @rest);
112 return unless defined($info->{data_type});
116 for (qw/date datetime timestamp/) {
117 my $key = "inflate_${_}";
119 next unless exists $info->{$key};
120 return unless $info->{$key};
127 $type = lc($info->{data_type});
128 if ($type eq "timestamp with time zone" || $type eq "timestamptz") {
130 $info->{_ic_dt_method} ||= "timestamp_with_timezone";
131 } elsif ($type eq "timestamp without time zone") {
133 $info->{_ic_dt_method} ||= "timestamp_without_timezone";
134 } elsif ($type eq "smalldatetime") {
136 $info->{_ic_dt_method} ||= "datetime";
141 if ( defined $info->{extra}{timezone} ) {
142 carp "Putting timezone into extra => { timezone => '...' } has been deprecated, ".
143 "please put it directly into the '$column' column definition.";
144 $timezone = $info->{extra}{timezone};
148 if ( defined $info->{extra}{locale} ) {
149 carp "Putting locale into extra => { locale => '...' } has been deprecated, ".
150 "please put it directly into the '$column' column definition.";
151 $locale = $info->{extra}{locale};
154 $locale = $info->{locale} if defined $info->{locale};
155 $timezone = $info->{timezone} if defined $info->{timezone};
157 my $undef_if_invalid = $info->{datetime_undef_if_invalid};
159 if ($type eq 'datetime' || $type eq 'date' || $type eq 'timestamp') {
160 # This shallow copy of %info avoids t/52_cycle.t treating
161 # the resulting deflator as a circular reference.
162 my %info = ( '_ic_dt_method' => $type , %{ $info } );
164 if (defined $info->{extra}{floating_tz_ok}) {
165 carp "Putting floating_tz_ok into extra => { floating_tz_ok => 1 } has been deprecated, ".
166 "please put it directly into the '$column' column definition.";
167 $info{floating_tz_ok} = $info->{extra}{floating_tz_ok};
170 $self->inflate_column(
174 my ($value, $obj) = @_;
176 my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) };
178 return undef if ($undef_if_invalid);
179 $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $err");
182 $dt->set_time_zone($timezone) if $timezone;
183 $dt->set_locale($locale) if $locale;
187 my ($value, $obj) = @_;
189 carp "You're using a floating timezone, please see the documentation of"
190 . " DBIx::Class::InflateColumn::DateTime for an explanation"
191 if ref( $value->time_zone ) eq 'DateTime::TimeZone::Floating'
192 and not $info{floating_tz_ok}
193 and not $ENV{DBIC_FLOATING_TZ_OK};
194 $value->set_time_zone($timezone);
195 $value->set_locale($locale) if $locale;
197 $obj->_deflate_from_datetime( $value, \%info );
204 sub _flate_or_fallback
206 my( $self, $value, $info, $method_fmt ) = @_;
208 my $parser = $self->_datetime_parser;
209 my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method });
210 my $method = $parser->can($preferred_method) ? $preferred_method : sprintf($method_fmt, 'datetime');
211 return $parser->$method($value);
214 sub _inflate_to_datetime {
215 my( $self, $value, $info ) = @_;
216 return $self->_flate_or_fallback( $value, $info, 'parse_%s' );
219 sub _deflate_from_datetime {
220 my( $self, $value, $info ) = @_;
221 return $self->_flate_or_fallback( $value, $info, 'format_%s' );
224 sub _datetime_parser {
225 shift->result_source->storage->datetime_parser (@_);
233 If you have a datetime column with an associated C<timezone>, and subsequently
234 create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating>
235 timezone, you will get a warning (as there is a very good chance this will not have the
236 result you expect). For example:
238 __PACKAGE__->add_columns(
239 starts_when => { data_type => 'datetime', timezone => "America/Chicago" }
242 my $event = $schema->resultset('EventTZ')->create({
243 starts_at => DateTime->new(year=>2007, month=>12, day=>31, ),
246 The warning can be avoided in several ways:
250 =item Fix your broken code
252 When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply
253 set to the requested value, and B<no time conversion takes place>. It is always a good idea
254 to be supply explicit times to the database:
256 my $event = $schema->resultset('EventTZ')->create({
257 starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ),
260 =item Suppress the check on per-column basis
262 __PACKAGE__->add_columns(
263 starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 }
266 =item Suppress the check globally
268 Set the environment variable DBIC_FLOATING_TZ_OK to some true value.
272 Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been
273 B<DEPRECATED> because this gets you into trouble using L<DBIx::Class::Schema::Versioned>.
274 Instead put it directly into the columns definition like in the examples above. If you still
275 use the old way you'll see a warning - please fix your code then!
281 =item More information about the add_columns method, and column metadata,
282 can be found in the documentation for L<DBIx::Class::ResultSource>.
284 =item Further discussion of problems inherent to the Floating timezone:
285 L<Floating DateTimes|DateTime/Floating_DateTimes>
286 and L<< $dt->set_time_zone|DateTime/"Set" Methods >>
292 Matt S. Trout <mst@shadowcatsystems.co.uk>
296 Aran Deltac <bluefeet@cpan.org>
300 You may distribute this code under the same terms as Perl itself.