X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK.pm;h=0ef470b336af96abd656b776cb5c391733e4e4b8;hb=dc7d89911b7bb98c30208cf73af522a99998dcd6;hp=32165dc49802ebf55df2a7ed0f0ac8ebf94e813a;hpb=34d52be2d55c86c6eddd2317157db7f2accbe810;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm index 32165dc..0ef470b 100644 --- a/lib/DBIx/Class/PK.pm +++ b/lib/DBIx/Class/PK.pm @@ -3,11 +3,12 @@ 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; -=head1 NAME +=head1 NAME DBIx::Class::PK - Primary Key class @@ -15,88 +16,142 @@ 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 id :DBIC_method_is_indirect_sugar { + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call; -sub _ident_cond { - my ($class) = @_; - return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries}); + $_[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) = @_; - return (map { $self->{_column_data}{$_} } keys %{$self->_primaries}); -} + my ($self, $use_storage_state) = @_; -sub set_primary_key { - my ($class, @cols) = @_; - my %pri; - $pri{$_} = {} for @cols; - $class->_primaries(\%pri); -} + my (@ids, @missing); -sub retrieve { - my ($class, @vals) = @_; - my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@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, $attrs))[0]; - #warn "$class: ".join(', ', %{$ret->{_column_data}}); - return $ret; - } else { - $query = {@vals}; + 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 ($_) ); } - 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; -} -sub discard_changes { - my ($self) = @_; - delete $self->{_dirty_columns}; - return unless $self->in_database; # Don't reload if we aren't real! - my ($reload) = $self->retrieve($self->id); - unless ($reload) { # If we got deleted in the mean-time - $self->in_database(0); - return $self; + if (@missing && $self->in_storage) { + $self->throw_exception ( + 'Unable to uniquely identify result object with missing PK columns: ' + . join (', ', @missing ) + ); } - $self->store_column($_ => $reload->get_column($_)) - foreach keys %{$self->_columns}; - return $self; + + return @ids; } -sub id { +=head2 ID + +Returns a unique id string identifying a result object by primary key. +Used by L and +L. + +=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 +the L method, which follows the same order in which columns were fed +to L. + +=back + +=cut + +sub ID { my ($self) = @_; - die "Can't call id() as a class method" unless ref $self; - my @pk = $self->_ident_values; - return (wantarray ? @pk : $pk[0]); + $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}); } -1; +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; +} -=back +=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 _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; + } + } -=head1 AUTHORS + if (@undef && $self->in_storage) { + $self->throw_exception ( + 'Unable to construct result object identity condition due to NULL PK columns: ' + . join (', ', @undef) + ); + } + + return \%cond; +} -Matt S. Trout +=head1 FURTHER QUESTIONS? -=head1 LICENSE +Check the list of L. -You may distribute this code under the same terms as Perl itself. +=head1 COPYRIGHT AND LICENSE + +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut +1;