X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDateTime%2FEpoch.pm;h=ec857f81a7d9ef4ac7e3f56bc5dceffffd041cdb;hb=b7f6b6adc44f4bee02eeb295eea5632d39c391f6;hp=395fe9400f391ec3ddc447fe6037ca0da99e4ced;hpb=e4480da23e270a6f93b8fe3f9f66fdd565d14467;p=dbsrgits%2FDBIx-Class-DateTime-Epoch.git

diff --git a/lib/DBIx/Class/DateTime/Epoch.pm b/lib/DBIx/Class/DateTime/Epoch.pm
index 395fe94..ec857f8 100644
--- a/lib/DBIx/Class/DateTime/Epoch.pm
+++ b/lib/DBIx/Class/DateTime/Epoch.pm
@@ -3,144 +3,157 @@ package DBIx::Class::DateTime::Epoch;
 use strict;
 use warnings;
 
-our $VERSION = '0.03';
+our $VERSION = '0.07';
 
 use base qw( DBIx::Class );
 
 use DateTime;
 
+__PACKAGE__->load_components( qw( InflateColumn::DateTime ) );
+
+# back compat
+sub add_columns {
+    my( $class, @cols ) = @_;
+    my @columns;
+
+    while (my $col = shift @cols) {
+        my $info = ref $cols[0] ? shift @cols : {};
+
+        if( my $type = delete $info->{ epoch } ) {
+            $info->{ inflate_datetime } = 'epoch';
+
+            if( $type =~ m{^[cm]time$} ) {
+                __PACKAGE__->load_components( 'TimeStamp' );
+                $info->{ set_on_create } = 1;
+                $info->{ set_on_update } = 1 if $type eq 'mtime';
+            }
+        }
+
+        push @columns, $col => $info;
+
+    }
+
+    $class->next::method( @columns );
+}
+
+sub _inflate_to_datetime {
+    my( $self, $value, $info, @rest ) = @_;
+    return $self->next::method( $value, $info, @rest )
+        unless $info->{ data_type } =~ m{int}i || $info->{ inflate_datetime } eq 'epoch';
+
+    return DateTime->from_epoch( epoch => $value );
+}
+
+sub _deflate_from_datetime {
+    my( $self, $value, $info, @rest ) = @_;
+    return $self->next::method( $value, $info, @rest )
+        unless $info->{ data_type } =~ m{int}i || $info->{ inflate_datetime } eq 'epoch';
+
+    return $value->epoch;
+}
+
+1;
+
+__END__
+
 =head1 NAME
 
-DBIx::Class::DateTime::Epoch - Automatic inflation/deflation of epoch-based DateTime objects for DBIx::Class
+DBIx::Class::DateTime::Epoch - Automatic inflation/deflation of epoch-based columns to/from DateTime objects
 
 =head1 SYNOPSIS
 
-    package foo;
+    package MySchema::Foo;
     
     use base qw( DBIx::Class );
     
-    __PACKAGE__->load_components( qw( DateTime::Epoch Core ) );
+    __PACKAGE__->load_components( qw( DateTime::Epoch TimeStamp Core ) );
     __PACKAGE__->add_columns(
         name => {
             data_type => 'varchar',
-            size      => 10
+            size      => 10,
+        },
+        bar => { # epoch stored as an int
+            data_type        => 'bigint',
+            inflate_datetime => 1,
         },
-        bar => {
-            data_type => 'bigint',
-            epoch     => 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',
-            epoch     => 'ctime'
+            data_type        => 'bigint',
+            inflate_datetime => 1,
+            set_on_create    => 1,
         },
         modification_time => {
-            data_type => 'bigint',
-            epoch     => 'mtime'
+            data_type        => 'bigint',
+            inflate_datetime => 1,
+            set_on_create    => 1,
+            set_on_update    => 1,
         }
     );
 
 =head1 DESCRIPTION
 
-This module automatically inflates/deflates DateTime objects
-corresponding to applicable columns. Columns may also be
-defined to specify their nature, such as columns representing a
-creation time (set at time of insertion) or a modification time
-(set at time of every update).
+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.
 
-=head1 METHODS
+A column will be recognized as an epoch time given one of the following scenarios:
 
-=head2 register_column
+=over 4
+
+=item * C<data_type> is an C<int> of some sort and C<inflate_datetime> is also set to a true value
 
-This method will automatically add inflation and deflation rules
-to a column if an epoch value has been set in the column's definition.
-If the epoch value is 'ctime' (creation time) or 'mtime'
-(modification time), it will be registered as such for later
-use by the insert and the update methods.
+=item * C<data_type> is some other value (e.g. C<varchar>) and C<inflate_datetime> is explicitly set to C<epoch>.
 
-=head2 insert
+=back
 
-This method will set the value of all registered creation time
-columns to the current time. No changes will be made to a column
-whose value has already been set.
+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.
 
-=head2 update
+=head1 METHODS
 
-This method will set the value of all registered modification time
-columns to the current time. This will overwrite a column's value,
-even if it has been already set.
+=head2 add_columns( )
 
-=head1 SEE ALSO
+Provides backwards compatibility with the older DateTime::Epoch API.
 
-=over 4
+=head2 _inflate_to_datetime( )
 
-=item * DateTime
+Overrides column inflation to use C<Datetime-E<gt>from_epoch>.
 
-=item * DBIx::Class
+=head2 _deflate_from_datetime( )
 
-=back
+Overrides column deflation to call C<epoch()> on the column value.
 
-=head1 AUTHOR
+=head1 SEE ALSO
 
 =over 4
 
-=item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+=item * L<DBIx::Class>
+
+=item * L<DBIx::Class::TimeStamp>
 
-=item * Adam Paynter E<lt>adapay@cpan.orgE<gt>
+=item * L<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 by Brian Cassidy
+Copyright 2006-2011 by Brian Cassidy
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself. 
 
 =cut
 
-__PACKAGE__->mk_classdata( ctime_columns => [ ] );
-__PACKAGE__->mk_classdata( mtime_columns => [ ] );
-
-sub register_column {
-    my( $class, $col, $info ) = @_;
-    $class->next::method( $col, $info );
-    
-    if( my $type = $info->{ epoch } ) {
-        $class->ctime_columns( [ @{ $class->ctime_columns }, $col ] ) if $type eq 'ctime';
-        $class->mtime_columns( [ @{ $class->mtime_columns }, $col ] ) if $type eq 'mtime';
-        
-        $class->inflate_column(
-            $col => {
-                inflate => sub { DateTime->from_epoch( epoch => shift ) },
-                deflate => sub { shift->epoch }
-            }
-        );
-    }
-}
-
-sub insert {
-    my $self = shift;
-    my $time = time;
-    
-    for my $column ( @{ $self->ctime_columns }, @{ $self->mtime_columns } ) {
-        next if defined $self->get_column( $column );
-        $self->store_column( $column => $time );
-    }
-
-    $self->next::method( @_ );
-}
-
-sub update {
-    my $self  = shift;
-    my $time  = time;
-    my %dirty = $self->get_dirty_columns;
-
-    for my $column ( @{ $self->mtime_columns } ) {
-        next if exists $dirty{ $column };
-        $self->set_column( $column => $time );
-    }
-    
-    $self->next::method( @_ );
-}
-
-1;