Implemented targetForeignKey in BelongsToMany, this will be used to

control what keys are used to join
cakephp · Jan 9, 2014 · 6fde319 · 6fde319
1 parent cf9ee7b
commit 6fde319
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 2 deletions.
diff --git a/Cake/ORM/Association.php b/Cake/ORM/Association.php
@@ -91,7 +91,7 @@ abstract class Association {
 	protected $_className;
 
 /**
- * The name of the field representing the foreign key to the target table
+ * The name of the field representing the foreign key to the table to load
  *
  * @var string|array
  */

diff --git a/Cake/ORM/Association/BelongsToMany.php b/Cake/ORM/Association/BelongsToMany.php
@@ -107,6 +107,31 @@ class BelongsToMany extends Association {
  */
 	protected $_saveStrategy = self::SAVE_REPLACE;
 
+/**
+ * The name of the field representing the foreign key to the target table
+ *
+ * @var string|array
+ */
+	protected $_targetForeignKey;
+
+/**
+ * Sets the name of the field representing the foreign key to the target table.
+ * If no parameters are passed current field is returned
+ *
+ * @param string $key the key to be used to link both tables together
+ * @return string
+ */
+	public function targetForeignKey($key = null) {
+		if ($key === null) {
+			if ($this->_targetForeignKey === null) {
+				$key = Inflector::singularize($this->target()->alias());
+				$this->_targetForeignKey = Inflector::underscore($key) . '_id';
+			}
+			return $this->_targetForeignKey;
+		}
+		return $this->_targetForeignKey = $key;
+	}
+
 /**
  * Sets the table instance for the junction relation. If no arguments
  * are passed, the current configured table instance is returned
@@ -901,6 +926,9 @@ protected function _options(array $opts) {
 		if (!empty($opts['saveStrategy'])) {
 			$this->saveStrategy($opts['saveStrategy']);
 		}
+		if (!empty($opts['targetForeignKey'])) {
+			$this->targetForeignKey($opts['targetForeignKey']);
+		}
 		$this->_externalOptions($opts);
 	}
 

diff --git a/Cake/ORM/Association/ExternalAssociationTrait.php b/Cake/ORM/Association/ExternalAssociationTrait.php
@@ -45,7 +45,7 @@ public function canBeJoined($options = []) {
 	}
 
 /**
- * Sets the name of the field representing the foreign key to the target table.
+ * Sets the name of the field representing the foreign key to the source table.
  * If no parameters are passed current field is returned
  *
  * @param string $key the key to be used to link both tables together

diff --git a/Test/TestCase/ORM/Association/BelongsToManyTest.php b/Test/TestCase/ORM/Association/BelongsToManyTest.php
@@ -1294,4 +1294,26 @@ public function testSaveOnlyEntities() {
 		$association->save($entity);
 	}
 
+/**
+ * Tests that targetForeignKey() returns the correct configured value
+ *
+ * @return void
+ */
+	public function testTargetForeignKey() {
+		$assoc = new BelongsToMany('Test', [
+			'sourceTable' => $this->article,
+			'targetTable' => $this->tag
+		]);
+		$this->assertEquals('tag_id', $assoc->targetForeignKey());
+		$assoc->targetForeignKey('another_key');
+		$this->assertEquals('another_key', $assoc->targetForeignKey());
+
+		$assoc = new BelongsToMany('Test', [
+			'sourceTable' => $this->article,
+			'targetTable' => $this->tag,
+			'targetForeignKey' => 'foo'
+		]);
+		$this->assertEquals('foo', $assoc->targetForeignKey());
+	}
+
 }