Commit | Line | Data |
dbd7896f |
1 | package DBIx::Class::PK; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
1edd1722 |
6 | use base qw/DBIx::Class::Row/; |
dbd7896f |
7 | |
75d07914 |
8 | =head1 NAME |
34d52be2 |
9 | |
10 | DBIx::Class::PK - Primary Key class |
11 | |
12 | =head1 SYNOPSIS |
13 | |
14 | =head1 DESCRIPTION |
15 | |
75d07914 |
16 | This class contains methods for handling primary keys and methods |
8091aa91 |
17 | depending on them. |
34d52be2 |
18 | |
19 | =head1 METHODS |
20 | |
34d52be2 |
21 | =cut |
22 | |
8091aa91 |
23 | =head2 id |
076652e8 |
24 | |
8091aa91 |
25 | Returns the primary key(s) for a row. Can't be called as |
076652e8 |
26 | a class method. |
27 | |
28 | =cut |
29 | |
604d9f38 |
30 | sub id { |
31 | my ($self) = @_; |
bc0c9800 |
32 | $self->throw_exception( "Can't call id() as a class method" ) |
33 | unless ref $self; |
b946a283 |
34 | my @id_vals = $self->_ident_values; |
35 | return (wantarray ? @id_vals : $id_vals[0]); |
604d9f38 |
36 | } |
37 | |
bbd107cf |
38 | sub _ident_values { |
39 | my ($self) = @_; |
b946a283 |
40 | my (@ids, @missing); |
41 | |
42 | for ($self->_pri_cols) { |
43 | push @ids, $self->get_column($_); |
44 | push @missing, $_ if (! defined $ids[-1] and ! $self->has_column_loaded ($_) ); |
45 | } |
46 | |
47 | if (@missing && $self->in_storage) { |
48 | $self->throw_exception ( |
49 | 'Unable to uniquely identify row object with missing PK columns: ' |
50 | . join (', ', @missing ) |
51 | ); |
52 | } |
53 | |
54 | return @ids; |
bbd107cf |
55 | } |
56 | |
8091aa91 |
57 | =head2 ID |
58 | |
59 | Returns a unique id string identifying a row object by primary key. |
75d07914 |
60 | Used by L<DBIx::Class::CDBICompat::LiveObjectIndex> and |
8091aa91 |
61 | L<DBIx::Class::ObjectCache>. |
62 | |
bbd107cf |
63 | =over |
64 | |
65 | =item WARNING |
66 | |
67 | The default C<_create_ID> method used by this function orders the returned |
68 | values by the alphabetical order of the primary column names, B<unlike> |
69 | the L</id> method, which follows the same order in which columns were fed |
70 | to L<DBIx::Class::ResultSource/set_primary_key>. |
71 | |
72 | =back |
73 | |
8091aa91 |
74 | =cut |
75 | |
48700d09 |
76 | sub ID { |
77 | my ($self) = @_; |
bc0c9800 |
78 | $self->throw_exception( "Can't call ID() as a class method" ) |
79 | unless ref $self; |
48700d09 |
80 | return undef unless $self->in_storage; |
b946a283 |
81 | return $self->_create_ID(%{$self->ident_condition}); |
48700d09 |
82 | } |
83 | |
84 | sub _create_ID { |
b946a283 |
85 | my ($self, %vals) = @_; |
90f3f5ff |
86 | return undef unless 0 == grep { !defined } values %vals; |
bc0c9800 |
87 | return join '|', ref $self || $self, $self->result_source->name, |
75d07914 |
88 | map { $_ . '=' . $vals{$_} } sort keys %vals; |
48700d09 |
89 | } |
90 | |
9b83fccd |
91 | =head2 ident_condition |
92 | |
93 | my $cond = $result_source->ident_condition(); |
94 | |
95 | my $cond = $result_source->ident_condition('alias'); |
96 | |
97 | Produces a condition hash to locate a row based on the primary key(s). |
98 | |
99 | =cut |
100 | |
103647d5 |
101 | sub ident_condition { |
fea3d045 |
102 | my ($self, $alias) = @_; |
b946a283 |
103 | |
104 | my @pks = $self->_pri_cols; |
105 | my @vals = $self->_ident_values; |
106 | |
107 | my (%cond, @undef); |
e04df8ec |
108 | my $prefix = defined $alias ? $alias.'.' : ''; |
b946a283 |
109 | for my $col (@pks) { |
110 | if (! defined ($cond{$prefix.$col} = shift @vals) ) { |
111 | push @undef, $col; |
112 | } |
113 | } |
114 | |
115 | if (@undef && $self->in_storage) { |
116 | $self->throw_exception ( |
117 | 'Unable to construct row object identity condition due to NULL PK columns: ' |
118 | . join (', ', @undef) |
119 | ); |
120 | } |
121 | |
103647d5 |
122 | return \%cond; |
123 | } |
124 | |
dbd7896f |
125 | 1; |
34d52be2 |
126 | |
34d52be2 |
127 | =head1 AUTHORS |
128 | |
daec44b8 |
129 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
34d52be2 |
130 | |
131 | =head1 LICENSE |
132 | |
133 | You may distribute this code under the same terms as Perl itself. |
134 | |
135 | =cut |
136 | |