lib/DBIx/Class/PK.pm

   1 package DBIx::Class::PK;
   2
   3 use strict;
   4 use warnings;
   5 use Tie::IxHash;
   6
   7 use base qw/Class::Data::Inheritable/;
   8
   9 __PACKAGE__->mk_classdata('_primaries' => {});
  10
  11 =head1 NAME
  12
  13 DBIx::Class::PK - Primary Key class
  14
  15 =head1 SYNOPSIS
  16
  17 =head1 DESCRIPTION
  18
  19 This class represents methods handling primary keys
  20 and depending on them.
  21
  22 =head1 METHODS
  23
  24 =over 4
  25
  26 =cut
  27
  28
  29 sub _ident_cond {
  30   my ($class) = @_;
  31   return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
  32 }
  33
  34 sub _ident_values {
  35   my ($self) = @_;
  36   return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
  37 }
  38
  39 sub set_primary_key {
  40   my ($class, @cols) = @_;
  41   my %pri;
  42   tie %pri, 'Tie::IxHash';
  43   %pri = map { $_ => {} } @cols;
  44   $class->_primaries(\%pri);
  45 }
  46
  47 sub retrieve {
  48   my ($class, @vals) = @_;
  49   my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
  50   my @pk = keys %{$class->_primaries};
  51   die "Can't retrieve unless primary columns are defined" unless @pk;
  52   my $query;
  53   if (ref $vals[0] eq 'HASH') {
  54     $query = $vals[0];
  55   } elsif (@pk == @vals) {
  56     my $ret = ($class->retrieve_from_sql($class->_ident_cond, @vals, $attrs))[0];
  57     #warn "$class: ".join(', ', %{$ret->{_column_data}});
  58     return $ret;
  59   } else {
  60     $query = {@vals};
  61   }
  62   die "Can't retrieve unless all primary keys are specified"
  63     unless (keys %$query >= @pk); # If we check 'em we run afoul of uc/lc
  64                                   # column names etc. Not sure what to do yet
  65   my $ret = ($class->search($query))[0];
  66   #warn "$class: ".join(', ', %{$ret->{_column_data}});
  67   return $ret;
  68 }
  69
  70 sub discard_changes {
  71   my ($self) = @_;
  72   delete $self->{_dirty_columns};
  73   return unless $self->in_database; # Don't reload if we aren't real!
  74   my ($reload) = $self->retrieve($self->id);
  75   unless ($reload) { # If we got deleted in the mean-time
  76     $self->in_database(0);
  77     return $self;
  78   }
  79   $self->store_column($_ => $reload->get_column($_))
  80     foreach keys %{$self->_columns};
  81   return $self;
  82 }
  83
  84 sub id {
  85   my ($self) = @_;
  86   die "Can't call id() as a class method" unless ref $self;
  87   my @pk = $self->_ident_values;
  88   return (wantarray ? @pk : $pk[0]);
  89 }
  90
  91 1;
  92
  93 =back
  94
  95 =head1 AUTHORS
  96
  97 Matt S. Trout <perl-stuff@trout.me.uk>
  98
  99 =head1 LICENSE
 100
 101 You may distribute this code under the same terms as Perl itself.
 102
 103 =cut
 104