X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FPK.pm;h=cb59ec963be2782334b935a35fd9d26f708fe5e4;hb=b54dbe8c770662c25310b8dcee746481248f8b5c;hp=edb7277cc4c92840401ed8c744f60930d7fee6da;hpb=604d9f388716261ca478b574f891928e8e0852ef;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm index edb7277..cb59ec9 100644 --- a/lib/DBIx/Class/PK.pm +++ b/lib/DBIx/Class/PK.pm @@ -3,60 +3,129 @@ 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 sub _ident_values { my ($self) = @_; - return (map { $self->{_column_data}{$_} } keys %{$self->_primaries}); + return (map { $self->{_column_data}{$_} } $self->primary_columns); } -sub set_primary_key { - my ($class, @cols) = @_; - my %pri; - $pri{$_} = {} for @cols; - $class->_primaries(\%pri); -} +=head2 discard_changes ($attrs) -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) { - my $ret = ($class->retrieve_from_sql($class->_ident_cond, @vals))[0]; - #warn "$class: ".join(', ', %{$ret->{_column_data}}); - return $ret; - } 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 - my $ret = ($class->search($query))[0]; - #warn "$class: ".join(', ', %{$ret->{_column_data}}); - return $ret; -} +Re-selects the row from the database, losing any changes that had +been made. + +This method can also be used to refresh from storage, retrieving any +changes made since the row was last read from storage. + +$attrs is expected to be a hashref of attributes suitable for passing as the +second argument to $resultset->search($cond, $attrs); + +=cut sub discard_changes { - my ($self) = @_; + my ($self, $attrs) = @_; delete $self->{_dirty_columns}; - $_[0] = $self->retrieve($self->id); + return unless $self->in_storage; # Don't reload if we aren't real! + + $attrs = { force_pool => 'master', %{ defined $attrs ? $attrs:{} } }; + if( my $current_storage = $self->get_from_storage($attrs)) { + + # Set $self to the current. + %$self = %$current_storage; + + # Avoid a possible infinite loop with + # sub DESTROY { $_[0]->discard_changes } + bless $current_storage, 'Do::Not::Exist'; + + return $self; + } else { + $self->in_storage(0); + return $self; + } } +=head2 id + +Returns the primary key(s) for a row. Can't be called as +a class method. + +=cut + sub id { my ($self) = @_; - die "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; my @pk = $self->_ident_values; return (wantarray ? @pk : $pk[0]); } +=head2 ID + +Returns a unique id string identifying a row object by primary key. +Used by L and +L. + +=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 _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 +