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