Merge pull request #146 from Kharhamel/autoPivot

WIP: rewrote the way relationships are fetched in bean methods to enable autopivot relationships

Author: moufmouf

src/AbstractTDBMObject.php

@@ -23,6 +23,7 @@
 
 use JsonSerializable;
 use TheCodingMachine\TDBM\Schema\ForeignKeys;
+use TheCodingMachine\TDBM\Utils\ManyToManyRelationshipPathDescriptor;
 
 /**
  * Instances of this class represent a "bean". Usually, a bean is mapped to a row of one table.
@@ -315,14 +316,12 @@ protected function addRelationship(string $pivotTableName, AbstractTDBMObject $r
     /**
      * Returns true if there is a relationship to this bean.
      *
-     * @param string             $pivotTableName
-     * @param AbstractTDBMObject $remoteBean
-     *
      * @return bool
      */
-    protected function hasRelationship(string $pivotTableName, AbstractTDBMObject $remoteBean): bool
+    protected function hasRelationship(string $pathKey, AbstractTDBMObject $remoteBean): bool
     {
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
+        $storage = $this->retrieveRelationshipsStorage($pathModel);
 
         if ($storage->contains($remoteBean)) {
             if ($storage[$remoteBean]['status'] !== 'delete') {
@@ -353,12 +352,13 @@ public function _removeRelationship(string $pivotTableName, AbstractTDBMObject $
      * Sets many to many relationships for this bean.
      * Adds new relationships and removes unused ones.
      *
-     * @param string $pivotTableName
      * @param AbstractTDBMObject[] $remoteBeans
      */
-    protected function setRelationships(string $pivotTableName, array $remoteBeans): void
+    protected function setRelationships(string $pathKey, array $remoteBeans): void
     {
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
+        $pivotTableName = $pathModel->getPivotName();
+        $storage = $this->retrieveRelationshipsStorage($pathModel);
 
         foreach ($storage as $oldRemoteBean) {
             /* @var $oldRemoteBean AbstractTDBMObject */
@@ -379,18 +379,18 @@ protected function setRelationships(string $pivotTableName, array $remoteBeans):
     /**
      * Returns the list of objects linked to this bean via $pivotTableName.
      *
-     * @param string $pivotTableName
-     *
      * @return \SplObjectStorage
      */
-    private function retrieveRelationshipsStorage(string $pivotTableName): \SplObjectStorage
+    private function retrieveRelationshipsStorage(ManyToManyRelationshipPathDescriptor $pathModel): \SplObjectStorage
     {
-        $storage = $this->getRelationshipStorage($pivotTableName);
+        $pivotTableName = $pathModel->getPivotName();
+
+        $storage = $this->getRelationshipStorage($pathModel->getPivotName());
         if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName])) {
             return $storage;
         }
 
-        $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
+        $beans = $this->tdbmService->_getRelatedBeans($pathModel, $this);
         $this->loadedRelationships[$pivotTableName] = true;
 
         foreach ($beans as $bean) {
@@ -410,13 +410,20 @@ private function retrieveRelationshipsStorage(string $pivotTableName): \SplObjec
     /**
      * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
      *
-     * @param string $pivotTableName
-     *
      * @return AbstractTDBMObject[]
      */
-    public function _getRelationships(string $pivotTableName): array
+    public function _getRelationships(string $pathKey): array
+    {
+        $pathModel = $this->_getManyToManyRelationshipDescriptor($pathKey);
+        return $this->_getRelationshipsFromModel($pathModel);
+    }
+
+    /**
+     * @return AbstractTDBMObject[]
+     */
+    public function _getRelationshipsFromModel(ManyToManyRelationshipPathDescriptor $pathModel): array
     {
-        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
+        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pathModel));
     }
 
     /**
@@ -577,25 +584,6 @@ public function _getStatus() : string
      */
     public function __clone()
     {
-        // Let's clone the many to many relationships
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
-            $pivotTableList = array_keys($this->relationships);
-        } else {
-            $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
-        }
-
-        foreach ($pivotTableList as $pivotTable) {
-            $storage = $this->retrieveRelationshipsStorage($pivotTable);
-
-            // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!!
-            /*foreach ($storage as $remoteBean) {
-                $metadata = $storage[$remoteBean];
-
-                $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable);
-                $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]);
-            }*/
-        }
-
         // Let's clone each row
         foreach ($this->dbRows as $key => &$dbRow) {
             $dbRow = clone $dbRow;
@@ -672,4 +660,17 @@ protected static function getForeignKeys(string $tableName): ForeignKeys
     {
         return new ForeignKeys([]);
     }
+
+    public function _getManyToManyRelationshipDescriptor(string $pathKey): ManyToManyRelationshipPathDescriptor
+    {
+        throw new TDBMException('Could not find many to many relationship descriptor key for "'.$pathKey.'"');
+    }
+
+    /**
+     * @return string[]
+     */
+    public function _getManyToManyRelationshipDescriptorKeys(): array
+    {
+        return [];
+    }
 }

src/TDBMService.php

@@ -39,6 +39,7 @@
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsFromSqlQueryFactory;
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsQueryFactory;
 use TheCodingMachine\TDBM\QueryFactory\FindObjectsFromRawSqlQueryFactory;
+use TheCodingMachine\TDBM\Utils\ManyToManyRelationshipPathDescriptor;
 use TheCodingMachine\TDBM\Utils\NamingStrategyInterface;
 use TheCodingMachine\TDBM\Utils\TDBMDaoGenerator;
 use Phlib\Logger\Decorator\LevelFilter;
@@ -311,11 +312,11 @@ public function delete(AbstractTDBMObject $object): void
     private function deleteManyToManyRelationships(AbstractTDBMObject $object): void
     {
         foreach ($object->_getDbRows() as $tableName => $dbRow) {
-            $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
-            foreach ($pivotTables as $pivotTable) {
-                $remoteBeans = $object->_getRelationships($pivotTable);
+            foreach ($object->_getManyToManyRelationshipDescriptorKeys() as $pathKey) {
+                $pathModel = $object->_getManyToManyRelationshipDescriptor($pathKey);
+                $remoteBeans = $object->_getRelationshipsFromModel($pathModel);
                 foreach ($remoteBeans as $remoteBean) {
-                    $object->_removeRelationship($pivotTable, $remoteBean);
+                    $object->_removeRelationship($pathModel->getPivotName(), $remoteBean);
                 }
             }
         }
@@ -1431,26 +1432,11 @@ private function fromCache(string $key, callable $closure)
     }
 
     /**
-     * @param string $pivotTableName
-     * @param AbstractTDBMObject $bean
-     *
      * @return AbstractTDBMObject[]|ResultIterator
      */
-    public function _getRelatedBeans(string $pivotTableName, AbstractTDBMObject $bean): ResultIterator
+    public function _getRelatedBeans(ManyToManyRelationshipPathDescriptor $pathDescriptor, AbstractTDBMObject $bean): ResultIterator
     {
-        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
-        /* @var $localFk ForeignKeyConstraint */
-        /* @var $remoteFk ForeignKeyConstraint */
-        $remoteTable = $remoteFk->getForeignTableName();
-
-        $primaryKeys = $this->getPrimaryKeyValues($bean);
-        $columnNames = array_map(function ($name) use ($pivotTableName) {
-            return $pivotTableName.'.'.$name;
-        }, $localFk->getUnquotedLocalColumns());
-
-        $filter = SafeFunctions::arrayCombine($columnNames, $primaryKeys);
-
-        return $this->findObjects($remoteTable, $filter);
+        return $this->findObjectsFromSql($pathDescriptor->getTargetName(), $pathDescriptor->getPivotFrom(), $pathDescriptor->getPivotWhere(), $pathDescriptor->getPivotParams($this->getPrimaryKeyValues($bean)));
     }
 
     /**
@@ -1480,31 +1466,6 @@ private function getPivotTableForeignKeys(string $pivotTableName, AbstractTDBMOb
         }
     }
 
-    /**
-     * Returns a list of pivot tables linked to $bean.
-     *
-     * @param AbstractTDBMObject $bean
-     *
-     * @return string[]
-     */
-    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean): array
-    {
-        $junctionTables = [];
-        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
-        foreach ($bean->_getDbRows() as $dbRow) {
-            foreach ($allJunctionTables as $table) {
-                // There are exactly 2 FKs since this is a pivot table.
-                $fks = array_values($table->getForeignKeys());
-
-                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
-                    $junctionTables[] = $table->getName();
-                }
-            }
-        }
-
-        return $junctionTables;
-    }
-
     /**
      * Array of types for tables.
      * Key: table name