Fixed DBICTest Schema class names, added class_resolver system to make them work
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Relationship.pm
CommitLineData
b8e1e21f 1package DBIx::Class::Relationship;
2
3use strict;
4use warnings;
5
6use base qw/Class::Data::Inheritable/;
7
8__PACKAGE__->mk_classdata('_relationships', { } );
9
34d52be2 10=head1 NAME
11
12DBIx::Class::Relationship - Inter-table relationships
13
14=head1 SYNOPSIS
15
16=head1 DESCRIPTION
17
18This class handles relationships between the tables in your database
19model. It allows your to set up relationships, and to perform joins
20on searches.
21
22=head1 METHODS
23
24=over 4
25
26=cut
27
b8e1e21f 28sub add_relationship {
29 my ($class, $rel, $f_class, $cond, $attrs) = @_;
1c6ae274 30 die "Can't create relationship without join condition" unless $cond;
d2ff6175 31 $attrs ||= {};
32 eval "use $f_class;";
b8e1e21f 33 my %rels = %{ $class->_relationships };
34 $rels{$rel} = { class => $f_class,
35 cond => $cond,
36 attrs => $attrs };
37 $class->_relationships(\%rels);
d2ff6175 38 #warn %{$f_class->_columns};
d322f982 39
d2ff6175 40 return unless eval { %{$f_class->_columns}; }; # Foreign class not loaded
41 my %join = (%$attrs, _action => 'join',
42 _aliases => { 'self' => 'me', 'foreign' => $rel },
43 _classes => { 'me' => $class, $rel => $f_class });
44 eval { $class->_cond_resolve($cond, \%join) };
d322f982 45
46 if ($@) { # If the resolve failed, back out and re-throw the error
47 delete $rels{$rel}; #
48 $class->_relationships(\%rels);
49 $class->throw("Error creating relationship $rel: $@");
50 }
51 1;
b8e1e21f 52}
53
54sub _cond_key {
55 my ($self, $attrs, $key) = @_;
56 my $action = $attrs->{_action} || '';
57 if ($action eq 'convert') {
58 unless ($key =~ s/^foreign\.//) {
78bab9ca 59 $self->throw("Unable to convert relationship to WHERE clause: invalid key ${key}");
b8e1e21f 60 }
61 return $key;
62 } elsif ($action eq 'join') {
63 my ($type, $field) = split(/\./, $key);
d2ff6175 64 if (my $alias = $attrs->{_aliases}{$type}) {
65 my $class = $attrs->{_classes}{$alias};
66 $self->throw("Unknown column $field on $class as $alias")
67 unless exists $class->_columns->{$field};
68 return join('.', $alias, $field);
b8e1e21f 69 } else {
78bab9ca 70 $self->throw( "Unable to resolve type ${type}: only have aliases for ".
d2ff6175 71 join(', ', keys %{$attrs->{_aliases} || {}}) );
b8e1e21f 72 }
73 }
74 return $self->NEXT::ACTUAL::_cond_key($attrs, $key);
75}
76
77sub _cond_value {
78 my ($self, $attrs, $key, $value) = @_;
79 my $action = $attrs->{_action} || '';
80 if ($action eq 'convert') {
81 unless ($value =~ s/^self\.//) {
78bab9ca 82 $self->throw( "Unable to convert relationship to WHERE clause: invalid value ${value}" );
b8e1e21f 83 }
c687b87e 84 unless ($self->_columns->{$value}) {
78bab9ca 85 $self->throw( "Unable to convert relationship to WHERE clause: no such accessor ${value}" );
b8e1e21f 86 }
87 push(@{$attrs->{bind}}, $self->get_column($value));
88 return '?';
89 } elsif ($action eq 'join') {
90 my ($type, $field) = split(/\./, $value);
d2ff6175 91 if (my $alias = $attrs->{_aliases}{$type}) {
92 my $class = $attrs->{_classes}{$alias};
93 $self->throw("Unknown column $field on $class as $alias")
94 unless exists $class->_columns->{$field};
95 return join('.', $alias, $field);
b8e1e21f 96 } else {
78bab9ca 97 $self->throw( "Unable to resolve type ${type}: only have aliases for ".
d2ff6175 98 join(', ', keys %{$attrs->{_aliases} || {}}) );
b8e1e21f 99 }
100 }
101
102 return $self->NEXT::ACTUAL::_cond_value($attrs, $key, $value)
103}
104
105sub search_related {
106 my $self = shift;
656796f2 107 return $self->_literal_related('search', @_);
fcbc5f29 108}
109
110sub count_related {
111 my $self = shift;
656796f2 112 return $self->_literal_related('count', @_);
fcbc5f29 113}
114
656796f2 115sub _literal_related {
fcbc5f29 116 my $self = shift;
117 my $op = shift;
656796f2 118 my $meth = "${op}_literal";
b8e1e21f 119 my $rel = shift;
120 my $attrs = { };
121 if (@_ > 1 && ref $_[$#_] eq 'HASH') {
122 $attrs = { %{ pop(@_) } };
123 }
124 my $rel_obj = $self->_relationships->{$rel};
4a07648a 125 $self->throw( "No such relationship ${rel}" ) unless $rel_obj;
9b6e0845 126 $attrs = { %{$rel_obj->{attrs} || {}}, %{$attrs || {}} };
b8e1e21f 127 my $s_cond;
128 if (@_) {
78bab9ca 129 $self->throw( "Invalid query: @_" ) if (@_ > 1 && (@_ % 2 == 1));
b8e1e21f 130 my $query = ((@_ > 1) ? {@_} : shift);
131 $s_cond = $self->_cond_resolve($query, $attrs);
132 }
fcbc5f29 133 $attrs->{_action} = 'convert'; # shouldn't we resolve the cond to something
134 # to merge into the AST really?
b8e1e21f 135 my ($cond) = $self->_cond_resolve($rel_obj->{cond}, $attrs);
136 $cond = "${s_cond} AND ${cond}" if $s_cond;
8b445e33 137 #warn $rel_obj->{class}." $meth $cond ".join(', ', @{$attrs->{bind}});
11b78bd6 138 return $self->resolve_class($rel_obj->{class}
139 )->$meth($cond, @{$attrs->{bind} || []}, $attrs);
b8e1e21f 140}
141
142sub create_related {
4a07648a 143 my $class = shift;
144 return $class->new_related(@_)->insert;
145}
146
147sub new_related {
b8e1e21f 148 my ($self, $rel, $values, $attrs) = @_;
b28cc0ba 149 $self->throw( "Can't call new_related as class method" )
78bab9ca 150 unless ref $self;
b28cc0ba 151 $self->throw( "new_related needs a hash" )
78bab9ca 152 unless (ref $values eq 'HASH');
b8e1e21f 153 my $rel_obj = $self->_relationships->{$rel};
4a07648a 154 $self->throw( "No such relationship ${rel}" ) unless $rel_obj;
78bab9ca 155 $self->throw( "Can't abstract implicit create for ${rel}, condition not a hash" )
b8e1e21f 156 unless ref $rel_obj->{cond} eq 'HASH';
157 $attrs = { %{$rel_obj->{attrs}}, %{$attrs || {}}, _action => 'convert' };
158 my %fields = %$values;
159 while (my ($k, $v) = each %{$rel_obj->{cond}}) {
160 $self->_cond_value($attrs, $k => $v);
161 $fields{$self->_cond_key($attrs, $k)} = (@{delete $attrs->{bind}})[0];
162 }
11b78bd6 163 return $self->resolve_class($rel_obj->{class})->new(\%fields);
4a07648a 164}
165
166sub find_or_create_related {
167 my $self = shift;
168 return ($self->search_related(@_))[0] || $self->create_related(@_);
169}
170
171sub set_from_related {
172 my ($self, $rel, $f_obj) = @_;
173 my $rel_obj = $self->_relationships->{$rel};
174 $self->throw( "No such relationship ${rel}" ) unless $rel_obj;
175 my $cond = $rel_obj->{cond};
176 $self->throw( "set_from_related can only handle a hash condition; the "
177 ."condition for $rel is of type ".(ref $cond ? ref $cond : 'plain scalar'))
178 unless ref $cond eq 'HASH';
11b78bd6 179 my $f_class = $self->resolve_class($rel_obj->{class});
180 $self->throw( "Object $f_obj isn't a ".$f_class )
181 unless $f_obj->isa($f_class);
4a07648a 182 foreach my $key (keys %$cond) {
183 next if ref $cond->{$key}; # Skip literals and complex conditions
184 $self->throw("set_from_related can't handle $key as key")
185 unless $key =~ m/^foreign\.([^\.]+)$/;
186 my $val = $f_obj->get_column($1);
187 $self->throw("set_from_related can't handle ".$cond->{$key}." as value")
188 unless $cond->{$key} =~ m/^self\.([^\.]+)$/;
189 $self->set_column($1 => $val);
190 }
191 return 1;
192}
193
194sub update_from_related {
195 my $self = shift;
196 $self->set_from_related(@_);
197 $self->update;
b8e1e21f 198}
199
2001;
34d52be2 201
202=back
203
204=head1 AUTHORS
205
206Matt S. Trout <perl-stuff@trout.me.uk>
207
208=head1 LICENSE
209
210You may distribute this code under the same terms as Perl itself.
211
212=cut
213