Merge the last bits of indirect callchain optimization

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

diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm
index d1dc87c..0ef470b 100644 (file)
--- a/lib/DBIx/Class/PK.pm
+++ b/lib/DBIx/Class/PK.pm
@@ -3,53 +3,155 @@ package DBIx::Class::PK;
 use strict;
 use warnings;
 
-use base qw/Class::Data::Inheritable DBIx::Class::SQL/;
+use base qw/DBIx::Class::Row/;
 
-__PACKAGE__->mk_classdata('_primaries' => {});
+use DBIx::Class::_Util 'fail_on_internal_call';
+use namespace::clean;
 
-sub _ident_cond {
-  my ($class) = @_;
-  return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
+=head1 NAME
+
+DBIx::Class::PK - Primary Key class
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class contains methods for handling primary keys and methods
+depending on them.
+
+=head1 METHODS
+
+=cut
+
+=head2 id
+
+Returns the primary key(s) for a row. Can't be called as
+a class method.
+
+=cut
+
+sub id :DBIC_method_is_indirect_sugar {
+  DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
+
+  $_[0]->throw_exception( "Can't call id() as a class method" )
+    unless ref $_[0];
+
+  wantarray
+    ? $_[0]->_ident_values
+    : ($_[0]->_ident_values)[0]   # FIXME - horrible horrible legacy crap
+  ;
 }
 
 sub _ident_values {
+  my ($self, $use_storage_state) = @_;
+
+  my (@ids, @missing);
+
+  for ($self->result_source->_pri_cols_or_die) {
+    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 ($_) );
+  }
+
+  if (@missing && $self->in_storage) {
+    $self->throw_exception (
+      'Unable to uniquely identify result object with missing PK columns: '
+      . join (', ', @missing )
+    );
+  }
+
+  return @ids;
+}
+
+=head2 ID
+
+Returns a unique id string identifying a result object by primary key.
+Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
+L<DBIx::Class::ObjectCache>.
+
+=over
+
+=item WARNING
+
+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>.
+
+=back
+
+=cut
+
+sub ID {
   my ($self) = @_;
-  return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
+  $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});
 }
 
-sub set_primary_key {
-  my ($class, @cols) = @_;
-  my %pri;
-  $pri{$_} = {} for @cols;
-  $class->_primaries(\%pri);
+sub _create_ID {
+  my ($self, %vals) = @_;
+  return undef if grep { !defined } values %vals;
+  return join '|', ref $self || $self, $self->result_source->name,
+    map { $_ . '=' . $vals{$_} } sort keys %vals;
 }
 
-sub retrieve {
-  my ($class, @vals) = @_;
-  my @pk = keys %{$class->_primaries};
-  die "Can't retrieve unless primary columns are defined" unless @pk;
-  my $query;
-  if (ref $vals[0] eq 'HASH') {
-    $query = $vals[0];
-  } elsif (@pk == @vals) {
-    my $ret = ($class->retrieve_from_sql($class->_ident_cond, @vals))[0];
-    #warn "$class: ".join(', ', %{$ret->{_column_data}});
-    return $ret;
-  } else {
-    $query = {@vals};
-  }
-  die "Can't retrieve 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
-  my $ret = ($class->search($query))[0];
-  #warn "$class: ".join(', ', %{$ret->{_column_data}});
-  return $ret;
+=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 {
+  shift->_mk_ident_cond(@_);
 }
 
-sub discard_changes {
-  my ($self) = @_;
-  delete $self->{_dirty_columns};
-  $_[0] = $self->retrieve($self->id);
+sub _storage_ident_condition {
+  shift->_mk_ident_cond(shift, 1);
 }
 
+sub _mk_ident_cond {
+  my ($self, $alias, $use_storage_state) = @_;
+
+  my @pks = $self->result_source->_pri_cols_or_die;
+  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)
+    );
+  }
+
+  return \%cond;
+}
+
+=head1 FURTHER QUESTIONS?
+
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
+
+=head1 COPYRIGHT AND LICENSE
+
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
+
+=cut
+
 1;