-package DBIx::Class::DateTime::Epoch;\r
-\r
-use strict;\r
-use warnings;\r
-\r
-our $VERSION = '0.01';\r
-\r
-use base qw( DBIx::Class );\r
-\r
-use DateTime;\r
-\r
-=head1 NAME\r
-\r
-DBIx::Class::DateTime::Epoch - Automatic inflation/deflation of epoch-based DateTime objects for DBIx::Class\r
-\r
-=head1 SYNOPSIS\r
-\r
- package foo;\r
- \r
- use base qw( DBIx::Class );\r
- \r
- __PACKAGE__->load_components( qw( DateTime::Epoch Core ) );\r
- __PACKAGE__->add_columns(\r
- name => {\r
- data_type => 'varchar',\r
- size => 10\r
- },\r
- bar => {\r
- data_type => 'bigint',\r
- epoch => 1\r
- },\r
- creation_time => {\r
- data_type => 'bigint',\r
- epoch => 'ctime'\r
- },\r
- modification_time => {\r
- data_type => 'bigint',\r
- epoch => 'mtime'\r
- }\r
- );\r
-\r
-=head1 DESCRIPTION\r
-\r
-This module automatically inflates/deflates DateTime objects\r
-corresponding to applicable columns. Columns may also be\r
-defined to specify their nature, such as columns representing a\r
-creation time (set at time of insertion) or a modification time\r
-(set at time of every update).\r
-\r
-=head1 METHODS\r
-\r
-=head2 register_column\r
-\r
-This method will automatically add inflation and deflation rules\r
-to a column if an epoch value has been set in the column's definition.\r
-If the epoch value is 'ctime' (creation time) or 'mtime'\r
-(modification time), it will be registered as such for later\r
-use by the insert and the update methods.\r
-\r
-=head2 insert\r
-\r
-This method will set the value of all registered creation time\r
-columns to the current time. No changes will be made to a column\r
-whose value has already been set.\r
-\r
-=head2 update\r
-\r
-This method will set the value of all registered modification time\r
-columns to the current time. This will overwrite a column's value,\r
-even if it has been already set.\r
-\r
-=head1 SEE ALSO\r
-\r
-=over 4\r
-\r
-=item * DateTime\r
-\r
-=item * DBIx::Class\r
-\r
-=back\r
-\r
-=head1 AUTHOR\r
-\r
-=over 4\r
-\r
-=item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>\r
-\r
-=back\r
-\r
-=head1 COPYRIGHT AND LICENSE\r
-\r
-Copyright 2006 by Brian Cassidy\r
-\r
-This library is free software; you can redistribute it and/or modify\r
-it under the same terms as Perl itself. \r
-\r
-=cut\r
-\r
-__PACKAGE__->mk_classdata( ctime_columns => [ ] );\r
-__PACKAGE__->mk_classdata( mtime_columns => [ ] );\r
-\r
-sub register_column {\r
- my( $class, $col, $info ) = @_;\r
- $class->next::method( $col, $info );\r
- \r
- if( my $type = $info->{ epoch } ) {\r
- $class->ctime_columns( [ @{ $class->ctime_columns }, $col ] ) if $type eq 'ctime';\r
- $class->mtime_columns( [ @{ $class->mtime_columns }, $col ] ) if $type eq 'mtime';\r
- \r
- $class->inflate_column(\r
- $col => {\r
- inflate => sub { DateTime->from_epoch( epoch => shift ) },\r
- deflate => sub { shift->epoch }\r
- }\r
- );\r
- }\r
-}\r
-\r
-sub insert {\r
- my $self = shift;\r
- my $time = time;\r
- \r
- for my $column ( @{ $self->ctime_columns }, @{ $self->mtime_columns } ) {\r
- next if defined $self->get_column( $column );\r
- $self->store_column( $column => $time );\r
- }\r
-\r
- $self->next::method( @_ );\r
-}\r
-\r
-sub update {\r
- my $self = shift;\r
- my $time = time;\r
- \r
- for my $column ( @{ $self->mtime_columns } ) {\r
- $self->set_column( $column => $time );\r
- }\r
- \r
- $self->next::method( @_ );\r
-}\r
-\r
-1;
\ No newline at end of file
+package DBIx::Class::DateTime::Epoch;
+
+use strict;
+use warnings;
+
+our $VERSION = '0.04';
+
+use base qw( DBIx::Class );
+
+use DateTime;
+
+__PACKAGE__->load_components( qw/InflateColumn::DateTime/ );
+
+sub _inflate_to_datetime {
+ my( $self, $value, $info, @rest ) = @_;
+ $self->next::method( $value, $info, @rest )
+ unless $info->{ data_type } =~ m{int} || $info->{ inflate_datetime } eq 'epoch';
+
+ return DateTime->from_epoch( epoch => $value );
+}
+
+sub _deflate_from_datetime {
+ my( $self, $value, $info, @rest ) = @_;
+ $self->next::method( $value, $info, @rest )
+ unless $info->{ data_type } =~ m{int} || $info->{ inflate_datetime } eq 'epoch';
+
+ return $value->epoch;
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+DBIx::Class::DateTime::Epoch - Automatic inflation/deflation of epoch-based columns to/from DateTime objects
+
+=head1 SYNOPSIS
+
+ package MySchema::Foo;
+
+ use base qw( DBIx::Class );
+
+ __PACKAGE__->load_components( qw( DateTime::Epoch TimeStamp Core ) );
+ __PACKAGE__->add_columns(
+ name => {
+ data_type => 'varchar',
+ size => 10,
+ },
+ bar => { # epoch stored as an int
+ data_type => 'bigint',
+ inflate_datetime => 1,
+ },
+ baz => { # epoch stored as a string
+ data_type => 'varchar',
+ size => 50,
+ inflate_datetime => 'epoch',
+ },
+ # working in conjunction with DBIx::Class::TimeStamp
+ creation_time => {
+ data_type => 'bigint',
+ inflate_datetime => 1,
+ set_on_create => 1,
+ },
+ modification_time => {
+ data_type => 'bigint',
+ inflate_datetime => 1,
+ set_on_create => 1,
+ set_on_update => 1,
+ }
+ );
+
+=head1 DESCRIPTION
+
+This module automatically inflates/deflates DateTime objects from/to epoch
+values for the specified columns. This module is essentially an extension to
+L<DBIx::Class::InflateColumn::DateTime> so all of the settings, including
+C<locale> and C<timezone>, are also valid.
+
+A column will be recognized as an epoch time given one of the following scenarios:
+
+=over 4
+
+=item * C<data_type> is an C<int> of some sort and C<inflate_datetime> is also set to a true value
+
+=item * C<data_type> is some other value (e.g. C<varchar>) and C<inflate_datetime> is explicitly set to C<epoch>.
+
+=back
+
+L<DBIx::Class::TimeStamp> can also be used in conjunction with this module to support
+epoch-based columns that are automatically set on creation of a row and updated subsequent
+modifications.
+
+=head1 METHODS
+
+=head2 _inflate_to_datetime( )
+
+Overrides column inflation to use C<Datetime-E<gt>from_epoch>.
+
+=head2 _deflate_from_datetime( )
+
+Overrides column deflation to call C<epoch()> on the column value.
+
+=head1 SEE ALSO
+
+=over 4
+
+=item * DBIx::Class
+
+=item * DBIx::Class::TimeStamp
+
+=item * DateTime
+
+=back
+
+=head1 AUTHORS
+
+Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+
+Adam Paynter E<lt>adapay@cpan.orgE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2006-2009 by Brian Cassidy
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
+
projects / dbsrgits/DBIx-Class-DateTime-Epoch.git / blobdiff