use strict;
use warnings;
-use Tie::IxHash;
-use base qw/Class::Data::Inheritable/;
+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
=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
-sub _ident_cond {
- my ($class) = @_;
- return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
-}
+=head2 id
-sub _ident_values {
- my ($self) = @_;
- return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
-}
+Returns the primary key(s) for a row. Can't be called as
+a class method.
-=item set_primary_key <@cols>
+=cut
-define one or more columns as primary key for this class
+sub id :DBIC_method_is_indirect_sugar {
+ DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
-=cut
+ $_[0]->throw_exception( "Can't call id() as a class method" )
+ unless ref $_[0];
-sub set_primary_key {
- my ($class, @cols) = @_;
- my %pri;
- tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
- $class->_primaries(\%pri);
+ wantarray
+ ? $_[0]->_ident_values
+ : ($_[0]->_ident_values)[0] # FIXME - horrible horrible legacy crap
+ ;
}
-=item find
+sub _ident_values {
+ my ($self, $use_storage_state) = @_;
-Finds columns based on the primary key(s).
+ my (@ids, @missing);
-=cut
+ 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 ($_) );
+ }
-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};
+ if (@missing && $self->in_storage) {
+ $self->throw_exception (
+ 'Unable to uniquely identify result object with missing PK columns: '
+ . join (', ', @missing )
+ );
}
- $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) : ());
+
+ return @ids;
}
-=item discard_changes
+=head2 ID
-Roll back changes that hasn't been comitted to the database.
+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 discard_changes {
- 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;
-}
+=item WARNING
-=item id
+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>.
-returns the primary key(s) for the current row. Can't be called as
-a class method.
+=back
=cut
-sub id {
+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]);
+ $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 primary_columns
+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;
+}
-read-only accessor which returns a list of primary keys.
+=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 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) = @_;
-sub ident_condition {
- my ($self) = @_;
- my %cond;
- $cond{$_} = $self->get_column($_) for $self->primary_columns;
- return \%cond;
-}
+ my @pks = $self->result_source->_pri_cols_or_die;
+ my @vals = $self->_ident_values($use_storage_state);
-1;
+ my (%cond, @undef);
+ my $prefix = defined $alias ? $alias.'.' : '';
+ for my $col (@pks) {
+ if (! defined ($cond{$prefix.$col} = shift @vals) ) {
+ push @undef, $col;
+ }
+ }
-=back
+ if (@undef && $self->in_storage) {
+ $self->throw_exception (
+ 'Unable to construct result object identity condition due to NULL PK columns: '
+ . join (', ', @undef)
+ );
+ }
-=head1 AUTHORS
+ return \%cond;
+}
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+=head1 FURTHER QUESTIONS?
-=head1 LICENSE
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
-You may distribute this code under the same terms as Perl itself.
+=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;
projects / dbsrgits/DBIx-Class.git / blobdiff