lib/DBIx/Class/PK.pm

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