X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK.pm;h=e128e5743532dac3ea73fd7a54fb383aeca2264a;hb=fcf32d045;hp=ddd37b9f0c9bcdd9186d800f391bb1b615dbe570;hpb=1edd17220a3f0fa2768084572d8ca57cfc2a2fcc;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index ddd37b9..e128e57 100644
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -2,13 +2,10 @@ package DBIx::Class::PK;
 
 use strict;
 use warnings;
-use Tie::IxHash;
 
 use base qw/DBIx::Class::Row/;
 
-__PACKAGE__->mk_classdata('_primaries' => {});
-
-=head1 NAME 
+=head1 NAME
 
 DBIx::Class::PK - Primary Key class
 
@@ -16,143 +13,132 @@ 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
+
+=head2 id
+
+Returns the primary key(s) for a row. Can't be called as
+a class method.
 
 =cut
 
-sub _ident_cond {
-  my ($class) = @_;
-  return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
+sub id {
+  my ($self) = @_;
+  $self->throw_exception( "Can't call id() as a class method" )
+    unless ref $self;
+  my @id_vals = $self->_ident_values;
+  return (wantarray ? @id_vals : $id_vals[0]);
 }
 
 sub _ident_values {
-  my ($self) = @_;
-  return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
-}
+  my ($self, $use_storage_state) = @_;
 
-=item set_primary_key <@cols>
+  my (@ids, @missing);
 
-define one or more columns as primary key for this class
+  for ($self->_pri_cols) {
+    push @ids, ($use_storage_state and exists $self->{_column_data_in_storage}{$_})
+      ? $self->{_column_data_in_storage}{$_}
+      : $self->get_column($_)
+    ;
+    push @missing, $_ if (! defined $ids[-1] and ! $self->has_column_loaded ($_) );
+  }
 
-=cut
+  if (@missing && $self->in_storage) {
+    $self->throw_exception (
+      'Unable to uniquely identify result object with missing PK columns: '
+      . join (', ', @missing )
+    );
+  }
 
-sub set_primary_key {
-  my ($class, @cols) = @_;
-  my %pri;
-  tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
-  $class->_primaries(\%pri);
+  return @ids;
 }
 
-=item find
+=head2 ID
 
-Finds columns based on the primary key(s).
+Returns a unique id string identifying a result object by primary key.
+Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
+L<DBIx::Class::ObjectCache>.
 
-=cut
+=over
 
-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) : ());
-}
+=item WARNING
 
-=item discard_changes
+The default C<_create_ID> method used by this function orders the returned
+values by the alphabetical order of the primary column names, B<unlike>
+the L</id> method, which follows the same order in which columns were fed
+to L<DBIx::Class::ResultSource/set_primary_key>.
 
-Roll back changes that hasn't been comitted to the database.
+=back
 
 =cut
 
-sub discard_changes {
+sub ID {
   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
-    $self->in_storage(0);
-    return $self;
-  }
-  delete @{$self}{keys %$self};
-  @{$self}{keys %$reload} = values %$reload;
-  return $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(%{$self->ident_condition});
 }
 
-=item id
-
-returns the primary key(s) for the current row. Can't be called as
-a class method.
+sub _create_ID {
+  my ($self, %vals) = @_;
+  return undef unless 0 == grep { !defined } values %vals;
+  return join '|', ref $self || $self, $self->result_source->name,
+    map { $_ . '=' . $vals{$_} } sort keys %vals;
+}
 
-=cut
+=head2 ident_condition
 
-sub id {
-  my ($self) = @_;
-  $self->throw( "Can't call id() as a class method" ) unless ref $self;
-  my @pk = $self->_ident_values;
-  return (wantarray ? @pk : $pk[0]);
-}
+  my $cond = $result_source->ident_condition();
 
-=item  primary_columns
+  my $cond = $result_source->ident_condition('alias');
 
-read-only accessor which returns a list of primary keys.
+Produces a condition hash to locate a row based on the primary key(s).
 
 =cut
 
-sub primary_columns {
-  return keys %{shift->_primaries};
+sub ident_condition {
+  shift->_mk_ident_cond(@_);
 }
 
-sub ID {
-  my ($self) = @_;
-  $self->throw( "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});
+sub _storage_ident_condition {
+  shift->_mk_ident_cond(shift, 1);
 }
 
-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 _mk_ident_cond {
+  my ($self, $alias, $use_storage_state) = @_;
+
+  my @pks = $self->_pri_cols;
+  my @vals = $self->_ident_values($use_storage_state);
+
+  my (%cond, @undef);
+  my $prefix = defined $alias ? $alias.'.' : '';
+  for my $col (@pks) {
+    if (! defined ($cond{$prefix.$col} = shift @vals) ) {
+      push @undef, $col;
+    }
+  }
+
+  if (@undef && $self->in_storage) {
+    $self->throw_exception (
+      'Unable to construct result object identity condition due to NULL PK columns: '
+      . join (', ', @undef)
+    );
+  }
 
-sub ident_condition {
-  my ($self) = @_;
-  my %cond;
-  $cond{$_} = $self->get_column($_) for $self->primary_columns;
   return \%cond;
 }
 
 1;
 
-=back
-
-=head1 AUTHORS
+=head1 AUTHOR AND CONTRIBUTORS
 
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
 
 =head1 LICENSE