more dob updates

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

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index ab135e0..eb2540d 100644 (file)
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -4,7 +4,7 @@ use strict;
 use warnings;
 use Tie::IxHash;
 
-use base qw/Class::Data::Inheritable/;
+use base qw/DBIx::Class::Row/;
 
 __PACKAGE__->mk_classdata('_primaries' => {});
 
@@ -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,22 +33,28 @@ 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
 
 sub set_primary_key {
   my ($class, @cols) = @_;
+  # check if primary key columns are valid columns
+  for (@cols) {
+    $class->throw( "Column $_ can't be used as primary key because it isn't defined in $class" )
+      unless $class->has_column($_);
+  }
   my %pri;
   tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
   $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
 
@@ -81,9 +85,10 @@ sub find {
   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
 
@@ -101,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
@@ -115,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
 
@@ -125,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;
@@ -148,8 +162,6 @@ sub ident_condition {
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>