X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship%2FBase.pm;h=f31e6850971ce6e3b1013e8438b7db5b227ee9ff;hb=3d618782661512ffb7b263a222e183808170b88a;hp=b193aa06e308a2a6a97f93f82c6dd605d774dd41;hpb=8a71e6ae9971f5582a85712d0e64fb865cc4581d;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index b193aa0..f31e685 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -3,6 +3,7 @@ package DBIx::Class::Relationship::Base; use strict; use warnings; +use Scalar::Util (); use base qw/DBIx::Class/; =head1 NAME @@ -66,7 +67,7 @@ Each key-value pair provided in a hashref will be used as Ced conditions. To add an Ced condition, use an arrayref of hashrefs. See the L documentation for more details. -Valid attributes are as follows: +In addition to standard result set attributes, the following attributes are also valid: =over 4 @@ -101,6 +102,13 @@ related object, but you also want the relationship accessor to double as a column accessor). For C accessors, an add_to_* method is also created, which calls C for the relationship. +=item is_foreign_key_constraint + +If you are using L to create SQL for you and you find that it +is creating constraints where it shouldn't, or not creating them where it +should, set this attribute to a true or false value to override the detection +of when to create constraints. + =back =head2 register_relationship @@ -175,7 +183,8 @@ sub related_resultset { =head2 search_related - $rs->search_related('relname', $cond, $attrs); + @objects = $rs->search_related('relname', $cond, $attrs); + $objects_rs = $rs->search_related('relname', $cond, $attrs); Run a search on a related resultset. The search will be restricted to the item or items represented by the L it was called @@ -187,6 +196,19 @@ sub search_related { return shift->related_resultset(shift)->search(@_); } +=head2 search_related_rs + + ( $objects_rs ) = $rs->search_related_rs('relname', $cond, $attrs); + +This method works exactly the same as search_related, except that +it garauntees a restultset, even in list context. + +=cut + +sub search_related_rs { + return shift->related_resultset(shift)->search_rs(@_); +} + =head2 count_related $obj->count_related('relname', $cond, $attrs); @@ -208,9 +230,10 @@ sub count_related { my $new_obj = $obj->new_related('relname', \%col_data); Create a new item of the related foreign class. If called on a -L object, it will magically set any -primary key values into foreign key columns for you. The newly created item -will not be saved into your storage until you call L +L object, it will magically +set any foreign key columns of the new object to the related primary +key columns of the source object for you. The newly created item will +not be saved into your storage until you call L on it. =cut @@ -279,7 +302,8 @@ L for details. sub find_or_create_related { my $self = shift; - return $self->find_related(@_) || $self->create_related(@_); + my $obj = $self->find_related(@_); + return (defined($obj) ? $obj : $self->create_related(@_)); } =head2 update_or_create_related @@ -324,7 +348,7 @@ sub set_from_related { if (defined $f_obj) { my $f_class = $self->result_source->schema->class($rel_obj->{class}); $self->throw_exception( "Object $f_obj isn't a ".$f_class ) - unless $f_obj->isa($f_class); + unless Scalar::Util::blessed($f_obj) and $f_obj->isa($f_class); } $self->set_columns( $self->result_source->resolve_condition( @@ -362,7 +386,78 @@ sub delete_related { return $obj; } -1; +=head2 add_to_$rel + +B, C and 'multi' type +relationships.> + +=over 4 + +=item Arguments: ($foreign_vals | $obj), $link_vals? + +=back + + my $role = $schema->resultset('Role')->find(1); + $actor->add_to_roles($role); + # creates a My::DBIC::Schema::ActorRoles linking table row object + + $actor->add_to_roles({ name => 'lead' }, { salary => 15_000_000 }); + # creates a new My::DBIC::Schema::Role row object and the linking table + # object with an extra column in the link + +Adds a linking table object for C<$obj> or C<$foreign_vals>. If the first +argument is a hash reference, the related object is created first with the +column values in the hash. If an object reference is given, just the linking +table object is created. In either case, any additional column values for the +linking table object can be specified in C<$link_vals>. + +=head2 set_$rel + +B relationships.> + +=over 4 + +=item Arguments: (\@hashrefs | \@objs) + +=back + + my $actor = $schema->resultset('Actor')->find(1); + my @roles = $schema->resultset('Role')->search({ role => + { '-in' -> ['Fred', 'Barney'] } } ); + + $actor->set_roles(\@roles); + # Replaces all of $actor's previous roles with the two named + +Replace all the related objects with the given reference to a list of +objects. This does a C B to remove the +association between the current object and all related objects, then calls +C repeatedly to link all the new objects. + +Note that this means that this method will B delete any objects in the +table on the right side of the relation, merely that it will delete the link +between them. + +Due to a mistake in the original implementation of this method, it will also +accept a list of objects or hash references. This is B and will be +removed in a future version. + +=head2 remove_from_$rel + +B relationships.> + +=over 4 + +=item Arguments: $obj + +=back + + my $role = $schema->resultset('Role')->find(1); + $actor->remove_from_roles($role); + # removes $role's My::DBIC::Schema::ActorRoles linking table row object + +Removes the link between the current object and the related object. Note that +the related object itself won't be deleted unless you call ->delete() on +it. This method just removes the link between the two objects. =head1 AUTHORS @@ -374,3 +469,4 @@ You may distribute this code under the same terms as Perl itself. =cut +1;