use warnings;
use Tie::IxHash;
-use base qw/Class::Data::Inheritable/;
+use base qw/DBIx::Class::Row/;
__PACKAGE__->mk_classdata('_primaries' => {});
=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 {
return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
}
-=item set_primary_key <@cols>
+=head2 set_primary_key(@cols)
-define one or more columns as primary key for this class
+Defines one or more columns as primary key for this class. Should be
+called after C<columns>.
=cut
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($_);
+ }
my %pri;
tie %pri, 'Tie::IxHash', map { $_ => {} } @cols;
$class->_primaries(\%pri);
}
-=item find
+=head2 find(@colvalues), find(\%cols)
-Finds columns based on the primary key(s).
+Finds a row based on its primary key(s).
=cut
return (@row ? $class->_row_to_object(\@cols, \@row) : ());
}
-=item discard_changes
+=head2 discard_changes
-Roll back changes that hasn't been comitted to the database.
+Re-selects the row from the database, losing any changes that had
+been made.
=cut
}
delete @{$self}{keys %$self};
@{$self}{keys %$reload} = values %$reload;
- #$self->store_column($_ => $reload->get_column($_))
- # foreach keys %{$self->_columns};
return $self;
}
-=item id
+=head2 id
-returns the primary key(s) for the current row. Can't be called as
+Returns the primary key(s) for a row. Can't be called as
a class method.
=cut
return (wantarray ? @pk : $pk[0]);
}
-=item primary_columns
+=head2 primary_columns
-read-only accessor which returns a list of primary keys.
+Read-only accessor which returns the list of primary keys for a class
+(in scalar context, only returns the first primary key).
=cut
return keys %{shift->_primaries};
}
+=head2 ID
+
+Returns a unique id string identifying a row object by primary key.
+Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and
+L<DBIx::Class::ObjectCache>.
+
+=cut
+
sub ID {
my ($self) = @_;
$self->throw( "Can't call ID() as a class method" ) unless ref $self;
return join '|', $class, map { $_ . '=' . $vals{$_} } sort keys %vals;
}
-1;
+sub ident_condition {
+ my ($self) = @_;
+ my %cond;
+ $cond{$_} = $self->get_column($_) for $self->primary_columns;
+ return \%cond;
+}
-=back
+1;
=head1 AUTHORS