=for comment POD_DERIVED_INDEX_GENERATED The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with DBIx::Class::InflateColumn::DateTime at lib/DBIx/Class/InflateColumn/DateTime.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line. =cut =head1 NAME DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns. =head1 SYNOPSIS Load this component and then declare one or more columns to be of the datetime, timestamp or date datatype. package Event; use base 'DBIx::Class::Core'; __PACKAGE__->load_components(qw/InflateColumn::DateTime/); __PACKAGE__->add_columns( starts_when => { data_type => 'datetime' } create_date => { data_type => 'date' } ); Then you can treat the specified column as a L<DateTime> object. print "This event starts the month of ". $event->starts_when->month_name(); If you want to set a specific timezone and locale for that field, use: __PACKAGE__->add_columns( starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" } ); If you want to inflate no matter what data_type your column is, use inflate_datetime or inflate_date: __PACKAGE__->add_columns( starts_when => { data_type => 'varchar', inflate_datetime => 1 } ); __PACKAGE__->add_columns( starts_when => { data_type => 'varchar', inflate_date => 1 } ); It's also possible to explicitly skip inflation: __PACKAGE__->add_columns( starts_when => { data_type => 'datetime', inflate_datetime => 0 } ); NOTE: Don't rely on C<InflateColumn::DateTime> to parse date strings for you. The column is set directly for any non-references and C<InflateColumn::DateTime> is completely bypassed. Instead, use an input parser to create a DateTime object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can use C<DateTime::Format::ISO8601> thusly: use DateTime::Format::ISO8601; my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD'); =head1 DESCRIPTION This module figures out the type of DateTime::Format::* class to inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* that you are using. If you switch from one database to a different one your code should continue to work without modification (though note that this feature is new as of 0.07, so it may not be perfect yet - bug reports to the list very much welcome). If the data_type of a field is C<date>, C<datetime> or C<timestamp> (or a derivative of these datatypes, e.g. C<timestamp with timezone>), this module will automatically call the appropriate parse/format method for deflation/inflation as defined in the storage class. For instance, for a C<datetime> field the methods C<parse_datetime> and C<format_datetime> would be called on deflation/inflation. If the storage class does not provide a specialized inflator/deflator, C<[parse|format]_datetime> will be used as a fallback. See L<DateTime::Format> for more information on date formatting. For more help with using components, see L<DBIx::Class::Manual::Component/USING>. =head2 register_column Chains with the L<DBIx::Class::Row/register_column> method, and sets up datetime columns appropriately. This would not normally be directly called by end users. In the case of an invalid date, L<DateTime> will throw an exception. To bypass these exceptions and just have the inflation return undef, use the C<datetime_undef_if_invalid> option in the column info: "broken_date", { data_type => "datetime", default_value => '0000-00-00', is_nullable => 1, datetime_undef_if_invalid => 1 } =head1 USAGE NOTES If you have a datetime column with an associated C<timezone>, and subsequently create/update this column with a DateTime object in the L<DateTime::TimeZone::Floating> timezone, you will get a warning (as there is a very good chance this will not have the result you expect). For example: __PACKAGE__->add_columns( starts_when => { data_type => 'datetime', timezone => "America/Chicago" } ); my $event = $schema->resultset('EventTZ')->create({ starts_at => DateTime->new(year=>2007, month=>12, day=>31, ), }); The warning can be avoided in several ways: =over 4 =item Fix your broken code When calling C<set_time_zone> on a Floating DateTime object, the timezone is simply set to the requested value, and B<no time conversion takes place>. It is always a good idea to be supply explicit times to the database: my $event = $schema->resultset('EventTZ')->create({ starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ), }); =item Suppress the check on per-column basis __PACKAGE__->add_columns( starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 } ); =item Suppress the check globally Set the environment variable DBIC_FLOATING_TZ_OK to some true value. =back Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been B<DEPRECATED> because this gets you into trouble using L<DBIx::Class::Schema::Versioned>. Instead put it directly into the columns definition like in the examples above. If you still use the old way you'll see a warning - please fix your code then! =head1 SEE ALSO =over 4 =item More information about the add_columns method, and column metadata, can be found in the documentation for L<DBIx::Class::ResultSource>. =item Further discussion of problems inherent to the Floating timezone: L<Floating DateTimes|DateTime/Floating DateTimes> and L<< $dt->set_time_zone|DateTime/"Set" Methods >> =back =head1 AUTHOR Matt S. Trout <mst@shadowcatsystems.co.uk> =head1 INHERITED METHODS =over 4 =item L<DBIx::Class::InflateColumn> L<get_inflated_column|DBIx::Class::InflateColumn/get_inflated_column>, L<inflate_column|DBIx::Class::InflateColumn/inflate_column>, L<set_inflated_column|DBIx::Class::InflateColumn/set_inflated_column>, L<store_inflated_column|DBIx::Class::InflateColumn/store_inflated_column> =item L<DBIx::Class::Row> L<copy|DBIx::Class::Row/copy>, L<delete|DBIx::Class::Row/delete>, L<discard_changes|DBIx::Class::Row/discard_changes>, L<get_column|DBIx::Class::Row/get_column>, L<get_columns|DBIx::Class::Row/get_columns>, L<get_dirty_columns|DBIx::Class::Row/get_dirty_columns>, L<get_from_storage|DBIx::Class::Row/get_from_storage>, L<get_inflated_columns|DBIx::Class::Row/get_inflated_columns>, L<has_column_loaded|DBIx::Class::Row/has_column_loaded>, L<in_storage|DBIx::Class::Row/in_storage>, L<inflate_result|DBIx::Class::Row/inflate_result>, L<insert|DBIx::Class::Row/insert>, L<insert_or_update|DBIx::Class::Row/insert_or_update>, L<is_changed|DBIx::Class::Row/is_changed>, L<is_column_changed|DBIx::Class::Row/is_column_changed>, L<make_column_dirty|DBIx::Class::Row/make_column_dirty>, L<new|DBIx::Class::Row/new>, L<result_source|DBIx::Class::Row/result_source>, L<set_column|DBIx::Class::Row/set_column>, L<set_columns|DBIx::Class::Row/set_columns>, L<set_inflated_columns|DBIx::Class::Row/set_inflated_columns>, L<store_column|DBIx::Class::Row/store_column>, L<throw_exception|DBIx::Class::Row/throw_exception>, L<update|DBIx::Class::Row/update>, L<update_or_insert|DBIx::Class::Row/update_or_insert> =back =head1 CONTRIBUTORS Aran Deltac <bluefeet@cpan.org> =head1 LICENSE You may distribute this code under the same terms as Perl itself.