Changed ->discard_changes to use ->primary_columns

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / PK.pm

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index b532a33..f156b59 100644 (file)
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -16,13 +16,11 @@ 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 {
@@ -35,9 +33,10 @@ sub _ident_values {
   return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
 }
 
-=item set_primary_key <@cols>
+=head2 set_primary_key(@cols)
 
-define one or more columns as primary key for this class
+Defines one or more columns as primary key for this class. Should be
+called after C<columns>.
 
 =cut
 
@@ -53,9 +52,9 @@ sub set_primary_key {
   $class->_primaries(\%pri);
 }
 
-=item find
+=head2 find(@colvalues), find(\%cols)
 
-Finds columns based on the primary key(s).
+Finds a row based on its primary key(s).
 
 =cut
 
@@ -80,15 +79,16 @@ sub find {
   $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) : ());
+  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) : ());
 }
 
-=item discard_changes
+=head2 discard_changes
 
-Roll back changes that hasn't been comitted to the database.
+Re-selects the row from the database, losing any changes that had
+been made.
 
 =cut
 
@@ -96,7 +96,7 @@ 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);
+  my ($reload) = $self->find(map { $self->$_ } $self->primary_columns);
   unless ($reload) { # If we got deleted in the mean-time
     $self->in_storage(0);
     return $self;
@@ -106,9 +106,9 @@ sub discard_changes {
   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
@@ -120,9 +120,10 @@ sub id {
   return (wantarray ? @pk : $pk[0]);
 }
 
-=item  primary_columns
+=head2 primary_columns
 
-read-only accessor which returns a list of primary keys.
+Read-only accessor which returns the list of primary keys for a class
+(in scalar context, only returns the first primary key).
 
 =cut
 
@@ -130,6 +131,14 @@ sub primary_columns {
   return keys %{shift->_primaries};
 }
 
+=head2 ID
+
+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 ID {
   my ($self) = @_;
   $self->throw( "Can't call ID() as a class method" ) unless ref $self;
@@ -153,8 +162,6 @@ sub ident_condition {
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>