Clarification cascade_* attribute defaults documentation
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Relationship / BelongsTo.pm
1 package # hide from PAUSE
2     DBIx::Class::Relationship::BelongsTo;
3
4 # Documentation for these methods can be found in
5 # DBIx::Class::Relationship
6
7 use strict;
8 use warnings;
9
10 our %_pod_inherit_config = 
11   (
12    class_map => { 'DBIx::Class::Relationship::BelongsTo' => 'DBIx::Class::Relationship' }
13   );
14
15 sub belongs_to {
16   my ($class, $rel, $f_class, $cond, $attrs) = @_;
17
18   # assume a foreign key contraint unless defined otherwise
19   $attrs->{is_foreign_key_constraint} = 1 
20     if not exists $attrs->{is_foreign_key_constraint};
21   $attrs->{undef_on_null_fk} = 1
22     if not exists $attrs->{undef_on_null_fk};
23
24   # no join condition or just a column name
25   if (!ref $cond) {
26     $class->ensure_class_loaded($f_class);
27     my %f_primaries = map { $_ => 1 } eval { $f_class->_pri_cols };
28     $class->throw_exception(
29       "Can't infer join condition for ${rel} on ${class}: $@"
30     ) if $@;
31
32     my ($pri, $too_many) = keys %f_primaries;
33     $class->throw_exception(
34       "Can't infer join condition for ${rel} on ${class}; ".
35       "${f_class} has multiple primary keys"
36     ) if $too_many;
37
38     my $fk = defined $cond ? $cond : $rel;
39     $class->throw_exception(
40       "Can't infer join condition for ${rel} on ${class}; ".
41       "$fk is not a column of $class"
42     ) unless $class->has_column($fk);
43
44     my $acc_type = $class->has_column($rel) ? 'filter' : 'single';
45     $class->add_relationship($rel, $f_class,
46       { "foreign.${pri}" => "self.${fk}" },
47       { accessor => $acc_type, %{$attrs || {}} }
48     );
49   }
50   # explicit join condition
51   elsif (ref $cond) {
52     if (ref $cond eq 'HASH') { # ARRAY is also valid
53       my $cond_rel;
54       for (keys %$cond) {
55         if (m/\./) { # Explicit join condition
56           $cond_rel = $cond;
57           last;
58         }
59         $cond_rel->{"foreign.$_"} = "self.".$cond->{$_};
60       }
61       $cond = $cond_rel;
62     }
63     my $acc_type = ((ref $cond eq 'HASH')
64                        && keys %$cond == 1
65                        && $class->has_column($rel))
66                      ? 'filter'
67                      : 'single';
68     $class->add_relationship($rel, $f_class,
69       $cond,
70       { accessor => $acc_type, %{$attrs || {}} }
71     );
72   }
73   else {
74     $class->throw_exception(
75       'third argument for belongs_to must be undef, a column name, '.
76       'or a join condition'
77     );
78   }
79   return 1;
80 }
81
82 # Attempt to remove the POD so it (maybe) falls off the indexer
83
84 #=head1 AUTHORS
85 #
86 #Alexander Hartmaier <Alexander.Hartmaier@t-systems.at>
87 #
88 #Matt S. Trout <mst@shadowcatsystems.co.uk>
89 #
90 #=cut
91
92 1;