Fixing many-to-many relationships with parent tables

Refactored generated many to many code

Author: moufmouf

src/AbstractTDBMObject.php

@@ -320,7 +320,7 @@ protected function addRelationship(string $pivotTableName, AbstractTDBMObject $r
      */
     protected function hasRelationship(string $pathKey, AbstractTDBMObject $remoteBean): bool
     {
-        $pathModel = $this->_getRelationshipModelFromKey($pathKey);
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
         $storage = $this->retrieveRelationshipsStorage($pathModel);
 
         if ($storage->contains($remoteBean)) {
@@ -356,7 +356,7 @@ public function _removeRelationship(string $pivotTableName, AbstractTDBMObject $
      */
     protected function setRelationships(string $pathKey, array $remoteBeans): void
     {
-        $pathModel = $this->_getRelationshipModelFromKey($pathKey);
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
         $pivotTableName = $pathModel->getPivotName();
         $storage = $this->retrieveRelationshipsStorage($pathModel);
 
@@ -414,7 +414,7 @@ private function retrieveRelationshipsStorage(ManyToManyRelationshipPathDescript
      */
     public function _getRelationships(string $pathKey): array
     {
-        $pathModel = $this->_getRelationshipModelFromKey($pathKey);
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
         return $this->_getRelationshipsFromModel($pathModel);
     }
 
@@ -661,21 +661,16 @@ protected static function getForeignKeys(string $tableName): ForeignKeys
         return new ForeignKeys([]);
     }
 
-    /**
-     * @return mixed[]
-     */
-    abstract protected function _getRelationshipPathArray(): array;
-
-    public function _getRelationshipModelFromKey(string $pathKey): ManyToManyRelationshipPathDescriptor
+    public function _getManyToManyRelationshipDescriptor(string $pathKey): ManyToManyRelationshipPathDescriptor
     {
-        return ManyToManyRelationshipPathDescriptor::createFromModelArray($this->_getRelationshipPathArray()[$pathKey]);
+        throw new TDBMException('Could not find many to many relationship descriptor key for "'.$pathKey.'"');
     }
 
     /**
      * @return string[]
      */
-    public function _getRelationshipsPathKeys(): array
+    public function _getManyToManyRelationshipDescriptorKeys(): array
     {
-        return array_keys($this->_getRelationshipPathArray());
+        return [];
     }
 }

src/TDBMService.php

@@ -313,8 +313,8 @@ private function deleteManyToManyRelationships(AbstractTDBMObject $object): void
     {
         foreach ($object->_getDbRows() as $tableName => $dbRow) {
             $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
-            foreach ($object->_getRelationshipsPathKeys() as $pathKey) {
-                $pathModel = $object->_getRelationshipModelFromKey($pathKey);
+            foreach ($object->_getManyToManyRelationshipDescriptorKeys() as $pathKey) {
+                $pathModel = $object->_getManyToManyRelationshipDescriptor($pathKey);
                 $remoteBeans = $object->_getRelationshipsFromModel($pathModel);
                 foreach ($remoteBeans as $remoteBean) {
                     $object->_removeRelationship($pathModel->getPivotName(), $remoteBean);

src/Utils/BeanDescriptor.php

@@ -30,6 +30,8 @@
 use TheCodingMachine\TDBM\Utils\Annotation\AddInterface;
 use Zend\Code\Generator\AbstractMemberGenerator;
 use Zend\Code\Generator\ClassGenerator;
+use Zend\Code\Generator\DocBlock\Tag;
+use Zend\Code\Generator\DocBlock\Tag\GenericTag;
 use Zend\Code\Generator\DocBlock\Tag\ParamTag;
 use Zend\Code\Generator\DocBlock\Tag\ReturnTag;
 use Zend\Code\Generator\DocBlock\Tag\ThrowsTag;
@@ -39,6 +41,8 @@
 use Zend\Code\Generator\MethodGenerator;
 use Zend\Code\Generator\ParameterGenerator;
 use Zend\Code\Generator\PropertyGenerator;
+use function implode;
+use function var_export;
 
 /**
  * This class represents a bean.
@@ -575,7 +579,7 @@ public function generatePhpCode(): ?FileGenerator
             }
         }
 
-        $relationshipsPathModel = [];
+        $pivotTableMethodsDescriptors = [];
         foreach ($this->getMethodDescriptors() as $methodDescriptor) {
             if ($methodDescriptor instanceof DirectForeignKeyMethodDescriptor) {
                 [$method] = $methodDescriptor->getCode();
@@ -584,8 +588,7 @@ public function generatePhpCode(): ?FileGenerator
                     $class->addMethodFromGenerator($method);
                 }
             } elseif ($methodDescriptor instanceof PivotTableMethodsDescriptor) {
-                [$index, $value] = $methodDescriptor->getRelationshipPathDescriptor();
-                $relationshipsPathModel[$index] = $value;
+                $pivotTableMethodsDescriptors[] = $methodDescriptor;
                 [ $getter, $adder, $remover, $has, $setter ] = $methodDescriptor->getCode();
                 $methods = $this->codeGeneratorListener->onBaseBeanManyToManyGenerated($getter, $adder, $remover, $has, $setter, $methodDescriptor, $this, $this->configuration, $class);
                 foreach ($methods as $method) {
@@ -598,8 +601,14 @@ public function generatePhpCode(): ?FileGenerator
             }
         }
 
-        $pathCode = $this->generatePathModelCode($relationshipsPathModel);
-        $class->addMethodFromGenerator($pathCode);
+        $manyToManyRelationshipCode = $this->generateGetManyToManyRelationshipDescriptorCode($pivotTableMethodsDescriptors);
+        if ($manyToManyRelationshipCode !== null) {
+            $class->addMethodFromGenerator($manyToManyRelationshipCode);
+        }
+        $manyToManyRelationshipKeysCode = $this->generateGetManyToManyRelationshipDescriptorKeysCode($pivotTableMethodsDescriptors);
+        if ($manyToManyRelationshipKeysCode !== null) {
+            $class->addMethodFromGenerator($manyToManyRelationshipKeysCode);
+        }
 
         $foreignKeysProperty = new PropertyGenerator('foreignKeys');
         $foreignKeysProperty->setStatic(true);
@@ -1327,17 +1336,64 @@ private function generateOnDeleteCode(): ?MethodGenerator
     }
 
     /**
-     * @param mixed[] $data
+     * @param PivotTableMethodsDescriptor[] $pivotTableMethodsDescriptors
      * @return MethodGenerator
      */
-    private function generatePathModelCode(array $data): MethodGenerator
+    private function generateGetManyToManyRelationshipDescriptorCode(array $pivotTableMethodsDescriptors): ?MethodGenerator
     {
-        $method = new MethodGenerator('_getRelationshipPathArray');
-        $method->setVisibility(AbstractMemberGenerator::VISIBILITY_PROTECTED);
-        $method->setReturnType('array');
+        if (empty($pivotTableMethodsDescriptors)) {
+            return null;
+        }
+
+        $method = new MethodGenerator('_getManyToManyRelationshipDescriptor');
+        $method->setVisibility(AbstractMemberGenerator::VISIBILITY_PUBLIC);
         $method->setDocBlock('Get the paths used for many to many relationships methods.');
-        $method->getDocBlock()->setTag(new ReturnTag(['mixed[]']));
-        $method->setBody('return ' . $this->psr2VarExport($data).';');
+        $method->getDocBlock()->setTag(new GenericTag('internal'));
+        $method->setReturnType(ManyToManyRelationshipPathDescriptor::class);
+
+        $parameter = new ParameterGenerator('pathKey');
+        $parameter->setType('string');
+        $method->setParameter($parameter);
+
+        $code = 'switch ($pathKey) {'."\n";
+        foreach ($pivotTableMethodsDescriptors as $pivotTableMethodsDescriptor) {
+            $code .= '    case '.var_export($pivotTableMethodsDescriptor->getManyToManyRelationshipKey(), true).":\n";
+            $code .= '        return '.$pivotTableMethodsDescriptor->getManyToManyRelationshipInstantiationCode().";\n";
+        }
+        $code .= "    default:\n";
+        $code .= "        return parent::_getManyToManyRelationshipDescriptor(\$pathKey);\n";
+        $code .= "}\n";
+
+        $method->setBody($code);
+
+        return $method;
+    }
+
+    /**
+     * @param PivotTableMethodsDescriptor[] $pivotTableMethodsDescriptors
+     * @return MethodGenerator
+     */
+    private function generateGetManyToManyRelationshipDescriptorKeysCode(array $pivotTableMethodsDescriptors): ?MethodGenerator
+    {
+        if (empty($pivotTableMethodsDescriptors)) {
+            return null;
+        }
+
+        $method = new MethodGenerator('_getManyToManyRelationshipDescriptorKeys');
+        $method->setVisibility(AbstractMemberGenerator::VISIBILITY_PUBLIC);
+        $method->setReturnType('array');
+        $method->setDocBlock('Returns the list of keys supported for many to many relationships');
+        $method->getDocBlock()->setTag(new GenericTag('internal'));
+        $method->getDocBlock()->setTag(new ReturnTag('string[]'));
+
+        $keys = [];
+        foreach ($pivotTableMethodsDescriptors as $pivotTableMethodsDescriptor) {
+            $keys[] = var_export($pivotTableMethodsDescriptor->getManyToManyRelationshipKey(), true);
+        }
+
+        $code = 'return array_merge(parent::_getManyToManyRelationshipDescriptorKeys(), ['.implode(', ', $keys).']);';
+
+        $method->setBody($code);
 
         return $method;
     }

src/Utils/ManyToManyRelationshipPathDescriptor.php

@@ -4,15 +4,41 @@
 
 
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
+use function var_export;
 
 class ManyToManyRelationshipPathDescriptor
 {
+
+    /**
+     * @var string
+     */
     private $targetTable;
+    /**
+     * @var string
+     */
     private $pivotTable;
+    /**
+     * @var array
+     */
     private $joinForeignKeys;
+    /**
+     * @var array
+     */
     private $joinLocalKeys;
+    /**
+     * @var array
+     */
     private $whereKeys;
 
+    public function __construct(string $targetTable, string $pivotTable, array $joinForeignKeys, array $joinLocalKeys, array $whereKeys)
+    {
+        $this->targetTable = $targetTable;
+        $this->pivotTable = $pivotTable;
+        $this->joinForeignKeys = $joinForeignKeys;
+        $this->joinLocalKeys = $joinLocalKeys;
+        $this->whereKeys = $whereKeys;
+    }
+
     /**
      * @return mixed[]
      */
@@ -42,10 +68,6 @@ public static function createFromModelArray(array $modelArray): self
         return $obj;
     }
 
-    private function __construct()
-    {
-    }
-
     public function getPivotName(): string
     {
         return $this->pivotTable;

src/Utils/PivotTableMethodsDescriptor.php

@@ -6,13 +6,15 @@
 use Doctrine\DBAL\Schema\Column;
 use Doctrine\DBAL\Schema\ForeignKeyConstraint;
 use Doctrine\DBAL\Schema\Table;
+use function implode;
 use function sprintf;
 use TheCodingMachine\TDBM\Utils\Annotation\AnnotationParser;
 use TheCodingMachine\TDBM\Utils\Annotation\Annotations;
 use Zend\Code\Generator\DocBlock\Tag\ParamTag;
 use Zend\Code\Generator\DocBlock\Tag\ReturnTag;
 use Zend\Code\Generator\MethodGenerator;
 use Zend\Code\Generator\ParameterGenerator;
+use function var_export;
 
 class PivotTableMethodsDescriptor implements MethodDescriptorInterface
 {
@@ -148,41 +150,32 @@ private function isAutoPivot(): bool
         return $this->localFk->getForeignTableName() === $this->remoteFk->getForeignTableName();
     }
 
+    public function getManyToManyRelationshipInstantiationCode(): string
+    {
+        return 'new \TheCodingMachine\TDBM\Utils\ManyToManyRelationshipPathDescriptor('.var_export($this->remoteFk->getForeignTableName(), true).
+            ', '.var_export($this->remoteFk->getLocalTableName(), true).
+            ', '.$this->getArrayInlineCode($this->remoteFk->getUnquotedForeignColumns()).
+            ', '.$this->getArrayInlineCode($this->remoteFk->getUnquotedLocalColumns()).
+            ', '.$this->getArrayInlineCode($this->localFk->getUnquotedLocalColumns()).
+            ')';
+    }
 
     /**
-     * return the list of couples tableName.columnName needed for the sql query
+     * @param string[] $values
+     * @return string
      */
-    private function getAutoPivotFrom(): string
+    private function getArrayInlineCode(array $values): string
     {
-        $mainTable = $this->remoteFk->getForeignTableName();
-        $pivotTable = $this->remoteFk->getLocalTableName();
-
-        $join = [];
-        foreach ($this->remoteFk->getUnquotedForeignColumns() as $key => $column) {
-            $join[] = $mainTable.'.'.$column.' = pivot.'.$this->remoteFk->getUnquotedLocalColumns()[$key];
+        $items = [];
+        foreach ($values as $value) {
+            $items[] = var_export($value, true);
         }
-
-        return $mainTable.' JOIN '.$pivotTable.' pivot ON '.implode(' AND ', $join);
-
-    }
-    private function getAutoPivotWhere(): string
-    {
-        $paramList = [];
-        foreach ($this->localFk->getUnquotedLocalColumns() as $key => $column) {
-            $paramList[] = ' pivot.'.$column." = :param$key";
-        }
-        return implode(" AND ", $paramList);
-
+        return '['.implode(', ', $items).']';
     }
 
-    /**
-     * Return
-     *
-     * @return mixed[]
-     */
-    public function getRelationshipPathDescriptor(): array
+    public function getManyToManyRelationshipKey(): string
     {
-        return [$this->pathKey, $this->pathModel];
+        return $this->remoteFk->getLocalTableName().".".implode("__", $this->localFk->getUnquotedLocalColumns());
     }
 
     /**