X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK.pm;h=cf8a194cc99f7a1fb51b82594c4cdf680d734163;hb=bbd107cf7ae1e53547ce63b710716d88adb73013;hp=1163725f56d40b75644e476d84fea07d218dfcef;hpb=a3018bd384d02955c5a442cf2fd1ac654393a3c8;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm index 1163725..cf8a194 100644 --- a/lib/DBIx/Class/PK.pm +++ b/lib/DBIx/Class/PK.pm @@ -3,43 +3,105 @@ 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' => {}); +=head1 NAME -sub _ident_cond { - my ($class) = @_; - return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries}); +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 { + my ($self) = @_; + $self->throw_exception( "Can't call id() as a class method" ) + unless ref $self; + my @pk = $self->_ident_values; + return (wantarray ? @pk : $pk[0]); } sub _ident_values { my ($self) = @_; - return (map { $self->{_column_data}{$_} } keys %{$self->_primaries}); + return (map { $self->{_column_data}{$_} } $self->primary_columns); } -sub set_primary { - my ($class, @cols) = @_; - my %pri; - $pri{$_} = {} for @cols; - $class->_primaries(\%pri); +=head2 ID + +Returns a unique id string identifying a row 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) = @_; + $self->throw_exception( "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}{$_} } + $self->primary_columns); } -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) { - return ($class->retrieve_from_sql($class->_ident_cond, @vals))[0]; - } 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 - return ($class->search($query))[0]; +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; +} + +=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 { + my ($self, $alias) = @_; + my %cond; + my $prefix = defined $alias ? $alias.'.' : ''; + $cond{$prefix.$_} = $self->get_column($_) for $self->primary_columns; + return \%cond; } 1; + +=head1 AUTHORS + +Matt S. Trout + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut +