lib/DBIx/Class/Relationship/ManyToMany.pm

   1 package # hide from PAUSE
   2     DBIx::Class::Relationship::ManyToMany;
   3
   4 use strict;
   5 use warnings;
   6
   7 use DBIx::Class::Carp;
   8 use Sub::Name qw/subname/;
   9 use Scalar::Util qw/blessed/;
  10
  11 use namespace::clean;
  12
  13 our %_pod_inherit_config =
  14   (
  15    class_map => { 'DBIx::Class::Relationship::ManyToMany' => 'DBIx::Class::Relationship' }
  16   );
  17
  18 sub many_to_many {
  19   my ($class, $meth, $rel, $f_rel, $rel_attrs) = @_;
  20
  21   $class->throw_exception(
  22     "missing relation in many-to-many"
  23   ) unless $rel;
  24
  25   $class->throw_exception(
  26     "missing foreign relation in many-to-many"
  27   ) unless $f_rel;
  28
  29   {
  30     no strict 'refs';
  31     no warnings 'redefine';
  32
  33     my $add_meth = "add_to_${meth}";
  34     my $remove_meth = "remove_from_${meth}";
  35     my $set_meth = "set_${meth}";
  36     my $rs_meth = "${meth}_rs";
  37
  38     for ($add_meth, $remove_meth, $set_meth, $rs_meth) {
  39       if ( $class->can ($_) ) {
  40         carp (<<"EOW") unless $ENV{DBIC_OVERWRITE_HELPER_METHODS_OK};
  41
  42 ***************************************************************************
  43 The many-to-many relationship '$meth' is trying to create a utility method
  44 called $_.
  45 This will completely overwrite one such already existing method on class
  46 $class.
  47
  48 You almost certainly want to rename your method or the many-to-many
  49 relationship, as the functionality of the original method will not be
  50 accessible anymore.
  51
  52 To disable this warning set to a true value the environment variable
  53 DBIC_OVERWRITE_HELPER_METHODS_OK
  54
  55 ***************************************************************************
  56 EOW
  57       }
  58     }
  59
  60     $rel_attrs->{alias} ||= $f_rel;
  61
  62     my $rs_meth_name = join '::', $class, $rs_meth;
  63     *$rs_meth_name = subname $rs_meth_name, sub {
  64       my $self = shift;
  65       my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {};
  66       my @args = ($f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs });
  67       my $rs = $self->search_related($rel)->search_related(
  68         $f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs }
  69       );
  70       return $rs;
  71     };
  72
  73     my $meth_name = join '::', $class, $meth;
  74     *$meth_name = subname $meth_name, sub {
  75       my $self = shift;
  76       my $rs = $self->$rs_meth( @_ );
  77       return (wantarray ? $rs->all : $rs);
  78     };
  79
  80     my $add_meth_name = join '::', $class, $add_meth;
  81     *$add_meth_name = subname $add_meth_name, sub {
  82       my $self = shift;
  83       @_ > 0 or $self->throw_exception(
  84         "${add_meth} needs an object or hashref"
  85       );
  86       my $source = $self->result_source;
  87       my $schema = $source->schema;
  88       my $rel_source_name = $source->relationship_info($rel)->{source};
  89       my $rel_source = $schema->resultset($rel_source_name)->result_source;
  90       my $f_rel_source_name = $rel_source->relationship_info($f_rel)->{source};
  91       my $f_rel_rs = $schema->resultset($f_rel_source_name)->search({}, $rel_attrs||{});
  92
  93       my $obj;
  94       if (ref $_[0]) {
  95         if (ref $_[0] eq 'HASH') {
  96           $obj = $f_rel_rs->find_or_create($_[0]);
  97         } else {
  98           $obj = $_[0];
  99         }
 100       } else {
 101         $obj = $f_rel_rs->find_or_create({@_});
 102       }
 103
 104       my $link_vals = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {};
 105       my $link = $self->search_related($rel)->new_result($link_vals);
 106       $link->set_from_related($f_rel, $obj);
 107       $link->insert();
 108       return $obj;
 109     };
 110
 111     my $set_meth_name = join '::', $class, $set_meth;
 112     *$set_meth_name = subname $set_meth_name, sub {
 113       my $self = shift;
 114       @_ > 0 or $self->throw_exception(
 115         "{$set_meth} needs a list of objects or hashrefs"
 116       );
 117       my @to_set = (ref($_[0]) eq 'ARRAY' ? @{ $_[0] } : @_);
 118       # if there is a where clause in the attributes, ensure we only delete
 119       # rows that are within the where restriction
 120       if ($rel_attrs && $rel_attrs->{where}) {
 121         $self->search_related( $rel, $rel_attrs->{where},{join => $f_rel})->delete;
 122       } else {
 123         $self->search_related( $rel, {} )->delete;
 124       }
 125       # add in the set rel objects
 126       $self->$add_meth($_, ref($_[1]) ? $_[1] : {}) for (@to_set);
 127     };
 128
 129     my $remove_meth_name = join '::', $class, $remove_meth;
 130     *$remove_meth_name = subname $remove_meth_name, sub {
 131       my ($self, $obj) = @_;
 132       $self->throw_exception("${remove_meth} needs an object")
 133         unless blessed ($obj);
 134       my $rel_source = $self->search_related($rel)->result_source;
 135       my $cond = $rel_source->relationship_info($f_rel)->{cond};
 136       my ($link_cond, $crosstable) = $rel_source->_resolve_condition(
 137         $cond, $obj, $f_rel, $f_rel
 138       );
 139
 140       $self->throw_exception(
 141         "Custom relationship '$rel' does not resolve to a join-free condition, "
 142        ."unable to use with the ManyToMany helper '$f_rel'"
 143       ) if $crosstable;
 144
 145       $self->search_related($rel, $link_cond)->delete;
 146     };
 147
 148   }
 149 }
 150
 151 1;