Add foreign_resultobj to the customrel signature

[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Relationship / Base.pm

diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm
index c39755a..e11263f 100644 (file)
--- a/lib/DBIx/Class/Relationship/Base.pm
+++ b/lib/DBIx/Class/Relationship/Base.pm
@@ -38,11 +38,11 @@ methods, for predefined ones, look in L<DBIx::Class::Relationship>.
 
 =over 4
 
-=item Arguments: 'relname', 'Foreign::Class', $condition, $attrs
+=item Arguments: $rel_name, $foreign_class, $condition, $attrs
 
 =back
 
-  __PACKAGE__->add_relationship('relname',
+  __PACKAGE__->add_relationship('rel_name',
                                 'Foreign::Class',
                                 $condition, $attrs);
 
@@ -238,7 +238,10 @@ metadata. Currently the supplied coderef is executed as:
     self_alias        => The alias of the invoking resultset
     foreign_alias     => The alias of the to-be-joined resultset (does *NOT* always match rel_name)
 
+    # only one of these (or none at all) will ever be supplied to aid in the
+    # construction of a join-free condition
     self_resultobj    => The invocant object itself in case of a $resultobj->$rel_name() call
+    foreign_resultobj => The related object in case of $resultobj->set_from_related($rel_name, $foreign_resultobj)
 
     # deprecated inconsistent names, will be forever available for legacy code
     self_rowobj       => Old deprecated slot for self_resultobj