X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship.pm;h=cdb35811c573d9a5c30358e064e3de077c05fd1c;hb=9ce9ec1036c3a67b4087b3f4a90bca09463c1e03;hp=dce00365173ae799bb22883e859263cbea55aa48;hpb=503536d5b216b4d85ed3f5420f3db93d4c033d86;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship.pm b/lib/DBIx/Class/Relationship.pm index dce0036..cdb3581 100644 --- a/lib/DBIx/Class/Relationship.pm +++ b/lib/DBIx/Class/Relationship.pm @@ -3,20 +3,16 @@ package DBIx::Class::Relationship; use strict; use warnings; -use base qw/DBIx::Class Class::Data::Inheritable/; +use base qw/DBIx::Class/; __PACKAGE__->load_own_components(qw/ - HasMany - HasOne - BelongsTo + Helpers Accessor CascadeActions ProxyMethods Base /); -__PACKAGE__->mk_classdata('_relationships', { } ); - =head1 NAME DBIx::Class::Relationship - Inter-table relationships @@ -26,62 +22,90 @@ DBIx::Class::Relationship - Inter-table relationships =head1 DESCRIPTION This class handles relationships between the tables in your database -model. It allows your to set up relationships, and to perform joins -on searches. +model. It allows you to set up relationships and perform joins on them. -This POD details only the convenience methods for setting up standard -relationship types. For more information see ::Relationship::Base +Only the helper methods for setting up standard relationship types +are documented here. For the basic, lower-level methods, see +L. =head1 METHODS -All convenience methods take a signature of the following format - +All helper methods take the following arguments: + + __PACKAGE__>$method_name('relname', 'Foreign::Class', $cond, $attrs); + +Both C<$cond> and C<$attrs> are optional. Pass C for C<$cond> if +you want to use the default value for it, but still want to set C<$attrs>. +See L for a list of valid attributes. - __PACKAGE__>method_name('relname', 'Foreign::Class', $join?, $attrs?); +=head2 belongs_to + # in a Bar class (where Foo has many Bars) + __PACKAGE__->belongs_to(foo => Foo); + my $f_obj = $obj->foo; + $obj->foo($new_f_obj); +Creates a relationship where the calling class stores the foreign class's +primary key in one (or more) of its columns. If $cond is a column name +instead of a join condition hash, that is used as the name of the column +holding the foreign key. If $cond is not given, the relname is used as +the column name. -=over 4 +NOTE: If you are used to L relationships, this is the equivalent +of C. -=item has_one +=head2 has_many - my $f_obj = $obj->relname; + # in a Foo class (where Foo has many Bars) + __PACKAGE__->has_many(bar => Bar, 'foo'); + my $f_resultset = $obj->foo; + my $f_resultset = $obj->foo({ name => { LIKE => '%macaroni%' }, { prefetch => [qw/bar/] }); + my @f_obj = $obj->foo; -Creates a one-one relationship with another class; defaults to PK-PK for -the join condition unless a condition is specified. + $obj->add_to_foo(\%col_data); -=item might_have +Creates a one-to-many relationship, where the corresponding elements of the +foreign class store the calling class's primary key in one (or more) of its +columns. You should pass the name of the column in the foreign class as the +$cond argument, or specify a complete join condition. - my $f_obj = $obj->relname; +If you delete an object in a class with a C relationship, all +related objects will be deleted as well. However, any database-level +cascade or restrict will take precedence. -Creates an optional one-one relationship with another class; defaults to PK-PK -for the join condition unless a condition is specified. +=head2 might_have -=item has_many + __PACKAGE__->might_have(baz => Baz); + my $f_obj = $obj->baz; # to get the baz object - my @f_obj = $obj->relname($cond?, $attrs?); - my $f_result_set = $obj->relname($cond?, $attrs?); +Creates an optional one-to-one relationship with a class, where the foreign class +stores our primary key in one of its columns. Defaults to the primary key of the +foreign class unless $cond specifies a column or join condition. - $obj->add_to_relname(\%col_data); +If you update or delete an object in a class with a C relationship, +the related object will be updated or deleted as well. Any database-level update +or delete constraints will override this behavior. -Creates a one-many relationship with another class; +=head2 has_one -=item belongs_to + __PACKAGE__->has_one(gorch => Gorch); + my $f_obj = $obj->gorch; - my $f_obj = $obj->relname; +Creates a one-to-one relationship with another class. This is just like C, +except the implication is that the other object is always present. The only different +between C and C is that C uses an (ordinary) inner join, +whereas C uses a left join. - $obj->relname($new_f_obj); -Creates a relationship where we store the foreign class' PK; if $join is a -column name instead of a condition that is assumed to be the FK, if not -has_many assumes the FK is the relname is that is a column on the current -class. +=head2 many_to_many + + __PACKAGE__->many_to_many( 'accessorname' => 'a_to_b', 'table_b' ); + my @f_objs = $obj_a->accessorname; =cut 1; -=back - =head1 AUTHORS Matt S. Trout