1 package DBIx::Class::InflateColumn::DateTime;
5 use base qw/DBIx::Class/;
6 use Carp::Clan qw/^DBIx::Class/;
12 DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
16 Load this component and then declare one or more
17 columns to be of the datetime, timestamp or date datatype.
20 use base 'DBIx::Class::Core';
22 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
23 __PACKAGE__->add_columns(
24 starts_when => { data_type => 'datetime' }
25 create_date => { data_type => 'date' }
28 Then you can treat the specified column as a L<DateTime> object.
30 print "This event starts the month of ".
31 $event->starts_when->month_name();
33 If you want to set a specific timezone and locale for that field, use:
35 __PACKAGE__->add_columns(
36 starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" }
39 If you want to inflate no matter what data_type your column is,
40 use inflate_datetime or inflate_date:
42 __PACKAGE__->add_columns(
43 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
46 __PACKAGE__->add_columns(
47 starts_when => { data_type => 'varchar', inflate_date => 1 }
50 It's also possible to explicitly skip inflation:
52 __PACKAGE__->add_columns(
53 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
56 NOTE: Don't rely on C<InflateColumn::DateTime> to parse date strings for you.
57 The column is set directly for any non-references and C<InflateColumn::DateTime>
58 is completely bypassed. Instead, use an input parser to create a DateTime
59 object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can
60 use C<DateTime::Format::ISO8601> thusly:
62 use DateTime::Format::ISO8601;
63 my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD');
67 This module figures out the type of DateTime::Format::* class to
68 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
69 that you are using. If you switch from one database to a different
70 one your code should continue to work without modification (though note
71 that this feature is new as of 0.07, so it may not be perfect yet - bug
72 reports to the list very much welcome).
74 If the data_type of a field is C<date>, C<datetime> or C<timestamp> (or
75 a derivative of these datatypes, e.g. C<timestamp with timezone>), this
76 module will automatically call the appropriate parse/format method for
77 deflation/inflation as defined in the storage class. For instance, for
78 a C<datetime> field the methods C<parse_datetime> and C<format_datetime>
79 would be called on deflation/inflation. If the storage class does not
80 provide a specialized inflator/deflator, C<[parse|format]_datetime> will
81 be used as a fallback. See L<DateTime::Format> for more information on
84 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
88 __PACKAGE__->load_components(qw/InflateColumn/);
90 =head2 register_column
92 Chains with the L<DBIx::Class::Row/register_column> method, and sets
93 up datetime columns appropriately. This would not normally be
94 directly called by end users.
96 In the case of an invalid date, L<DateTime> will throw an exception. To
97 bypass these exceptions and just have the inflation return undef, use
98 the C<datetime_undef_if_invalid> option in the column info:
102 data_type => "datetime",
103 default_value => '0000-00-00',
105 datetime_undef_if_invalid => 1
110 sub register_column {
111 my ($self, $column, $info, @rest) = @_;
113 $self->next::method($column, $info, @rest);
115 return unless defined($info->{data_type});
118 for (qw/date datetime timestamp/) {
119 my $key = "inflate_${_}";
121 next unless exists $info->{$key};
123 return if ! $info->{$key};
125 $requested_type = $_;
129 my $data_type = lc($info->{data_type} || '');
131 # _ic_dt_method will follow whatever the registration requests
132 # thus = instead of ||=
133 if ($data_type eq 'timestamp with time zone' || $data_type eq 'timestamptz') {
134 $info->{_ic_dt_method} = 'timestamp_with_timezone';
136 elsif ($data_type eq 'timestamp without time zone') {
137 $info->{_ic_dt_method} = 'timestamp_without_timezone';
139 elsif ($data_type eq 'smalldatetime') {
140 $info->{_ic_dt_method} = 'smalldatetime';
142 elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) {
143 $info->{_ic_dt_method} = $data_type;
146 $info->{_ic_dt_method} = $requested_type;
149 return unless $info->{_ic_dt_method};
151 if ($info->{extra}) {
152 for my $slot (qw/timezone locale floating_tz_ok/) {
153 if ( defined $info->{extra}{$slot} ) {
154 carp "Putting $slot into extra => { $slot => '...' } has been deprecated, ".
155 "please put it directly into the '$column' column definition.";
156 $info->{$slot} = $info->{extra}{$slot} unless defined $info->{$slot};
161 # shallow copy to avoid unfounded(?) Devel::Cycle complaints
162 my $infcopy = {%$info};
164 $self->inflate_column(
168 my ($value, $obj) = @_;
171 { $obj->_inflate_to_datetime( $value, $infcopy ) }
173 $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $_")
174 unless $infcopy->{datetime_undef_if_invalid};
179 ? $obj->_post_inflate_datetime( $dt, $infcopy )
184 my ($value, $obj) = @_;
186 $value = $obj->_pre_deflate_datetime( $value, $infcopy );
187 $obj->_deflate_from_datetime( $value, $infcopy );
193 sub _flate_or_fallback
195 my( $self, $value, $info, $method_fmt ) = @_;
197 my $parser = $self->_datetime_parser;
198 my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method });
199 my $method = $parser->can($preferred_method) ? $preferred_method : sprintf($method_fmt, 'datetime');
200 return $parser->$method($value);
203 sub _inflate_to_datetime {
204 my( $self, $value, $info ) = @_;
205 return $self->_flate_or_fallback( $value, $info, 'parse_%s' );
208 sub _deflate_from_datetime {
209 my( $self, $value, $info ) = @_;
210 return $self->_flate_or_fallback( $value, $info, 'format_%s' );
213 sub _datetime_parser {
214 shift->result_source->storage->datetime_parser (@_);
217 sub _post_inflate_datetime {
218 my( $self, $dt, $info ) = @_;
220 $dt->set_time_zone($info->{timezone}) if defined $info->{timezone};
221 $dt->set_locale($info->{locale}) if defined $info->{locale};
226 sub _pre_deflate_datetime {
227 my( $self, $dt, $info ) = @_;
229 if (defined $info->{timezone}) {
230 carp "You're using a floating timezone, please see the documentation of"
231 . " DBIx::Class::InflateColumn::DateTime for an explanation"
232 if ref( $dt->time_zone ) eq 'DateTime::TimeZone::Floating'
233 and not $info->{floating_tz_ok}
234 and not $ENV{DBIC_FLOATING_TZ_OK};
236 $dt->set_time_zone($info->{timezone});
239 $dt->set_locale($info->{locale}) if defined $info->{locale};
249 If you have a datetime column with an associated C<timezone>, and subsequently
250 create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating>
251 timezone, you will get a warning (as there is a very good chance this will not have the
252 result you expect). For example:
254 __PACKAGE__->add_columns(
255 starts_when => { data_type => 'datetime', timezone => "America/Chicago" }
258 my $event = $schema->resultset('EventTZ')->create({
259 starts_at => DateTime->new(year=>2007, month=>12, day=>31, ),
262 The warning can be avoided in several ways:
266 =item Fix your broken code
268 When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply
269 set to the requested value, and B<no time conversion takes place>. It is always a good idea
270 to be supply explicit times to the database:
272 my $event = $schema->resultset('EventTZ')->create({
273 starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ),
276 =item Suppress the check on per-column basis
278 __PACKAGE__->add_columns(
279 starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 }
282 =item Suppress the check globally
284 Set the environment variable DBIC_FLOATING_TZ_OK to some true value.
288 Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been
289 B<DEPRECATED> because this gets you into trouble using L<DBIx::Class::Schema::Versioned>.
290 Instead put it directly into the columns definition like in the examples above. If you still
291 use the old way you'll see a warning - please fix your code then!
297 =item More information about the add_columns method, and column metadata,
298 can be found in the documentation for L<DBIx::Class::ResultSource>.
300 =item Further discussion of problems inherent to the Floating timezone:
301 L<Floating DateTimes|DateTime/Floating_DateTimes>
302 and L<< $dt->set_time_zone|DateTime/"Set" Methods >>
308 Matt S. Trout <mst@shadowcatsystems.co.uk>
312 Aran Deltac <bluefeet@cpan.org>
316 You may distribute this code under the same terms as Perl itself.