Commit | Line | Data |
55e2d745 |
1 | package DBIx::Class::Relationship::Base; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
1edd1722 |
6 | use base qw/DBIx::Class/; |
55e2d745 |
7 | |
8 | __PACKAGE__->mk_classdata('_relationships', { } ); |
9 | |
10 | =head1 NAME |
11 | |
8918977e |
12 | DBIx::Class::Relationship::Base - Inter-table relationships |
55e2d745 |
13 | |
14 | =head1 SYNOPSIS |
15 | |
16 | =head1 DESCRIPTION |
17 | |
18 | This class handles relationships between the tables in your database |
19 | model. It allows your to set up relationships, and to perform joins |
20 | on searches. |
21 | |
22 | =head1 METHODS |
23 | |
8091aa91 |
24 | =head2 add_relationship |
503536d5 |
25 | |
26 | __PACKAGE__->add_relationship('relname', 'Foreign::Class', $cond, $attrs); |
27 | |
28 | The condition needs to be an SQL::Abstract-style representation of the |
8091aa91 |
29 | join between the tables. For example, if you're creating a rel from Foo to Bar, |
503536d5 |
30 | |
31 | { 'foreign.foo_id' => 'self.id' } |
32 | |
8091aa91 |
33 | will result in the JOIN clause |
503536d5 |
34 | |
35 | foo me JOIN bar bar ON bar.foo_id = me.id |
36 | |
8091aa91 |
37 | You can specify as many foreign => self mappings as necessary. |
38 | |
39 | Valid attributes are as follows: |
40 | |
41 | =over 4 |
42 | |
43 | =item join_type |
44 | |
45 | Explicitly specifies the type of join to use in the relationship. Any SQL |
46 | join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in the SQL |
47 | command immediately before C<JOIN>. |
48 | |
49 | =item proxy |
50 | |
51 | An arrayref containing a list of accessors in the foreign class to proxy in |
52 | the main class. If, for example, you do the following: |
53 | |
fc69fea6 |
54 | __PACKAGE__->might_have(bar => 'Bar', undef, { proxy => [ qw/margle/ ] }); |
8091aa91 |
55 | |
56 | Then, assuming Bar has an accessor named margle, you can do: |
57 | |
58 | my $obj = Foo->find(1); |
59 | $obj->margle(10); # set margle; Bar object is created if it doesn't exist |
60 | |
61 | =item accessor |
62 | |
63 | Specifies the type of accessor that should be created for the relationship. |
64 | Valid values are C<single> (for when there is only a single related object), |
65 | C<multi> (when there can be many), and C<filter> (for when there is a single |
66 | related object, but you also want the relationship accessor to double as |
67 | a column accessor). For C<multi> accessors, an add_to_* method is also |
68 | created, which calls C<create_related> for the relationship. |
69 | |
70 | =back |
71 | |
71e65b39 |
72 | =head2 register_relationship($relname, $rel_info) |
73 | |
74 | Registers a relationship on the class |
75 | |
55e2d745 |
76 | =cut |
77 | |
71e65b39 |
78 | sub register_relationship { } |
79 | |
8091aa91 |
80 | =head2 search_related |
503536d5 |
81 | |
82 | My::Table->search_related('relname', $cond, $attrs); |
83 | |
84 | =cut |
85 | |
55e2d745 |
86 | sub search_related { |
87 | my $self = shift; |
3842b955 |
88 | die "Can't call *_related as class methods" unless ref $self; |
55e2d745 |
89 | my $rel = shift; |
90 | my $attrs = { }; |
91 | if (@_ > 1 && ref $_[$#_] eq 'HASH') { |
92 | $attrs = { %{ pop(@_) } }; |
93 | } |
4685e006 |
94 | my $rel_obj = $self->relationship_info($rel); |
701da8c4 |
95 | $self->throw_exception( "No such relationship ${rel}" ) unless $rel_obj; |
55e2d745 |
96 | $attrs = { %{$rel_obj->{attrs} || {}}, %{$attrs || {}} }; |
97 | |
701da8c4 |
98 | $self->throw_exception( "Invalid query: @_" ) if (@_ > 1 && (@_ % 2 == 1)); |
55e2d745 |
99 | my $query = ((@_ > 1) ? {@_} : shift); |
100 | |
3842b955 |
101 | my ($cond) = $self->result_source->resolve_condition($rel_obj->{cond}, $rel, $self); |
8fab5eef |
102 | foreach my $key (keys %$cond) { |
103 | unless ($key =~ m/\./) { |
104 | $cond->{"me.$key"} = delete $cond->{$key}; |
105 | } |
106 | } |
438adc0e |
107 | $query = ($query ? { '-and' => [ $cond, $query ] } : $cond); |
3842b955 |
108 | #use Data::Dumper; warn Dumper($cond); |
438adc0e |
109 | #warn $rel_obj->{class}." $meth $cond ".join(', ', @{$attrs->{bind}||[]}); |
3842b955 |
110 | return $self->result_source->related_source($rel |
111 | )->resultset->search($query, $attrs); |
b52e9bf8 |
112 | } |
113 | |
114 | =head2 count_related |
115 | |
7be93b07 |
116 | $obj->count_related('relname', $cond, $attrs); |
b52e9bf8 |
117 | |
118 | =cut |
119 | |
120 | sub count_related { |
121 | my $self = shift; |
122 | return $self->search_related(@_)->count; |
55e2d745 |
123 | } |
124 | |
8091aa91 |
125 | =head2 create_related |
503536d5 |
126 | |
127 | My::Table->create_related('relname', \%col_data); |
128 | |
129 | =cut |
130 | |
55e2d745 |
131 | sub create_related { |
3842b955 |
132 | my $self = shift; |
fea3d045 |
133 | my $rel = shift; |
3842b955 |
134 | return $self->search_related($rel)->create(@_); |
55e2d745 |
135 | } |
136 | |
8091aa91 |
137 | =head2 new_related |
503536d5 |
138 | |
139 | My::Table->new_related('relname', \%col_data); |
140 | |
141 | =cut |
142 | |
55e2d745 |
143 | sub new_related { |
144 | my ($self, $rel, $values, $attrs) = @_; |
fea3d045 |
145 | return $self->search_related($rel)->new($values, $attrs); |
55e2d745 |
146 | } |
147 | |
8091aa91 |
148 | =head2 find_related |
503536d5 |
149 | |
150 | My::Table->find_related('relname', @pri_vals | \%pri_vals); |
151 | |
152 | =cut |
153 | |
1a14aa3f |
154 | sub find_related { |
155 | my $self = shift; |
156 | my $rel = shift; |
716b3d29 |
157 | return $self->search_related($rel)->find(@_); |
1a14aa3f |
158 | } |
159 | |
8091aa91 |
160 | =head2 find_or_create_related |
503536d5 |
161 | |
162 | My::Table->find_or_create_related('relname', \%col_data); |
163 | |
164 | =cut |
165 | |
55e2d745 |
166 | sub find_or_create_related { |
167 | my $self = shift; |
1a14aa3f |
168 | return $self->find_related(@_) || $self->create_related(@_); |
55e2d745 |
169 | } |
170 | |
8091aa91 |
171 | =head2 set_from_related |
503536d5 |
172 | |
173 | My::Table->set_from_related('relname', $rel_obj); |
174 | |
175 | =cut |
176 | |
55e2d745 |
177 | sub set_from_related { |
178 | my ($self, $rel, $f_obj) = @_; |
4685e006 |
179 | my $rel_obj = $self->relationship_info($rel); |
701da8c4 |
180 | $self->throw_exception( "No such relationship ${rel}" ) unless $rel_obj; |
55e2d745 |
181 | my $cond = $rel_obj->{cond}; |
701da8c4 |
182 | $self->throw_exception( "set_from_related can only handle a hash condition; the " |
55e2d745 |
183 | ."condition for $rel is of type ".(ref $cond ? ref $cond : 'plain scalar')) |
184 | unless ref $cond eq 'HASH'; |
7fb16f1a |
185 | my $f_class = $self->result_source->schema->class($rel_obj->{class}); |
701da8c4 |
186 | $self->throw_exception( "Object $f_obj isn't a ".$f_class ) |
55e2d745 |
187 | unless $f_obj->isa($f_class); |
188 | foreach my $key (keys %$cond) { |
189 | next if ref $cond->{$key}; # Skip literals and complex conditions |
701da8c4 |
190 | $self->throw_exception("set_from_related can't handle $key as key") |
55e2d745 |
191 | unless $key =~ m/^foreign\.([^\.]+)$/; |
192 | my $val = $f_obj->get_column($1); |
701da8c4 |
193 | $self->throw_exception("set_from_related can't handle ".$cond->{$key}." as value") |
55e2d745 |
194 | unless $cond->{$key} =~ m/^self\.([^\.]+)$/; |
195 | $self->set_column($1 => $val); |
196 | } |
197 | return 1; |
198 | } |
199 | |
8091aa91 |
200 | =head2 update_from_related |
503536d5 |
201 | |
202 | My::Table->update_from_related('relname', $rel_obj); |
203 | |
204 | =cut |
205 | |
55e2d745 |
206 | sub update_from_related { |
207 | my $self = shift; |
208 | $self->set_from_related(@_); |
209 | $self->update; |
210 | } |
211 | |
8091aa91 |
212 | =head2 delete_related |
503536d5 |
213 | |
214 | My::Table->delete_related('relname', $cond, $attrs); |
215 | |
216 | =cut |
217 | |
55e2d745 |
218 | sub delete_related { |
219 | my $self = shift; |
220 | return $self->search_related(@_)->delete; |
221 | } |
222 | |
223 | 1; |
224 | |
55e2d745 |
225 | =head1 AUTHORS |
226 | |
daec44b8 |
227 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
55e2d745 |
228 | |
229 | =head1 LICENSE |
230 | |
231 | You may distribute this code under the same terms as Perl itself. |
232 | |
233 | =cut |
234 | |