X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship%2FManyToMany.pm;h=0c31ebba9ae8a17e916ec89b2658884a57552e14;hb=d46eac43287ebe244e4f622fb77fa2efa16402a9;hp=65eab45418f60bc749e02bdce3fd076ff00fd706;hpb=7141bdfcd7f155c22d3e2044bf7f69663b67c801;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship/ManyToMany.pm b/lib/DBIx/Class/Relationship/ManyToMany.pm index 65eab45..0c31ebb 100644 --- a/lib/DBIx/Class/Relationship/ManyToMany.pm +++ b/lib/DBIx/Class/Relationship/ManyToMany.pm @@ -4,80 +4,203 @@ package # hide from PAUSE use strict; use warnings; +use DBIx::Class::Carp; +use DBIx::Class::_Util qw( quote_sub perlstring ); + +# FIXME - this souldn't be needed +my $cu; +BEGIN { $cu = \&carp_unique } + +use namespace::clean; + +our %_pod_inherit_config = + ( + class_map => { 'DBIx::Class::Relationship::ManyToMany' => 'DBIx::Class::Relationship' } + ); + sub many_to_many { my ($class, $meth, $rel, $f_rel, $rel_attrs) = @_; - { - no strict 'refs'; - no warnings 'redefine'; + + $class->throw_exception( + "missing relation in many-to-many" + ) unless $rel; + + $class->throw_exception( + "missing foreign relation in many-to-many" + ) unless $f_rel; my $add_meth = "add_to_${meth}"; my $remove_meth = "remove_from_${meth}"; my $set_meth = "set_${meth}"; + my $rs_meth = "${meth}_rs"; - $rel_attrs->{alias} ||= $f_rel; + for ($add_meth, $remove_meth, $set_meth, $rs_meth) { + if ( $class->can ($_) ) { + carp (<<"EOW") unless $ENV{DBIC_OVERWRITE_HELPER_METHODS_OK}; - *{"${class}::${meth}"} = sub { - my $self = shift; - my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}; - my @args = ($f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs }); - $self->search_related($rel)->search_related( - $f_rel, @_ > 0 ? @_ : undef, { %{$rel_attrs||{}}, %$attrs } - ); +*************************************************************************** +The many-to-many relationship '$meth' is trying to create a utility method +called $_. +This will completely overwrite one such already existing method on class +$class. + +You almost certainly want to rename your method or the many-to-many +relationship, as the functionality of the original method will not be +accessible anymore. + +To disable this warning set to a true value the environment variable +DBIC_OVERWRITE_HELPER_METHODS_OK + +*************************************************************************** +EOW + } + } + + quote_sub "${class}::${meth}", sprintf( <<'EOC', $rs_meth ); + + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and DBIx::Class::_Util::fail_on_internal_call; + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_WANTARRAY and my $sog = DBIx::Class::_Util::fail_on_internal_wantarray; + + my $rs = shift->%s( @_ ); + + wantarray ? $rs->all : $rs; +EOC + + + my $qsub_attrs = { + '$rel_attrs' => \{ alias => $f_rel, %{ $rel_attrs||{} } }, + '$carp_unique' => \$cu, }; - *{"${class}::${add_meth}"} = sub { - my $self = shift; - @_ > 0 or $self->throw_exception( - "${add_meth} needs an object or hashref" + + quote_sub "${class}::${rs_meth}", sprintf( <<'EOC', map { perlstring $_ } ( "${class}::${meth}", $rel, $f_rel ) ), $qsub_attrs; + + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS + and + # allow nested calls from our ->many_to_many, see comment below + ( (CORE::caller(1))[3] ne %s ) + and + DBIx::Class::_Util::fail_on_internal_call; + + # this little horror is there replicating a deprecation from + # within search_rs() itself + shift->related_resultset( %s ) + ->related_resultset( %s ) + ->search_rs ( + undef, + ( @_ > 1 and ref $_[-1] eq 'HASH' ) + ? { %%$rel_attrs, %%{ pop @_ } } + : $rel_attrs + )->search_rs(@_) + ; +EOC + + + quote_sub "${class}::${add_meth}", sprintf( <<'EOC', $add_meth, $rel, $f_rel ), $qsub_attrs; + + ( @_ >= 2 and @_ <= 3 ) or $_[0]->throw_exception( + "'%1$s' expects an object or hashref to link to, and an optional hashref of link data" ); - my $source = $self->result_source; - my $schema = $source->schema; - my $rel_source_name = $source->relationship_info($rel)->{source}; - my $rel_source = $schema->resultset($rel_source_name)->result_source; - my $f_rel_source_name = $rel_source->relationship_info($f_rel)->{source}; - my $f_rel_rs = $schema->resultset($f_rel_source_name)->search({}, $rel_attrs||{}); - - my $obj; - if (ref $_[0]) { - if (ref $_[0] eq 'HASH') { - $obj = $f_rel_rs->create($_[0]); - } else { - $obj = $_[0]; - } - } else { - $obj = $f_rel_rs->create({@_}); + + $_[0]->throw_exception( + "The optional link data supplied to '%1$s' is not a hashref (it was previously ignored)" + ) if $_[2] and ref $_[2] ne 'HASH'; + + my( $self, $far_obj ) = @_; + + my $guard; + + # the API is always expected to return the far object, possibly + # creating it in the process + if( not defined Scalar::Util::blessed( $far_obj ) ) { + + $guard = $self->result_source->schema->storage->txn_scope_guard; + + # reify the hash into an actual object + $far_obj = $self->result_source + ->related_source( q{%2$s} ) + ->related_source( q{%3$s} ) + ->resultset + ->search_rs( undef, $rel_attrs ) + ->find_or_create( $far_obj ); } - my $link_vals = @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}; - my $link = $self->search_related($rel)->new_result({}); - $link->set_from_related($f_rel, $obj); - $link->set_columns($link_vals); + my $link = $self->new_related( + q{%2$s}, + $_[2] || {}, + ); + + $link->set_from_related( q{%3$s}, $far_obj ); + $link->insert(); - }; - *{"${class}::${set_meth}"} = sub { - my $self = shift; - @_ > 0 or $self->throw_exception( - "{$set_meth} needs a list of objects or hashrefs" - ); - $self->search_related($rel, {})->delete; - $self->$add_meth(shift) while (defined $_[0]); - }; + $guard->commit if $guard; + + $far_obj; +EOC + + + quote_sub "${class}::${set_meth}", sprintf( <<'EOC', $set_meth, $add_meth, $rel, $f_rel ), $qsub_attrs; - *{"${class}::${remove_meth}"} = sub { my $self = shift; - @_ > 0 && ref $_[0] ne 'HASH' - or $self->throw_exception("${remove_meth} needs an object"); - my $obj = shift; - my $rel_source = $self->search_related($rel)->result_source; - my $cond = $rel_source->relationship_info($f_rel)->{cond}; - my $link_cond = $rel_source->resolve_condition( - $cond, $obj, $f_rel + + my $set_to = ( ref $_[0] eq 'ARRAY' ) + ? ( shift @_ ) + : do { + $carp_unique->( + "Calling '%1$s' with a list of items to link to is deprecated, use an arrayref instead" + ); + + # gobble up everything from @_ into a new arrayref + [ splice @_ ] + } + ; + + # make sure folks are not invoking a bizarre mix of deprecated and curent syntax + $self->throw_exception( + "'%1$s' expects an arrayref of objects or hashrefs to link to, and an optional hashref of link data" + ) if ( + @_ > 1 + or + ( defined $_[0] and ref $_[0] ne 'HASH' ) ); - $self->search_related($rel, $link_cond)->delete; - }; - } + my $guard; + + # there will only be a single delete() op, unless we have what to set to + $guard = $self->result_source->schema->storage->txn_scope_guard + if @$set_to; + + # if there is a where clause in the attributes, ensure we only delete + # rows that are within the where restriction + $self->related_resultset( q{%3$s} ) + ->search_rs( + ( $rel_attrs->{where} + ? ( $rel_attrs->{where}, { join => q{%4$s} } ) + : () + ) + )->delete; + + # add in the set rel objects + $self->%2$s( + $_, + @_, # at this point @_ is either empty or contains a lone link-data hash + ) for @$set_to; + + $guard->commit if $guard; +EOC + + + quote_sub "${class}::${remove_meth}", sprintf( <<'EOC', $remove_meth, $rel, $f_rel ); + + $_[0]->throw_exception("'%1$s' expects an object") + unless defined Scalar::Util::blessed( $_[1] ); + + $_[0]->related_resultset( q{%2$s} ) + ->search_rs( $_[1]->ident_condition( q{%3$s} ), { join => q{%3$s} } ) + ->delete; +EOC + } 1;