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 find {
  48   my ($class, @vals) = @_;
  49   my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
  50   my @pk = keys %{$class->_primaries};
  51   $class->throw( "Can't find unless primary columns are defined" )
  52     unless @pk;
  53   my $query;
  54   if (ref $vals[0] eq 'HASH') {
  55     $query = $vals[0];
  56   } elsif (@pk == @vals) {
  57     $query = {};
  58     @{$query}{@pk} = @vals;
  59     #my $ret = ($class->search_literal($class->_ident_cond, @vals, $attrs))[0];
  60     #warn "$class: ".join(', ', %{$ret->{_column_data}});
  61     #return $ret;
  62   } else {
  63     $query = {@vals};
  64   }
  65   $class->throw( "Can't find unless all primary keys are specified" )
  66     unless (keys %$query >= @pk); # If we check 'em we run afoul of uc/lc
  67                                   # column names etc. Not sure what to do yet
  68   #return $class->search($query)->next;
  69   my @cols = $class->_select_columns;
  70   my @row = $class->storage->select_single($class->_table_name, \@cols, $query);
  71   return (@row ? $class->_row_to_object(\@cols, \@row) : ());
  72 }
  73
  74 sub discard_changes {
  75   my ($self) = @_;
  76   delete $self->{_dirty_columns};
  77   return unless $self->in_storage; # Don't reload if we aren't real!
  78   my ($reload) = $self->find($self->id);
  79   unless ($reload) { # If we got deleted in the mean-time
  80     $self->in_storage(0);
  81     return $self;
  82   }
  83   delete @{$self}{keys %$self};
  84   @{$self}{keys %$reload} = values %$reload;
  85   #$self->store_column($_ => $reload->get_column($_))
  86   #  foreach keys %{$self->_columns};
  87   return $self;
  88 }
  89
  90 sub id {
  91   my ($self) = @_;
  92   $self->throw( "Can't call id() as a class method" ) unless ref $self;
  93   my @pk = $self->_ident_values;
  94   return (wantarray ? @pk : $pk[0]);
  95 }
  96
  97 sub primary_columns {
  98   return keys %{shift->_primaries};
  99 }
 100
 101 1;
 102
 103 =back
 104
 105 =head1 AUTHORS
 106
 107 Matt S. Trout <mst@shadowcatsystems.co.uk>
 108
 109 =head1 LICENSE
 110
 111 You may distribute this code under the same terms as Perl itself.
 112
 113 =cut
 114