use base qw/DBIx::Class::Row/;
-=head1 NAME
+use DBIx::Class::_Util 'fail_on_internal_call';
+use namespace::clean;
+
+=head1 NAME
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 { "$_ = ?" } $class->primary_columns);
-}
+=head2 id
-sub _ident_values {
- my ($self) = @_;
- return (map { $self->{_column_data}{$_} } $self->primary_columns);
-}
+Returns the primary key(s) for a row. Can't be called as
+a class method.
-=head2 discard_changes
+=cut
-Re-selects the row from the database, losing any changes that had
-been made.
+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 discard_changes {
- my ($self) = @_;
- delete $self->{_dirty_columns};
- return unless $self->in_storage; # Don't reload if we aren't real!
- my ($reload) = $self->result_source->resultset->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;
+ wantarray
+ ? $_[0]->_ident_values
+ : ($_[0]->_ident_values)[0] # FIXME - horrible horrible legacy crap
+ ;
}
-=head2 id
+sub _ident_values {
+ my ($self, $use_storage_state) = @_;
-Returns the primary key(s) for a row. Can't be called as
-a class method.
+ 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 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]);
+ 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 row object by primary key.
-Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
+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) = @_;
- $self->throw_exception( "Can't call ID() as a class method" ) unless ref $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);
+ return $self->_create_ID(%{$self->ident_condition});
}
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;
+ my ($self, %vals) = @_;
+ return undef if 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;
- $cond{(defined $alias ? "${alias}.$_" : $_)} = $self->get_column($_) for $self->primary_columns;
- return \%cond;
+ shift->_mk_ident_cond(@_);
}
-1;
+sub _storage_ident_condition {
+ shift->_mk_ident_cond(shift, 1);
+}
+
+sub _mk_ident_cond {
+ my ($self, $alias, $use_storage_state) = @_;
-=head1 AUTHORS
+ my @pks = $self->result_source->_pri_cols_or_die;
+ my @vals = $self->_ident_values($use_storage_state);
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+ my (%cond, @undef);
+ my $prefix = defined $alias ? $alias.'.' : '';
+ for my $col (@pks) {
+ if (! defined ($cond{$prefix.$col} = shift @vals) ) {
+ push @undef, $col;
+ }
+ }
-=head1 LICENSE
+ if (@undef && $self->in_storage) {
+ $self->throw_exception (
+ 'Unable to construct result object identity condition due to NULL PK columns: '
+ . join (', ', @undef)
+ );
+ }
-You may distribute this code under the same terms as Perl itself.
+ 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;
projects / dbsrgits/DBIx-Class.git / blobdiff