removed ->reload_row from storage, changed this to a method based on the actual row...
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / PK.pm
index ab135e0..f664cc6 100644 (file)
@@ -2,13 +2,10 @@ package DBIx::Class::PK;
 
 use strict;
 use warnings;
-use Tie::IxHash;
 
-use base qw/Class::Data::Inheritable/;
+use base qw/DBIx::Class::Row/;
 
-__PACKAGE__->mk_classdata('_primaries' => {});
-
-=head1 NAME 
+=head1 NAME
 
 DBIx::Class::PK - Primary Key class
 
@@ -16,74 +13,25 @@ DBIx::Class::PK - Primary Key class
 
 =head1 DESCRIPTION
 
-This class represents methods handling primary keys
-and depending on them.
+This class contains methods for handling primary keys and methods
+depending on them.
 
 =head1 METHODS
 
-=over 4
-
 =cut
 
-sub _ident_cond {
-  my ($class) = @_;
-  return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
-}
-
 sub _ident_values {
   my ($self) = @_;
-  return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
-}
-
-=item set_primary_key <@cols>
-
-define one or more columns as primary key for this class
-
-=cut
-
-sub set_primary_key {
-  my ($class, @cols) = @_;
-  my %pri;
-  tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
-  $class->_primaries(\%pri);
+  return (map { $self->{_column_data}{$_} } $self->primary_columns);
 }
 
-=item find
-
-Finds columns based on the primary key(s).
-
-=cut
-
-sub find {
-  my ($class, @vals) = @_;
-  my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
-  my @pk = keys %{$class->_primaries};
-  $class->throw( "Can't find unless primary columns are defined" ) 
-    unless @pk;
-  my $query;
-  if (ref $vals[0] eq 'HASH') {
-    $query = $vals[0];
-  } elsif (@pk == @vals) {
-    $query = {};
-    @{$query}{@pk} = @vals;
-    #my $ret = ($class->search_literal($class->_ident_cond, @vals, $attrs))[0];
-    #warn "$class: ".join(', ', %{$ret->{_column_data}});
-    #return $ret;
-  } else {
-    $query = {@vals};
-  }
-  $class->throw( "Can't find unless all primary keys are specified" )
-    unless (keys %$query >= @pk); # If we check 'em we run afoul of uc/lc
-                                  # column names etc. Not sure what to do yet
-  #return $class->search($query)->next;
-  my @cols = $class->_select_columns;
-  my @row = $class->storage->select_single($class->_table_name, \@cols, $query);
-  return (@row ? $class->_row_to_object(\@cols, \@row) : ());
-}
+=head2 discard_changes
 
-=item discard_changes
+Re-selects the row from the database, losing any changes that had
+been made.
 
-Roll back changes that hasn't been comitted to the database.
+This method can also be used to refresh from storage, retrieving any
+changes made since the row was last read from storage.
 
 =cut
 
@@ -91,65 +39,82 @@ sub discard_changes {
   my ($self) = @_;
   delete $self->{_dirty_columns};
   return unless $self->in_storage; # Don't reload if we aren't real!
-  my ($reload) = $self->find($self->id);
-  unless ($reload) { # If we got deleted in the mean-time
+  
+  if( my $current_storage = $self->get_current_storage) {
+       
+    # Set $self to the current.
+       %$self = %$current_storage;
+       
+    # Avoid a possible infinite loop with
+    # sub DESTROY { $_[0]->discard_changes }
+    bless $current_storage, 'Do::Not::Exist';
+    
+    return $self;      
+  } else {
     $self->in_storage(0);
-    return $self;
+    return $self;      
   }
-  delete @{$self}{keys %$self};
-  @{$self}{keys %$reload} = values %$reload;
-  return $self;
 }
 
-=item id
+=head2 id
 
-returns the primary key(s) for the current row. Can't be called as
+Returns the primary key(s) for a row. Can't be called as
 a class method.
 
 =cut
 
 sub id {
   my ($self) = @_;
-  $self->throw( "Can't call id() as a class method" ) unless ref $self;
+  $self->throw_exception( "Can't call id() as a class method" )
+    unless ref $self;
   my @pk = $self->_ident_values;
   return (wantarray ? @pk : $pk[0]);
 }
 
-=item  primary_columns
+=head2 ID
 
-read-only accessor which returns a list of primary keys.
+Returns a unique id string identifying a row object by primary key.
+Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
+L<DBIx::Class::ObjectCache>.
 
 =cut
 
-sub primary_columns {
-  return keys %{shift->_primaries};
-}
-
 sub ID {
   my ($self) = @_;
-  $self->throw( "Can't call ID() as a class method" ) unless ref $self;
+  $self->throw_exception( "Can't call ID() as a class method" )
+    unless ref $self;
   return undef unless $self->in_storage;
-  return $self->_create_ID(map { $_ => $self->{_column_data}{$_} } keys %{$self->_primaries});
+  return $self->_create_ID(map { $_ => $self->{_column_data}{$_} }
+                             $self->primary_columns);
 }
 
 sub _create_ID {
-  my ($class,%vals) = @_;
+  my ($self,%vals) = @_;
   return undef unless 0 == grep { !defined } values %vals;
-  $class = ref $class || $class;
-  return join '|', $class, map { $_ . '=' . $vals{$_} } sort keys %vals;    
+  return join '|', ref $self || $self, $self->result_source->name,
+    map { $_ . '=' . $vals{$_} } sort keys %vals;
 }
 
+=head2 ident_condition
+
+  my $cond = $result_source->ident_condition();
+
+  my $cond = $result_source->ident_condition('alias');
+
+Produces a condition hash to locate a row based on the primary key(s).
+
+=cut
+
 sub ident_condition {
-  my ($self) = @_;
+  my ($self, $alias) = @_;
   my %cond;
-  $cond{$_} = $self->get_column($_) for $self->primary_columns;
+  my $prefix = defined $alias ? $alias.'.' : '';
+  $cond{$prefix.$_} = $self->get_column($_) for $self->primary_columns;
   return \%cond;
 }
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>