Merge 'trunk' into 'DBIx-Class-C3'

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

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index 859eba3..ab135e0 100644 (file)
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -35,6 +35,12 @@ sub _ident_values {
   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;
@@ -42,6 +48,12 @@ sub set_primary_key {
   $class->_primaries(\%pri);
 }
 
+=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) : {});
@@ -69,6 +81,12 @@ sub find {
   return (@row ? $class->_row_to_object(\@cols, \@row) : ());
 }
 
+=item discard_changes
+
+Roll back changes that hasn't been comitted to the database.
+
+=cut
+
 sub discard_changes {
   my ($self) = @_;
   delete $self->{_dirty_columns};
@@ -80,11 +98,16 @@ sub discard_changes {
   }
   delete @{$self}{keys %$self};
   @{$self}{keys %$reload} = values %$reload;
-  #$self->store_column($_ => $reload->get_column($_))
-  #  foreach keys %{$self->_columns};
   return $self;
 }
 
+=item id
+
+returns the primary key(s) for the current 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;
@@ -92,6 +115,12 @@ sub id {
   return (wantarray ? @pk : $pk[0]);
 }
 
+=item  primary_columns
+
+read-only accessor which returns a list of primary keys.
+
+=cut
+
 sub primary_columns {
   return keys %{shift->_primaries};
 }
@@ -105,10 +134,18 @@ sub ID {
 
 sub _create_ID {
   my ($class,%vals) = @_;
+  return undef unless 0 == grep { !defined } values %vals;
   $class = ref $class || $class;
   return join '|', $class, map { $_ . '=' . $vals{$_} } sort keys %vals;    
 }
 
+sub ident_condition {
+  my ($self) = @_;
+  my %cond;
+  $cond{$_} = $self->get_column($_) for $self->primary_columns;
+  return \%cond;
+}
+
 1;
 
 =back