X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship%2FBase.pm;h=6c6475417b227dac331c8db5e5f9e38d31b0ef09;hb=97c96475;hp=53dc14cd143a8e1f2f8c204ab2530f0f5b25b724;hpb=52b420dd006f55aced42c669f49182890b8826ea;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index 53dc14c..6c64754 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -3,9 +3,11 @@ package DBIx::Class::Relationship::Base; use strict; use warnings; -use Scalar::Util (); use base qw/DBIx::Class/; + +use Scalar::Util qw/weaken blessed/; use Try::Tiny; +use namespace::clean; =head1 NAME @@ -91,7 +93,11 @@ Explicitly specifies the type of join to use in the relationship. Any SQL join type is valid, e.g. C or C. It will be placed in the SQL command immediately before C. -=item proxy +=item proxy =E $column | \@columns | \%column + +=over 4 + +=item \@columns An arrayref containing a list of accessors in the foreign class to create in the main class. If, for example, you do the following: @@ -107,6 +113,25 @@ Then, assuming MyDB::Schema::LinerNotes has an accessor named notes, you can do: $cd->notes('Notes go here'); # set notes -- LinerNotes object is # created if it doesn't exist +=item \%column + +A hashref where each key is the accessor you want installed in the main class, +and its value is the name of the original in the fireign class. + + MyDB::Schema::Track->belongs_to( cd => 'DBICTest::Schema::CD', 'cd', { + proxy => { cd_title => 'title' }, + }); + +This will create an accessor named C on the C<$track> row object. + +=back + +NOTE: you can pass a nested struct too, for example: + + MyDB::Schema::Track->belongs_to( cd => 'DBICTest::Schema::CD', 'cd', { + proxy => [ 'year', { cd_title => 'title' } ], + }); + =item accessor Specifies the type of accessor that should be created for the relationship. @@ -119,7 +144,7 @@ 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 +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. @@ -127,8 +152,8 @@ of when to create constraints. If C is true on a C relationship for an object, then when you copy the object all the related objects will -be copied too. To turn this behaviour off, pass C<< cascade_copy => 0 >> -in the C<$attr> hashref. +be copied too. To turn this behaviour off, pass C<< cascade_copy => 0 >> +in the C<$attr> hashref. The behaviour defaults to C<< cascade_copy => 1 >> for C relationships. @@ -137,7 +162,7 @@ relationships. By default, DBIx::Class cascades deletes across C, C and C relationships. You can disable this -behaviour on a per-relationship basis by supplying +behaviour on a per-relationship basis by supplying C<< cascade_delete => 0 >> in the relationship attributes. The cascaded operations are performed after the requested delete, @@ -160,14 +185,14 @@ you must arrange to do this yourself. =item on_delete / on_update If you are using L to create SQL for you, you can use these -attributes to explicitly set the desired C or C constraint -type. If not supplied the SQLT parser will attempt to infer the constraint type by +attributes to explicitly set the desired C or C constraint +type. If not supplied the SQLT parser will attempt to infer the constraint type by interrogating the attributes of the B relationship. For any 'multi' -relationship with C<< cascade_delete => 1 >>, the corresponding belongs_to -relationship will be created with an C constraint. For any +relationship with C<< cascade_delete => 1 >>, the corresponding belongs_to +relationship will be created with an C constraint. For any relationship bearing C<< cascade_copy => 1 >> the resulting belongs_to constraint will be C. If you wish to disable this autodetection, and just -use the RDBMS' default constraint type, pass C<< on_delete => undef >> or +use the RDBMS' default constraint type, pass C<< on_delete => undef >> or C<< on_delete => '' >>, and the same for C respectively. =item is_deferrable @@ -254,10 +279,10 @@ sub related_resultset { foreach my $rev_rel (keys %$reverse) { if ($reverse->{$rev_rel}{attrs}{accessor} && $reverse->{$rev_rel}{attrs}{accessor} eq 'multi') { $attrs->{related_objects}{$rev_rel} = [ $self ]; - Scalar::Util::weaken($attrs->{related_object}{$rev_rel}[0]); + weaken $attrs->{related_object}{$rev_rel}[0]; } else { $attrs->{related_objects}{$rev_rel} = $self; - Scalar::Util::weaken($attrs->{related_object}{$rev_rel}); + weaken $attrs->{related_object}{$rev_rel}; } } } @@ -305,7 +330,7 @@ sub search_related { ( $objects_rs ) = $rs->search_related_rs('relname', $cond, $attrs); -This method works exactly the same as search_related, except that +This method works exactly the same as search_related, except that it guarantees a resultset, even in list context. =cut @@ -335,9 +360,9 @@ 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 foreign key columns of the new object to the related primary -key columns of the source object for you. The newly created item will +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. @@ -458,7 +483,7 @@ sub set_from_related { if (defined $f_obj) { my $f_class = $rel_info->{class}; $self->throw_exception( "Object $f_obj isn't a ".$f_class ) - unless Scalar::Util::blessed($f_obj) and $f_obj->isa($f_class); + unless blessed $f_obj and $f_obj->isa($f_class); } $self->set_columns( $self->result_source->_resolve_condition( @@ -532,7 +557,7 @@ B relationships.> =back my $actor = $schema->resultset('Actor')->find(1); - my @roles = $schema->resultset('Role')->search({ role => + my @roles = $schema->resultset('Role')->search({ role => { '-in' => ['Fred', 'Barney'] } } ); $actor->set_roles(\@roles);