X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK.pm;h=62792fba75235fcdf572cac57142a06dfca22a33;hb=0c11ad0ee5c8407f6b87d6e15c62a1b445076dc0;hp=f156b59519c3700f1ec5ca71f1292f2157e0e9d2;hpb=741d6d0ecddc46df590f700f5270d1e287d4ab2b;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm index f156b59..62792fb 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,155 +13,132 @@ DBIx::Class::PK - Primary Key class =head1 DESCRIPTION -This class contains methods for handling primary keys and methods +This class contains methods for handling primary keys and methods depending on them. =head1 METHODS =cut -sub _ident_cond { - my ($class) = @_; - return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries}); -} +=head2 id -sub _ident_values { +Returns the primary key(s) for a row. Can't be called as +a class method. + +=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; + my @id_vals = $self->_ident_values; + return (wantarray ? @id_vals : $id_vals[0]); } -=head2 set_primary_key(@cols) +sub _ident_values { + my ($self, $use_storage_state) = @_; -Defines one or more columns as primary key for this class. Should be -called after C. + my (@ids, @missing); -=cut + 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 ($_) ); + } -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($_); + if (@missing && $self->in_storage) { + $self->throw_exception ( + 'Unable to uniquely identify row object with missing PK columns: ' + . join (', ', @missing ) + ); } - my %pri; - tie %pri, 'Tie::IxHash', map { $_ => {} } @cols; - $class->_primaries(\%pri); + + return @ids; } -=head2 find(@colvalues), find(\%cols) +=head2 ID -Finds a row based on its primary key(s). +Returns a unique id string identifying a row object by primary key. +Used by L and +L. -=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 -=head2 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 +the L method, which follows the same order in which columns were fed +to L. -Re-selects the row from the database, losing any changes that had -been made. +=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(map { $self->$_ } $self->primary_columns); - 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}); } -=head2 id - -Returns the primary key(s) for a 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(); -=head2 primary_columns + my $cond = $result_source->ident_condition('alias'); -Read-only accessor which returns the list of primary keys for a class -(in scalar context, only returns the first primary key). +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(@_); } -=head2 ID +sub _storage_ident_condition { + shift->_mk_ident_cond(shift, 1); +} -Returns a unique id string identifying a row object by primary key. -Used by L and -L. +sub _mk_ident_cond { + my ($self, $alias, $use_storage_state) = @_; -=cut + my @pks = $self->_pri_cols; + my @vals = $self->_ident_values($use_storage_state); -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}); -} + my (%cond, @undef); + my $prefix = defined $alias ? $alias.'.' : ''; + for my $col (@pks) { + if (! defined ($cond{$prefix.$col} = shift @vals) ) { + push @undef, $col; + } + } -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; -} + if (@undef && $self->in_storage) { + $self->throw_exception ( + 'Unable to construct row 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; -=head1 AUTHORS +=head1 AUTHOR AND CONTRIBUTORS -Matt S. Trout +See L and L in DBIx::Class =head1 LICENSE