thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/TDBMObjectStateEnum.php

Indentation +7 added lines, -7 removed lines

@@ -27,11 +27,11 @@
  */
 final class TDBMObjectStateEnum
 {
-    const STATE_DETACHED = 'detached';
-    const STATE_NEW = 'new';
-    const STATE_SAVING = 'saving';
-    const STATE_NOT_LOADED = 'not loaded';
-    const STATE_LOADED = 'loaded';
-    const STATE_DIRTY = 'dirty';
-    const STATE_DELETED = 'deleted';
+	const STATE_DETACHED = 'detached';
+	const STATE_NEW = 'new';
+	const STATE_SAVING = 'saving';
+	const STATE_NOT_LOADED = 'not loaded';
+	const STATE_LOADED = 'loaded';
+	const STATE_DIRTY = 'dirty';
+	const STATE_DELETED = 'deleted';
 }

src/Mouf/Database/TDBM/AbstractTDBMObject.php

Spacing +3 added lines, -3 removed lines

@@ -197,7 +197,7 @@ 
     private function checkTableName($tableName = null)
     {
         if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
+            if (count($this->dbRows)>1) {
                 throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
             } elseif (count($this->dbRows) === 1) {
                 $tableName = array_keys($this->dbRows)[0];
@@ -221,7 +221,7 @@ 
     protected function set($var, $value, $tableName = null)
     {
         if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
+            if (count($this->dbRows)>1) {
                 throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
             } elseif (count($this->dbRows) === 1) {
                 $tableName = array_keys($this->dbRows)[0];
@@ -247,7 +247,7 @@ 
     protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
     {
         if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
+            if (count($this->dbRows)>1) {
                 throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
             } elseif (count($this->dbRows) === 1) {
                 $tableName = array_keys($this->dbRows)[0];

Indentation +606 added lines, -606 removed lines

@@ -31,615 +31,615 @@
  */
 abstract class AbstractTDBMObject implements JsonSerializable
 {
-    /**
-     * The service this object is bound to.
-     *
-     * @var TDBMService
-     */
-    protected $tdbmService;
-
-    /**
-     * An array of DbRow, indexed by table name.
-     *
-     * @var DbRow[]
-     */
-    protected $dbRows = [];
-
-    /**
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
-     *
-     * @var string
-     */
-    private $status;
-
-    /**
-     * Array storing beans related via many to many relationships (pivot tables).
-     *
-     * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
-     */
-    private $relationships = [];
-
-    /**
-     * @var bool[] Key: pivot table name, value: whether a query was performed to load the data
-     */
-    private $loadedRelationships = [];
-
-    /**
-     * Array storing beans related via many to one relationships (this bean is pointed by external beans).
-     *
-     * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage
-     */
-    private $manyToOneRelationships = [];
-
-    /**
-     * Used with $primaryKeys when we want to retrieve an existing object
-     * and $primaryKeys=[] if we want a new object.
-     *
-     * @param string      $tableName
-     * @param array       $primaryKeys
-     * @param TDBMService $tdbmService
-     *
-     * @throws TDBMException
-     * @throws TDBMInvalidOperationException
-     */
-    public function __construct($tableName = null, array $primaryKeys = [], TDBMService $tdbmService = null)
-    {
-        // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
-        if (!empty($tableName)) {
-            $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
-        }
-
-        if ($tdbmService === null) {
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
-        } else {
-            $this->_attach($tdbmService);
-            if (!empty($primaryKeys)) {
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
-            } else {
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
-            }
-        }
-    }
-
-    /**
-     * Alternative constructor called when data is fetched from database via a SELECT.
-     *
-     * @param array       $beanData    array<table, array<column, value>>
-     * @param TDBMService $tdbmService
-     */
-    public function _constructFromData(array $beanData, TDBMService $tdbmService)
-    {
-        $this->tdbmService = $tdbmService;
-
-        foreach ($beanData as $table => $columns) {
-            $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
-        }
-
-        $this->status = TDBMObjectStateEnum::STATE_LOADED;
-    }
-
-    /**
-     * Alternative constructor called when bean is lazily loaded.
-     *
-     * @param string      $tableName
-     * @param array       $primaryKeys
-     * @param TDBMService $tdbmService
-     */
-    public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
-    {
-        $this->tdbmService = $tdbmService;
-
-        $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
-
-        $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
-    }
-
-    public function _attach(TDBMService $tdbmService)
-    {
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
-        }
-        $this->tdbmService = $tdbmService;
-
-        // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
-        $tableNames = $this->getUsedTables();
-
-        $newDbRows = [];
-
-        foreach ($tableNames as $table) {
-            if (!isset($this->dbRows[$table])) {
-                $this->registerTable($table);
-            }
-            $newDbRows[$table] = $this->dbRows[$table];
-        }
-        $this->dbRows = $newDbRows;
-
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
-        foreach ($this->dbRows as $dbRow) {
-            $dbRow->_attach($tdbmService);
-        }
-    }
-
-    /**
-     * Sets the state of the TDBM Object
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
-     *
-     * @param string $state
-     */
-    public function _setStatus($state)
-    {
-        $this->status = $state;
-
-        // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
-        foreach ($this->dbRows as $dbRow) {
-            $dbRow->_setStatus($state);
-        }
-
-        if ($state === TDBMObjectStateEnum::STATE_DELETED) {
-            $this->onDelete();
-        }
-    }
-
-    /**
-     * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
-     * or throws an error.
-     *
-     * @param string $tableName
-     *
-     * @return string
-     */
-    private function checkTableName($tableName = null)
-    {
-        if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
-            } elseif (count($this->dbRows) === 1) {
-                $tableName = array_keys($this->dbRows)[0];
-            }
-        }
-
-        return $tableName;
-    }
-
-    protected function get($var, $tableName = null)
-    {
-        $tableName = $this->checkTableName($tableName);
-
-        if (!isset($this->dbRows[$tableName])) {
-            return;
-        }
-
-        return $this->dbRows[$tableName]->get($var);
-    }
-
-    protected function set($var, $value, $tableName = null)
-    {
-        if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
-            } elseif (count($this->dbRows) === 1) {
-                $tableName = array_keys($this->dbRows)[0];
-            } else {
-                throw new TDBMException('Please specify a table for this object.');
-            }
-        }
-
-        if (!isset($this->dbRows[$tableName])) {
-            $this->registerTable($tableName);
-        }
-
-        $this->dbRows[$tableName]->set($var, $value);
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
-        }
-    }
-
-    /**
-     * @param string             $foreignKeyName
-     * @param AbstractTDBMObject $bean
-     */
-    protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
-    {
-        if ($tableName === null) {
-            if (count($this->dbRows) > 1) {
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
-            } elseif (count($this->dbRows) === 1) {
-                $tableName = array_keys($this->dbRows)[0];
-            } else {
-                throw new TDBMException('Please specify a table for this object.');
-            }
-        }
-
-        if (!isset($this->dbRows[$tableName])) {
-            $this->registerTable($tableName);
-        }
-
-        $oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName);
-        if ($oldLinkedBean !== null) {
-            $oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this);
-        }
-
-        $this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
-        }
-
-        if ($bean !== null) {
-            $bean->setManyToOneRelationship($tableName, $foreignKeyName, $this);
-        }
-    }
-
-    /**
-     * @param string $foreignKeyName A unique name for this reference
-     *
-     * @return AbstractTDBMObject|null
-     */
-    protected function getRef($foreignKeyName, $tableName = null)
-    {
-        $tableName = $this->checkTableName($tableName);
-
-        if (!isset($this->dbRows[$tableName])) {
-            return;
-        }
-
-        return $this->dbRows[$tableName]->getRef($foreignKeyName);
-    }
-
-    /**
-     * Adds a many to many relationship to this bean.
-     *
-     * @param string             $pivotTableName
-     * @param AbstractTDBMObject $remoteBean
-     */
-    protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
-    {
-        $this->setRelationship($pivotTableName, $remoteBean, 'new');
-    }
-
-    /**
-     * Returns true if there is a relationship to this bean.
-     *
-     * @param string             $pivotTableName
-     * @param AbstractTDBMObject $remoteBean
-     *
-     * @return bool
-     */
-    protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
-    {
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
-
-        if ($storage->contains($remoteBean)) {
-            if ($storage[$remoteBean]['status'] !== 'delete') {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Internal TDBM method. Removes a many to many relationship from this bean.
-     *
-     * @param string             $pivotTableName
-     * @param AbstractTDBMObject $remoteBean
-     */
-    public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
-    {
-        if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
-            unset($this->relationships[$pivotTableName][$remoteBean]);
-            unset($remoteBean->relationships[$pivotTableName][$this]);
-        } else {
-            $this->setRelationship($pivotTableName, $remoteBean, 'delete');
-        }
-    }
-
-    /**
-     * Sets many to many relationships for this bean.
-     * Adds new relationships and removes unused ones.
-     *
-     * @param $pivotTableName
-     * @param array $remoteBeans
-     */
-    protected function setRelationships($pivotTableName, array $remoteBeans)
-    {
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
-
-        foreach ($storage as $oldRemoteBean) {
-            if (!in_array($oldRemoteBean, $remoteBeans, true)) {
-                // $oldRemoteBean must be removed
-                $this->_removeRelationship($pivotTableName, $oldRemoteBean);
-            }
-        }
-
-        foreach ($remoteBeans as $remoteBean) {
-            if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') {
-                // $remoteBean must be added
-                $this->addRelationship($pivotTableName, $remoteBean);
-            }
-        }
-    }
-
-    /**
-     * Returns the list of objects linked to this bean via $pivotTableName.
-     *
-     * @param $pivotTableName
-     *
-     * @return \SplObjectStorage
-     */
-    private function retrieveRelationshipsStorage($pivotTableName)
-    {
-        $storage = $this->getRelationshipStorage($pivotTableName);
-        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);
-        $this->loadedRelationships[$pivotTableName] = true;
-
-        foreach ($beans as $bean) {
-            if (isset($storage[$bean])) {
-                $oldStatus = $storage[$bean]['status'];
-                if ($oldStatus === 'delete') {
-                    // Keep deleted things deleted
-                    continue;
-                }
-            }
-            $this->setRelationship($pivotTableName, $bean, 'loaded');
-        }
-
-        return $storage;
-    }
-
-    /**
-     * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
-     *
-     * @param $pivotTableName
-     *
-     * @return AbstractTDBMObject[]
-     */
-    public function _getRelationships($pivotTableName)
-    {
-        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
-    }
-
-    private function relationshipStorageToArray(\SplObjectStorage $storage)
-    {
-        $beans = [];
-        foreach ($storage as $bean) {
-            $statusArr = $storage[$bean];
-            if ($statusArr['status'] !== 'delete') {
-                $beans[] = $bean;
-            }
-        }
-
-        return $beans;
-    }
-
-    /**
-     * Declares a relationship between.
-     *
-     * @param string             $pivotTableName
-     * @param AbstractTDBMObject $remoteBean
-     * @param string             $status
-     */
-    private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
-    {
-        $storage = $this->getRelationshipStorage($pivotTableName);
-        $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
-        if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
-        }
-
-        $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
-        $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
-    }
-
-    /**
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
-     *
-     * @param string $pivotTableName
-     *
-     * @return \SplObjectStorage
-     */
-    private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage
-    {
-        return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage();
-    }
-
-    /**
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
-     *
-     * @param string $tableName
-     * @param string $foreignKeyName
-     *
-     * @return AlterableResultIterator
-     */
-    private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator
-    {
-        $key = $tableName.'___'.$foreignKeyName;
-
-        return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator();
-    }
-
-    /**
-     * Declares a relationship between this bean and the bean pointing to it.
-     *
-     * @param string             $tableName
-     * @param string             $foreignKeyName
-     * @param AbstractTDBMObject $remoteBean
-     */
-    private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
-    {
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
-        $alterableResultIterator->add($remoteBean);
-    }
-
-    /**
-     * Declares a relationship between this bean and the bean pointing to it.
-     *
-     * @param string             $tableName
-     * @param string             $foreignKeyName
-     * @param AbstractTDBMObject $remoteBean
-     */
-    private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
-    {
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
-        $alterableResultIterator->remove($remoteBean);
-    }
-
-    /**
-     * Returns the list of objects linked to this bean via a given foreign key.
-     *
-     * @param string $tableName
-     * @param string $foreignKeyName
-     * @param string $searchTableName
-     * @param array  $searchFilter
-     * @param string $orderString     The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object !
-     *
-     * @return AlterableResultIterator
-     */
-    protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator
-    {
-        $key = $tableName.'___'.$foreignKeyName;
-        $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) {
-            return $alterableResultIterator;
-        }
-
-        $unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString);
-
-        $alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator());
-
-        return $alterableResultIterator;
-    }
-
-    /**
-     * Reverts any changes made to the object and resumes it to its DB state.
-     * This can only be called on objects that come from database and that have not been deleted.
-     * Otherwise, this will throw an exception.
-     *
-     * @throws TDBMException
-     */
-    public function discardChanges()
-    {
-        if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
-            throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
-        }
-
-        if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
-            throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
-        }
-
-        $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
-    }
-
-    /**
-     * Method used internally by TDBM. You should not use it directly.
-     * This method returns the status of the TDBMObject.
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
-     *
-     * @return string
-     */
-    public function _getStatus()
-    {
-        return $this->status;
-    }
-
-    /**
-     * Override the native php clone function for TDBMObjects.
-     */
-    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) {
+	/**
+	 * The service this object is bound to.
+	 *
+	 * @var TDBMService
+	 */
+	protected $tdbmService;
+
+	/**
+	 * An array of DbRow, indexed by table name.
+	 *
+	 * @var DbRow[]
+	 */
+	protected $dbRows = [];
+
+	/**
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
+	 *
+	 * @var string
+	 */
+	private $status;
+
+	/**
+	 * Array storing beans related via many to many relationships (pivot tables).
+	 *
+	 * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
+	 */
+	private $relationships = [];
+
+	/**
+	 * @var bool[] Key: pivot table name, value: whether a query was performed to load the data
+	 */
+	private $loadedRelationships = [];
+
+	/**
+	 * Array storing beans related via many to one relationships (this bean is pointed by external beans).
+	 *
+	 * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage
+	 */
+	private $manyToOneRelationships = [];
+
+	/**
+	 * Used with $primaryKeys when we want to retrieve an existing object
+	 * and $primaryKeys=[] if we want a new object.
+	 *
+	 * @param string      $tableName
+	 * @param array       $primaryKeys
+	 * @param TDBMService $tdbmService
+	 *
+	 * @throws TDBMException
+	 * @throws TDBMInvalidOperationException
+	 */
+	public function __construct($tableName = null, array $primaryKeys = [], TDBMService $tdbmService = null)
+	{
+		// FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
+		if (!empty($tableName)) {
+			$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
+		}
+
+		if ($tdbmService === null) {
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
+		} else {
+			$this->_attach($tdbmService);
+			if (!empty($primaryKeys)) {
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
+			} else {
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
+			}
+		}
+	}
+
+	/**
+	 * Alternative constructor called when data is fetched from database via a SELECT.
+	 *
+	 * @param array       $beanData    array<table, array<column, value>>
+	 * @param TDBMService $tdbmService
+	 */
+	public function _constructFromData(array $beanData, TDBMService $tdbmService)
+	{
+		$this->tdbmService = $tdbmService;
+
+		foreach ($beanData as $table => $columns) {
+			$this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
+		}
+
+		$this->status = TDBMObjectStateEnum::STATE_LOADED;
+	}
+
+	/**
+	 * Alternative constructor called when bean is lazily loaded.
+	 *
+	 * @param string      $tableName
+	 * @param array       $primaryKeys
+	 * @param TDBMService $tdbmService
+	 */
+	public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
+	{
+		$this->tdbmService = $tdbmService;
+
+		$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
+
+		$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
+	}
+
+	public function _attach(TDBMService $tdbmService)
+	{
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
+		}
+		$this->tdbmService = $tdbmService;
+
+		// If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
+		$tableNames = $this->getUsedTables();
+
+		$newDbRows = [];
+
+		foreach ($tableNames as $table) {
+			if (!isset($this->dbRows[$table])) {
+				$this->registerTable($table);
+			}
+			$newDbRows[$table] = $this->dbRows[$table];
+		}
+		$this->dbRows = $newDbRows;
+
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
+		foreach ($this->dbRows as $dbRow) {
+			$dbRow->_attach($tdbmService);
+		}
+	}
+
+	/**
+	 * Sets the state of the TDBM Object
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
+	 *
+	 * @param string $state
+	 */
+	public function _setStatus($state)
+	{
+		$this->status = $state;
+
+		// TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
+		foreach ($this->dbRows as $dbRow) {
+			$dbRow->_setStatus($state);
+		}
+
+		if ($state === TDBMObjectStateEnum::STATE_DELETED) {
+			$this->onDelete();
+		}
+	}
+
+	/**
+	 * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null"
+	 * or throws an error.
+	 *
+	 * @param string $tableName
+	 *
+	 * @return string
+	 */
+	private function checkTableName($tableName = null)
+	{
+		if ($tableName === null) {
+			if (count($this->dbRows) > 1) {
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
+			} elseif (count($this->dbRows) === 1) {
+				$tableName = array_keys($this->dbRows)[0];
+			}
+		}
+
+		return $tableName;
+	}
+
+	protected function get($var, $tableName = null)
+	{
+		$tableName = $this->checkTableName($tableName);
+
+		if (!isset($this->dbRows[$tableName])) {
+			return;
+		}
+
+		return $this->dbRows[$tableName]->get($var);
+	}
+
+	protected function set($var, $value, $tableName = null)
+	{
+		if ($tableName === null) {
+			if (count($this->dbRows) > 1) {
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
+			} elseif (count($this->dbRows) === 1) {
+				$tableName = array_keys($this->dbRows)[0];
+			} else {
+				throw new TDBMException('Please specify a table for this object.');
+			}
+		}
+
+		if (!isset($this->dbRows[$tableName])) {
+			$this->registerTable($tableName);
+		}
+
+		$this->dbRows[$tableName]->set($var, $value);
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
+		}
+	}
+
+	/**
+	 * @param string             $foreignKeyName
+	 * @param AbstractTDBMObject $bean
+	 */
+	protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null)
+	{
+		if ($tableName === null) {
+			if (count($this->dbRows) > 1) {
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
+			} elseif (count($this->dbRows) === 1) {
+				$tableName = array_keys($this->dbRows)[0];
+			} else {
+				throw new TDBMException('Please specify a table for this object.');
+			}
+		}
+
+		if (!isset($this->dbRows[$tableName])) {
+			$this->registerTable($tableName);
+		}
+
+		$oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName);
+		if ($oldLinkedBean !== null) {
+			$oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this);
+		}
+
+		$this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
+		}
+
+		if ($bean !== null) {
+			$bean->setManyToOneRelationship($tableName, $foreignKeyName, $this);
+		}
+	}
+
+	/**
+	 * @param string $foreignKeyName A unique name for this reference
+	 *
+	 * @return AbstractTDBMObject|null
+	 */
+	protected function getRef($foreignKeyName, $tableName = null)
+	{
+		$tableName = $this->checkTableName($tableName);
+
+		if (!isset($this->dbRows[$tableName])) {
+			return;
+		}
+
+		return $this->dbRows[$tableName]->getRef($foreignKeyName);
+	}
+
+	/**
+	 * Adds a many to many relationship to this bean.
+	 *
+	 * @param string             $pivotTableName
+	 * @param AbstractTDBMObject $remoteBean
+	 */
+	protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
+	{
+		$this->setRelationship($pivotTableName, $remoteBean, 'new');
+	}
+
+	/**
+	 * Returns true if there is a relationship to this bean.
+	 *
+	 * @param string             $pivotTableName
+	 * @param AbstractTDBMObject $remoteBean
+	 *
+	 * @return bool
+	 */
+	protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
+	{
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
+
+		if ($storage->contains($remoteBean)) {
+			if ($storage[$remoteBean]['status'] !== 'delete') {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Internal TDBM method. Removes a many to many relationship from this bean.
+	 *
+	 * @param string             $pivotTableName
+	 * @param AbstractTDBMObject $remoteBean
+	 */
+	public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
+	{
+		if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
+			unset($this->relationships[$pivotTableName][$remoteBean]);
+			unset($remoteBean->relationships[$pivotTableName][$this]);
+		} else {
+			$this->setRelationship($pivotTableName, $remoteBean, 'delete');
+		}
+	}
+
+	/**
+	 * Sets many to many relationships for this bean.
+	 * Adds new relationships and removes unused ones.
+	 *
+	 * @param $pivotTableName
+	 * @param array $remoteBeans
+	 */
+	protected function setRelationships($pivotTableName, array $remoteBeans)
+	{
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
+
+		foreach ($storage as $oldRemoteBean) {
+			if (!in_array($oldRemoteBean, $remoteBeans, true)) {
+				// $oldRemoteBean must be removed
+				$this->_removeRelationship($pivotTableName, $oldRemoteBean);
+			}
+		}
+
+		foreach ($remoteBeans as $remoteBean) {
+			if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') {
+				// $remoteBean must be added
+				$this->addRelationship($pivotTableName, $remoteBean);
+			}
+		}
+	}
+
+	/**
+	 * Returns the list of objects linked to this bean via $pivotTableName.
+	 *
+	 * @param $pivotTableName
+	 *
+	 * @return \SplObjectStorage
+	 */
+	private function retrieveRelationshipsStorage($pivotTableName)
+	{
+		$storage = $this->getRelationshipStorage($pivotTableName);
+		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);
+		$this->loadedRelationships[$pivotTableName] = true;
+
+		foreach ($beans as $bean) {
+			if (isset($storage[$bean])) {
+				$oldStatus = $storage[$bean]['status'];
+				if ($oldStatus === 'delete') {
+					// Keep deleted things deleted
+					continue;
+				}
+			}
+			$this->setRelationship($pivotTableName, $bean, 'loaded');
+		}
+
+		return $storage;
+	}
+
+	/**
+	 * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
+	 *
+	 * @param $pivotTableName
+	 *
+	 * @return AbstractTDBMObject[]
+	 */
+	public function _getRelationships($pivotTableName)
+	{
+		return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
+	}
+
+	private function relationshipStorageToArray(\SplObjectStorage $storage)
+	{
+		$beans = [];
+		foreach ($storage as $bean) {
+			$statusArr = $storage[$bean];
+			if ($statusArr['status'] !== 'delete') {
+				$beans[] = $bean;
+			}
+		}
+
+		return $beans;
+	}
+
+	/**
+	 * Declares a relationship between.
+	 *
+	 * @param string             $pivotTableName
+	 * @param AbstractTDBMObject $remoteBean
+	 * @param string             $status
+	 */
+	private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
+	{
+		$storage = $this->getRelationshipStorage($pivotTableName);
+		$storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
+		if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
+		}
+
+		$remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
+		$remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
+	}
+
+	/**
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
+	 *
+	 * @param string $pivotTableName
+	 *
+	 * @return \SplObjectStorage
+	 */
+	private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage
+	{
+		return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage();
+	}
+
+	/**
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
+	 *
+	 * @param string $tableName
+	 * @param string $foreignKeyName
+	 *
+	 * @return AlterableResultIterator
+	 */
+	private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator
+	{
+		$key = $tableName.'___'.$foreignKeyName;
+
+		return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator();
+	}
+
+	/**
+	 * Declares a relationship between this bean and the bean pointing to it.
+	 *
+	 * @param string             $tableName
+	 * @param string             $foreignKeyName
+	 * @param AbstractTDBMObject $remoteBean
+	 */
+	private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
+	{
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
+		$alterableResultIterator->add($remoteBean);
+	}
+
+	/**
+	 * Declares a relationship between this bean and the bean pointing to it.
+	 *
+	 * @param string             $tableName
+	 * @param string             $foreignKeyName
+	 * @param AbstractTDBMObject $remoteBean
+	 */
+	private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean)
+	{
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
+		$alterableResultIterator->remove($remoteBean);
+	}
+
+	/**
+	 * Returns the list of objects linked to this bean via a given foreign key.
+	 *
+	 * @param string $tableName
+	 * @param string $foreignKeyName
+	 * @param string $searchTableName
+	 * @param array  $searchFilter
+	 * @param string $orderString     The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object !
+	 *
+	 * @return AlterableResultIterator
+	 */
+	protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator
+	{
+		$key = $tableName.'___'.$foreignKeyName;
+		$alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName);
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) {
+			return $alterableResultIterator;
+		}
+
+		$unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString);
+
+		$alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator());
+
+		return $alterableResultIterator;
+	}
+
+	/**
+	 * Reverts any changes made to the object and resumes it to its DB state.
+	 * This can only be called on objects that come from database and that have not been deleted.
+	 * Otherwise, this will throw an exception.
+	 *
+	 * @throws TDBMException
+	 */
+	public function discardChanges()
+	{
+		if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
+			throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
+		}
+
+		if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
+			throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
+		}
+
+		$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
+	}
+
+	/**
+	 * Method used internally by TDBM. You should not use it directly.
+	 * This method returns the status of the TDBMObject.
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
+	 *
+	 * @return string
+	 */
+	public function _getStatus()
+	{
+		return $this->status;
+	}
+
+	/**
+	 * Override the native php clone function for TDBMObjects.
+	 */
+	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;
-            $dbRow->setTDBMObject($this);
-        }
-
-        $this->manyToOneRelationships = [];
-
-        // Let's set the status to new (to enter the save function)
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
-    }
-
-    /**
-     * Returns raw database rows.
-     *
-     * @return DbRow[] Key: table name, Value: DbRow object
-     */
-    public function _getDbRows()
-    {
-        return $this->dbRows;
-    }
-
-    private function registerTable($tableName)
-    {
-        $dbRow = new DbRow($this, $tableName);
-
-        if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
-            // Let's get the primary key for the new table
-            $anotherDbRow = array_values($this->dbRows)[0];
-            /* @var $anotherDbRow DbRow */
-            $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
-            $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
-            $dbRow->_setPrimaryKeys($primaryKeys);
-        }
-
-        $dbRow->_setStatus($this->status);
-
-        $this->dbRows[$tableName] = $dbRow;
-        // TODO: look at status (if not new)=> get primary key from tdbmservice
-    }
-
-    /**
-     * Internal function: return the list of relationships.
-     *
-     * @return \SplObjectStorage[]
-     */
-    public function _getCachedRelationships()
-    {
-        return $this->relationships;
-    }
-
-    /**
-     * Returns an array of used tables by this bean (from parent to child relationship).
-     *
-     * @return string[]
-     */
-    abstract protected function getUsedTables() : array;
-
-    /**
-     * Method called when the bean is removed from database.
-     */
-    protected function onDelete() : void
-    {
-    }
+		}
+
+		// Let's clone each row
+		foreach ($this->dbRows as $key => &$dbRow) {
+			$dbRow = clone $dbRow;
+			$dbRow->setTDBMObject($this);
+		}
+
+		$this->manyToOneRelationships = [];
+
+		// Let's set the status to new (to enter the save function)
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
+	}
+
+	/**
+	 * Returns raw database rows.
+	 *
+	 * @return DbRow[] Key: table name, Value: DbRow object
+	 */
+	public function _getDbRows()
+	{
+		return $this->dbRows;
+	}
+
+	private function registerTable($tableName)
+	{
+		$dbRow = new DbRow($this, $tableName);
+
+		if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
+			// Let's get the primary key for the new table
+			$anotherDbRow = array_values($this->dbRows)[0];
+			/* @var $anotherDbRow DbRow */
+			$indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
+			$primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
+			$dbRow->_setPrimaryKeys($primaryKeys);
+		}
+
+		$dbRow->_setStatus($this->status);
+
+		$this->dbRows[$tableName] = $dbRow;
+		// TODO: look at status (if not new)=> get primary key from tdbmservice
+	}
+
+	/**
+	 * Internal function: return the list of relationships.
+	 *
+	 * @return \SplObjectStorage[]
+	 */
+	public function _getCachedRelationships()
+	{
+		return $this->relationships;
+	}
+
+	/**
+	 * Returns an array of used tables by this bean (from parent to child relationship).
+	 *
+	 * @return string[]
+	 */
+	abstract protected function getUsedTables() : array;
+
+	/**
+	 * Method called when the bean is removed from database.
+	 */
+	protected function onDelete() : void
+	{
+	}
 }

src/Mouf/Database/TDBM/Utils/DirectForeignKeyMethodDescriptor.php

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace Mouf\Database\TDBM\Utils;
 

Indentation +116 added lines, -116 removed lines

@@ -12,71 +12,71 @@ 
  */
 class DirectForeignKeyMethodDescriptor implements MethodDescriptorInterface
 {
-    /**
-     * @var ForeignKeyConstraint
-     */
-    private $fk;
-
-    private $useAlternateName = false;
-    /**
-     * @var Table
-     */
-    private $mainTable;
-    /**
-     * @var NamingStrategyInterface
-     */
-    private $namingStrategy;
-
-    /**
-     * @param ForeignKeyConstraint $fk The foreign key pointing to our bean
-     * @param Table $mainTable The main table that is pointed to
-     * @param NamingStrategyInterface $namingStrategy
-     */
-    public function __construct(ForeignKeyConstraint $fk, Table $mainTable, NamingStrategyInterface $namingStrategy)
-    {
-        $this->fk = $fk;
-        $this->mainTable = $mainTable;
-        $this->namingStrategy = $namingStrategy;
-    }
-
-    /**
-     * Returns the name of the method to be generated.
-     *
-     * @return string
-     */
-    public function getName() : string
-    {
-        if (!$this->useAlternateName) {
-            return 'get'.TDBMDaoGenerator::toCamelCase($this->fk->getLocalTableName());
-        } else {
-            $methodName = 'get'.TDBMDaoGenerator::toCamelCase($this->fk->getLocalTableName()).'By';
-
-            $camelizedColumns = array_map([TDBMDaoGenerator::class, 'toCamelCase'], $this->fk->getLocalColumns());
-
-            $methodName .= implode('And', $camelizedColumns);
-
-            return $methodName;
-        }
-    }
-
-    /**
-     * Requests the use of an alternative name for this method.
-     */
-    public function useAlternativeName()
-    {
-        $this->useAlternateName = true;
-    }
-
-    /**
-     * Returns the code of the method.
-     *
-     * @return string
-     */
-    public function getCode() : string
-    {
-        $code = '';
-
-        $getterCode = '    /**
+	/**
+	 * @var ForeignKeyConstraint
+	 */
+	private $fk;
+
+	private $useAlternateName = false;
+	/**
+	 * @var Table
+	 */
+	private $mainTable;
+	/**
+	 * @var NamingStrategyInterface
+	 */
+	private $namingStrategy;
+
+	/**
+	 * @param ForeignKeyConstraint $fk The foreign key pointing to our bean
+	 * @param Table $mainTable The main table that is pointed to
+	 * @param NamingStrategyInterface $namingStrategy
+	 */
+	public function __construct(ForeignKeyConstraint $fk, Table $mainTable, NamingStrategyInterface $namingStrategy)
+	{
+		$this->fk = $fk;
+		$this->mainTable = $mainTable;
+		$this->namingStrategy = $namingStrategy;
+	}
+
+	/**
+	 * Returns the name of the method to be generated.
+	 *
+	 * @return string
+	 */
+	public function getName() : string
+	{
+		if (!$this->useAlternateName) {
+			return 'get'.TDBMDaoGenerator::toCamelCase($this->fk->getLocalTableName());
+		} else {
+			$methodName = 'get'.TDBMDaoGenerator::toCamelCase($this->fk->getLocalTableName()).'By';
+
+			$camelizedColumns = array_map([TDBMDaoGenerator::class, 'toCamelCase'], $this->fk->getLocalColumns());
+
+			$methodName .= implode('And', $camelizedColumns);
+
+			return $methodName;
+		}
+	}
+
+	/**
+	 * Requests the use of an alternative name for this method.
+	 */
+	public function useAlternativeName()
+	{
+		$this->useAlternateName = true;
+	}
+
+	/**
+	 * Returns the code of the method.
+	 *
+	 * @return string
+	 */
+	public function getCode() : string
+	{
+		$code = '';
+
+		$getterCode = '    /**
      * Returns the list of %s pointing to this bean via the %s column.
      *
      * @return %s[]|AlterableResultIterator
@@ -88,55 +88,55 @@ 
 
 ';
 
-        $beanClass = $this->namingStrategy->getBeanClassName($this->fk->getLocalTableName());
-        $code .= sprintf($getterCode,
-            $beanClass,
-            implode(', ', $this->fk->getColumns()),
-            $beanClass,
-            $this->getName(),
-            var_export($this->fk->getLocalTableName(), true),
-            var_export($this->fk->getName(), true),
-            var_export($this->fk->getLocalTableName(), true),
-            $this->getFilters($this->fk)
-        );
-
-        return $code;
-    }
-
-    private function getFilters(ForeignKeyConstraint $fk) : string
-    {
-        $counter = 0;
-        $parameters = [];
-
-        $pkColumns = $this->mainTable->getPrimaryKeyColumns();
-
-        foreach ($fk->getLocalColumns() as $columnName) {
-            $pkColumn = $pkColumns[$counter];
-            $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->fk->getForeignTableName(), true));
-            ++$counter;
-        }
-        $parametersCode = '['.implode(', ', $parameters).']';
-
-        return $parametersCode;
-    }
-
-    /**
-     * Returns an array of classes that needs a "use" for this method.
-     *
-     * @return string[]
-     */
-    public function getUsedClasses() : array
-    {
-        return [$this->namingStrategy->getBeanClassName($this->fk->getForeignTableName())];
-    }
-
-    /**
-     * Returns the code to past in jsonSerialize.
-     *
-     * @return string
-     */
-    public function getJsonSerializeCode() : string
-    {
-        return '';
-    }
+		$beanClass = $this->namingStrategy->getBeanClassName($this->fk->getLocalTableName());
+		$code .= sprintf($getterCode,
+			$beanClass,
+			implode(', ', $this->fk->getColumns()),
+			$beanClass,
+			$this->getName(),
+			var_export($this->fk->getLocalTableName(), true),
+			var_export($this->fk->getName(), true),
+			var_export($this->fk->getLocalTableName(), true),
+			$this->getFilters($this->fk)
+		);
+
+		return $code;
+	}
+
+	private function getFilters(ForeignKeyConstraint $fk) : string
+	{
+		$counter = 0;
+		$parameters = [];
+
+		$pkColumns = $this->mainTable->getPrimaryKeyColumns();
+
+		foreach ($fk->getLocalColumns() as $columnName) {
+			$pkColumn = $pkColumns[$counter];
+			$parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->fk->getForeignTableName(), true));
+			++$counter;
+		}
+		$parametersCode = '['.implode(', ', $parameters).']';
+
+		return $parametersCode;
+	}
+
+	/**
+	 * Returns an array of classes that needs a "use" for this method.
+	 *
+	 * @return string[]
+	 */
+	public function getUsedClasses() : array
+	{
+		return [$this->namingStrategy->getBeanClassName($this->fk->getForeignTableName())];
+	}
+
+	/**
+	 * Returns the code to past in jsonSerialize.
+	 *
+	 * @return string
+	 */
+	public function getJsonSerializeCode() : string
+	{
+		return '';
+	}
 }

src/views/tdbmGenerate.php

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" />
 
 <?php if (!$this->autoloadDetected) {
-    ?>
+	?>
 <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file.
 Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div>
 <?php

src/Mouf/Database/TDBM/Utils/TDBMDaoGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -616,7 +616,7 @@
      * Tries to put string to the singular form (if it is plural).
      * We assume the table names are in english.
      *
-     * @param $str string
+     * @param string $str string
      *
      * @return string
      */

Spacing +5 added lines, -5 removed lines

@@ -89,11 +89,11 @@ 
 
         // Remove all beans and daos from junction tables
         $junctionTables = $this->configuration->getSchemaAnalyzer()->detectJunctionTables(true);
-        $junctionTableNames = array_map(function (Table $table) {
+        $junctionTableNames = array_map(function(Table $table) {
             return $table->getName();
         }, $junctionTables);
 
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
+        $tableList = array_filter($tableList, function(Table $table) use ($junctionTableNames) {
             return !in_array($table->getName(), $junctionTableNames);
         });
 
@@ -251,7 +251,7 @@ 
         $usedBeans[] = $beanClassName;
         // Let's suppress duplicates in used beans (if any)
         $usedBeans = array_flip(array_flip($usedBeans));
-        $useStatements = array_map(function ($usedBean) {
+        $useStatements = array_map(function($usedBean) {
             return "use $usedBean;\n";
         }, $usedBeans);
 
@@ -606,7 +606,7 @@ 
                 $pos = strpos($str, ' ');
             }
             $before = substr($str, 0, $pos);
-            $after = substr($str, $pos + 1);
+            $after = substr($str, $pos+1);
             $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
         }
 
@@ -682,7 +682,7 @@ 
         $map = [
             Type::TARRAY => 'array',
             Type::SIMPLE_ARRAY => 'array',
-            'json' => 'array',  // 'json' is supported from Doctrine DBAL 2.6 only.
+            'json' => 'array', // 'json' is supported from Doctrine DBAL 2.6 only.
             Type::JSON_ARRAY => 'array',
             Type::BIGINT => 'string',
             Type::BOOLEAN => 'bool',

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use Mouf\Database\TDBM\ConfigurationInterface;
 use Mouf\Database\TDBM\TDBMException;
 use Mouf\Database\TDBM\TDBMSchemaAnalyzer;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
 /**

Indentation +356 added lines, -356 removed lines

@@ -17,132 +17,132 @@ 
  */
 class TDBMDaoGenerator
 {
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * Name of composer file.
-     *
-     * @var string
-     */
-    private $composerFile;
-
-    /**
-     * @var TDBMSchemaAnalyzer
-     */
-    private $tdbmSchemaAnalyzer;
-
-    /**
-     * @var GeneratorListenerInterface
-     */
-    private $eventDispatcher;
-
-    /**
-     * @var NamingStrategyInterface
-     */
-    private $namingStrategy;
-    /**
-     * @var ConfigurationInterface
-     */
-    private $configuration;
-
-    /**
-     * Constructor.
-     *
-     * @param ConfigurationInterface $configuration
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
-     */
-    public function __construct(ConfigurationInterface $configuration, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
-    {
-        $this->configuration = $configuration;
-        $this->schema = $tdbmSchemaAnalyzer->getSchema();
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
-        $this->namingStrategy = $configuration->getNamingStrategy();
-        $this->eventDispatcher = $configuration->getGeneratorEventDispatcher();
-    }
-
-    /**
-     * Generates all the daos and beans.
-     *
-     * @throws TDBMException
-     */
-    public function generateAllDaosAndBeans(): void
-    {
-        // TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
-
-        $tableList = $this->schema->getTables();
-
-        // Remove all beans and daos from junction tables
-        $junctionTables = $this->configuration->getSchemaAnalyzer()->detectJunctionTables(true);
-        $junctionTableNames = array_map(function (Table $table) {
-            return $table->getName();
-        }, $junctionTables);
-
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
-            return !in_array($table->getName(), $junctionTableNames);
-        });
-
-        $beanDescriptors = [];
-
-        foreach ($tableList as $table) {
-            $beanDescriptors[] = $this->generateDaoAndBean($table);
-        }
-
-
-        $this->generateFactory($tableList);
-
-        // Let's call the list of listeners
-        $this->eventDispatcher->onGenerate($this->configuration, $beanDescriptors);
-    }
-
-    /**
-     * Generates in one method call the daos and the beans for one table.
-     *
-     * @param Table $table
-     *
-     * @return BeanDescriptor
-     * @throws TDBMException
-     */
-    private function generateDaoAndBean(Table $table) : BeanDescriptor
-    {
-        $tableName = $table->getName();
-        $daoName = $this->namingStrategy->getDaoClassName($tableName);
-        $beanName = $this->namingStrategy->getBeanClassName($tableName);
-        $baseBeanName = $this->namingStrategy->getBaseBeanClassName($tableName);
-        $baseDaoName = $this->namingStrategy->getBaseDaoClassName($tableName);
-
-        $beanDescriptor = new BeanDescriptor($table, $this->configuration->getSchemaAnalyzer(), $this->schema, $this->tdbmSchemaAnalyzer, $this->namingStrategy);
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table);
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table);
-        return $beanDescriptor;
-    }
-
-    /**
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
-     *
-     * @param BeanDescriptor  $beanDescriptor
-     * @param string          $className       The name of the class
-     * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
-     * @param Table           $table           The table
-     *
-     * @throws TDBMException
-     */
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table)
-    {
-        $beannamespace = $this->configuration->getBeanNamespace();
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
-
-        $possibleBaseFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\Generated\\'.$baseClassName)->getPathname();
-
-        $this->dumpFile($possibleBaseFileName, $str);
-
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\'.$className)->getPathname();
-
-        if (!file_exists($possibleFileName)) {
-            $tableName = $table->getName();
-            $str = "<?php
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * Name of composer file.
+	 *
+	 * @var string
+	 */
+	private $composerFile;
+
+	/**
+	 * @var TDBMSchemaAnalyzer
+	 */
+	private $tdbmSchemaAnalyzer;
+
+	/**
+	 * @var GeneratorListenerInterface
+	 */
+	private $eventDispatcher;
+
+	/**
+	 * @var NamingStrategyInterface
+	 */
+	private $namingStrategy;
+	/**
+	 * @var ConfigurationInterface
+	 */
+	private $configuration;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param ConfigurationInterface $configuration
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
+	 */
+	public function __construct(ConfigurationInterface $configuration, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
+	{
+		$this->configuration = $configuration;
+		$this->schema = $tdbmSchemaAnalyzer->getSchema();
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
+		$this->namingStrategy = $configuration->getNamingStrategy();
+		$this->eventDispatcher = $configuration->getGeneratorEventDispatcher();
+	}
+
+	/**
+	 * Generates all the daos and beans.
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateAllDaosAndBeans(): void
+	{
+		// TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
+
+		$tableList = $this->schema->getTables();
+
+		// Remove all beans and daos from junction tables
+		$junctionTables = $this->configuration->getSchemaAnalyzer()->detectJunctionTables(true);
+		$junctionTableNames = array_map(function (Table $table) {
+			return $table->getName();
+		}, $junctionTables);
+
+		$tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
+			return !in_array($table->getName(), $junctionTableNames);
+		});
+
+		$beanDescriptors = [];
+
+		foreach ($tableList as $table) {
+			$beanDescriptors[] = $this->generateDaoAndBean($table);
+		}
+
+
+		$this->generateFactory($tableList);
+
+		// Let's call the list of listeners
+		$this->eventDispatcher->onGenerate($this->configuration, $beanDescriptors);
+	}
+
+	/**
+	 * Generates in one method call the daos and the beans for one table.
+	 *
+	 * @param Table $table
+	 *
+	 * @return BeanDescriptor
+	 * @throws TDBMException
+	 */
+	private function generateDaoAndBean(Table $table) : BeanDescriptor
+	{
+		$tableName = $table->getName();
+		$daoName = $this->namingStrategy->getDaoClassName($tableName);
+		$beanName = $this->namingStrategy->getBeanClassName($tableName);
+		$baseBeanName = $this->namingStrategy->getBaseBeanClassName($tableName);
+		$baseDaoName = $this->namingStrategy->getBaseDaoClassName($tableName);
+
+		$beanDescriptor = new BeanDescriptor($table, $this->configuration->getSchemaAnalyzer(), $this->schema, $this->tdbmSchemaAnalyzer, $this->namingStrategy);
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table);
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table);
+		return $beanDescriptor;
+	}
+
+	/**
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
+	 *
+	 * @param BeanDescriptor  $beanDescriptor
+	 * @param string          $className       The name of the class
+	 * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
+	 * @param Table           $table           The table
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table)
+	{
+		$beannamespace = $this->configuration->getBeanNamespace();
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
+
+		$possibleBaseFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\Generated\\'.$baseClassName)->getPathname();
+
+		$this->dumpFile($possibleBaseFileName, $str);
+
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($beannamespace.'\\'.$className)->getPathname();
+
+		if (!file_exists($possibleFileName)) {
+			$tableName = $table->getName();
+			$str = "<?php
 /*
  * This file has been automatically generated by TDBM.
  * You can edit this file as it will not be overwritten.
@@ -160,73 +160,73 @@ 
 }
 ";
 
-            $this->dumpFile($possibleFileName, $str);
-        }
-    }
-
-    /**
-     * Tries to find a @defaultSort annotation in one of the columns.
-     *
-     * @param Table $table
-     *
-     * @return array First item: column name, Second item: column order (asc/desc)
-     */
-    private function getDefaultSortColumnFromAnnotation(Table $table)
-    {
-        $defaultSort = null;
-        $defaultSortDirection = null;
-        foreach ($table->getColumns() as $column) {
-            $comments = $column->getComment();
-            $matches = [];
-            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
-                $defaultSort = $column->getName();
-                if (count($matches) === 3) {
-                    $defaultSortDirection = $matches[2];
-                } else {
-                    $defaultSortDirection = 'ASC';
-                }
-            }
-        }
-
-        return [$defaultSort, $defaultSortDirection];
-    }
-
-    /**
-     * Writes the PHP bean DAO with simple functions to create/get/save objects.
-     *
-     * @param BeanDescriptor  $beanDescriptor
-     * @param string          $className       The name of the class
-     * @param string          $baseClassName
-     * @param string          $beanClassName
-     * @param Table           $table
-     *
-     * @throws TDBMException
-     */
-    private function generateDao(BeanDescriptor $beanDescriptor, string $className, string $baseClassName, string $beanClassName, Table $table)
-    {
-        $daonamespace = $this->configuration->getDaoNamespace();
-        $beannamespace = $this->configuration->getBeanNamespace();
-        $tableName = $table->getName();
-        $primaryKeyColumns = $table->getPrimaryKeyColumns();
-
-        list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
-
-        // FIXME: lowercase tables with _ in the name should work!
-        $tableCamel = self::toSingular(self::toCamelCase($tableName));
-
-        $beanClassWithoutNameSpace = $beanClassName;
-        $beanClassName = $beannamespace.'\\'.$beanClassName;
-
-        list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
-
-        $usedBeans[] = $beanClassName;
-        // Let's suppress duplicates in used beans (if any)
-        $usedBeans = array_flip(array_flip($usedBeans));
-        $useStatements = array_map(function ($usedBean) {
-            return "use $usedBean;\n";
-        }, $usedBeans);
-
-        $str = "<?php
+			$this->dumpFile($possibleFileName, $str);
+		}
+	}
+
+	/**
+	 * Tries to find a @defaultSort annotation in one of the columns.
+	 *
+	 * @param Table $table
+	 *
+	 * @return array First item: column name, Second item: column order (asc/desc)
+	 */
+	private function getDefaultSortColumnFromAnnotation(Table $table)
+	{
+		$defaultSort = null;
+		$defaultSortDirection = null;
+		foreach ($table->getColumns() as $column) {
+			$comments = $column->getComment();
+			$matches = [];
+			if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
+				$defaultSort = $column->getName();
+				if (count($matches) === 3) {
+					$defaultSortDirection = $matches[2];
+				} else {
+					$defaultSortDirection = 'ASC';
+				}
+			}
+		}
+
+		return [$defaultSort, $defaultSortDirection];
+	}
+
+	/**
+	 * Writes the PHP bean DAO with simple functions to create/get/save objects.
+	 *
+	 * @param BeanDescriptor  $beanDescriptor
+	 * @param string          $className       The name of the class
+	 * @param string          $baseClassName
+	 * @param string          $beanClassName
+	 * @param Table           $table
+	 *
+	 * @throws TDBMException
+	 */
+	private function generateDao(BeanDescriptor $beanDescriptor, string $className, string $baseClassName, string $beanClassName, Table $table)
+	{
+		$daonamespace = $this->configuration->getDaoNamespace();
+		$beannamespace = $this->configuration->getBeanNamespace();
+		$tableName = $table->getName();
+		$primaryKeyColumns = $table->getPrimaryKeyColumns();
+
+		list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
+
+		// FIXME: lowercase tables with _ in the name should work!
+		$tableCamel = self::toSingular(self::toCamelCase($tableName));
+
+		$beanClassWithoutNameSpace = $beanClassName;
+		$beanClassName = $beannamespace.'\\'.$beanClassName;
+
+		list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
+
+		$usedBeans[] = $beanClassName;
+		// Let's suppress duplicates in used beans (if any)
+		$usedBeans = array_flip(array_flip($usedBeans));
+		$useStatements = array_map(function ($usedBean) {
+			return "use $usedBean;\n";
+		}, $usedBeans);
+
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -302,10 +302,10 @@ 
     }
     ";
 
-        if (count($primaryKeyColumns) === 1) {
-            $primaryKeyColumn = $primaryKeyColumns[0];
-            $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType());
-            $str .= "
+		if (count($primaryKeyColumns) === 1) {
+			$primaryKeyColumn = $primaryKeyColumns[0];
+			$primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType());
+			$str .= "
     /**
      * Get $beanClassWithoutNameSpace specified by its ID (its primary key)
      * If the primary key does not exist, an exception is thrown.
@@ -320,8 +320,8 @@ 
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
     }
     ";
-        }
-        $str .= "
+		}
+		$str .= "
     /**
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
      *
@@ -421,19 +421,19 @@ 
     }
 ";
 
-        $str .= $findByDaoCode;
-        $str .= '}
+		$str .= $findByDaoCode;
+		$str .= '}
 ';
 
-        $possibleBaseFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\Generated\\'.$baseClassName)->getPathname();
+		$possibleBaseFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\Generated\\'.$baseClassName)->getPathname();
 
-        $this->dumpFile($possibleBaseFileName, $str);
+		$this->dumpFile($possibleBaseFileName, $str);
 
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\'.$className)->getPathname();
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($daonamespace.'\\'.$className)->getPathname();
 
-        // Now, let's generate the "editable" class
-        if (!file_exists($possibleFileName)) {
-            $str = "<?php
+		// Now, let's generate the "editable" class
+		if (!file_exists($possibleFileName)) {
+			$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -451,24 +451,24 @@ 
 {
 }
 ";
-            $this->dumpFile($possibleFileName, $str);
-        }
-    }
+			$this->dumpFile($possibleFileName, $str);
+		}
+	}
 
-    /**
-     * Generates the factory bean.
-     *
-     * @param Table[] $tableList
-     * @throws TDBMException
-     */
-    private function generateFactory(array $tableList) : void
-    {
-        $daoNamespace = $this->configuration->getDaoNamespace();
-        $daoFactoryClassName = $this->namingStrategy->getDaoFactoryClassName();
+	/**
+	 * Generates the factory bean.
+	 *
+	 * @param Table[] $tableList
+	 * @throws TDBMException
+	 */
+	private function generateFactory(array $tableList) : void
+	{
+		$daoNamespace = $this->configuration->getDaoNamespace();
+		$daoFactoryClassName = $this->namingStrategy->getDaoFactoryClassName();
 
-        // For each table, let's write a property.
+		// For each table, let's write a property.
 
-        $str = "<?php
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -478,13 +478,13 @@ 
 namespace {$daoNamespace}\\Generated;
 
 ";
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $str .= "use {$daoNamespace}\\".$daoClassName.";\n";
-        }
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->namingStrategy->getDaoClassName($tableName);
+			$str .= "use {$daoNamespace}\\".$daoClassName.";\n";
+		}
 
-        $str .= "
+		$str .= "
 /**
  * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM.
  *
@@ -493,12 +493,12 @@ 
 {
 ";
 
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->namingStrategy->getDaoClassName($tableName);
-            $daoInstanceName = self::toVariableName($daoClassName);
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->namingStrategy->getDaoClassName($tableName);
+			$daoInstanceName = self::toVariableName($daoClassName);
 
-            $str .= '    /**
+			$str .= '    /**
      * @var '.$daoClassName.'
      */
     private $'.$daoInstanceName.';
@@ -522,131 +522,131 @@ 
     {
         $this->'.$daoInstanceName.' = $'.$daoInstanceName.';
     }';
-        }
+		}
 
-        $str .= '
+		$str .= '
 }
 ';
 
-        $possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
-
-        $this->dumpFile($possibleFileName, $str);
-    }
-
-    /**
-     * Transforms a string to camelCase (except the first letter will be uppercase too).
-     * Underscores and spaces are removed and the first letter after the underscore is uppercased.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toCamelCase($str)
-    {
-        $str = strtoupper(substr($str, 0, 1)).substr($str, 1);
-        while (true) {
-            if (strpos($str, '_') === false && strpos($str, ' ') === false) {
-                break;
-            }
-
-            $pos = strpos($str, '_');
-            if ($pos === false) {
-                $pos = strpos($str, ' ');
-            }
-            $before = substr($str, 0, $pos);
-            $after = substr($str, $pos + 1);
-            $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
-        }
-
-        return $str;
-    }
-
-    /**
-     * Tries to put string to the singular form (if it is plural).
-     * We assume the table names are in english.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toSingular($str)
-    {
-        return Inflector::singularize($str);
-    }
-
-    /**
-     * Put the first letter of the string in lower case.
-     * Very useful to transform a class name into a variable name.
-     *
-     * @param $str string
-     *
-     * @return string
-     */
-    public static function toVariableName($str)
-    {
-        return strtolower(substr($str, 0, 1)).substr($str, 1);
-    }
-
-    /**
-     * Ensures the file passed in parameter can be written in its directory.
-     *
-     * @param string $fileName
-     *
-     * @throws TDBMException
-     */
-    private function ensureDirectoryExist(string $fileName)
-    {
-        $dirName = dirname($fileName);
-        if (!file_exists($dirName)) {
-            $old = umask(0);
-            $result = mkdir($dirName, 0775, true);
-            umask($old);
-            if ($result === false) {
-                throw new TDBMException("Unable to create directory: '".$dirName."'.");
-            }
-        }
-    }
-
-    private function dumpFile(string $fileName, string $content) : void
-    {
-        $this->ensureDirectoryExist($fileName);
-        $fileSystem = new Filesystem();
-        $fileSystem->dumpFile($fileName, $content);
-        @chmod($fileName, 0664);
-    }
-
-    /**
-     * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
-     *
-     * @param Type $type The DBAL type
-     *
-     * @return string The PHP type
-     */
-    public static function dbalTypeToPhpType(Type $type)
-    {
-        $map = [
-            Type::TARRAY => 'array',
-            Type::SIMPLE_ARRAY => 'array',
-            'json' => 'array',  // 'json' is supported from Doctrine DBAL 2.6 only.
-            Type::JSON_ARRAY => 'array',
-            Type::BIGINT => 'string',
-            Type::BOOLEAN => 'bool',
-            Type::DATETIME => '\DateTimeInterface',
-            Type::DATETIMETZ => '\DateTimeInterface',
-            Type::DATE => '\DateTimeInterface',
-            Type::TIME => '\DateTimeInterface',
-            Type::DECIMAL => 'float',
-            Type::INTEGER => 'int',
-            Type::OBJECT => 'string',
-            Type::SMALLINT => 'int',
-            Type::STRING => 'string',
-            Type::TEXT => 'string',
-            Type::BINARY => 'string',
-            Type::BLOB => 'string',
-            Type::FLOAT => 'float',
-            Type::GUID => 'string',
-        ];
-
-        return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
-    }
+		$possibleFileName = $this->configuration->getPathFinder()->getPath($daoNamespace.'\\Generated\\'.$daoFactoryClassName)->getPathname();
+
+		$this->dumpFile($possibleFileName, $str);
+	}
+
+	/**
+	 * Transforms a string to camelCase (except the first letter will be uppercase too).
+	 * Underscores and spaces are removed and the first letter after the underscore is uppercased.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toCamelCase($str)
+	{
+		$str = strtoupper(substr($str, 0, 1)).substr($str, 1);
+		while (true) {
+			if (strpos($str, '_') === false && strpos($str, ' ') === false) {
+				break;
+			}
+
+			$pos = strpos($str, '_');
+			if ($pos === false) {
+				$pos = strpos($str, ' ');
+			}
+			$before = substr($str, 0, $pos);
+			$after = substr($str, $pos + 1);
+			$str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
+		}
+
+		return $str;
+	}
+
+	/**
+	 * Tries to put string to the singular form (if it is plural).
+	 * We assume the table names are in english.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toSingular($str)
+	{
+		return Inflector::singularize($str);
+	}
+
+	/**
+	 * Put the first letter of the string in lower case.
+	 * Very useful to transform a class name into a variable name.
+	 *
+	 * @param $str string
+	 *
+	 * @return string
+	 */
+	public static function toVariableName($str)
+	{
+		return strtolower(substr($str, 0, 1)).substr($str, 1);
+	}
+
+	/**
+	 * Ensures the file passed in parameter can be written in its directory.
+	 *
+	 * @param string $fileName
+	 *
+	 * @throws TDBMException
+	 */
+	private function ensureDirectoryExist(string $fileName)
+	{
+		$dirName = dirname($fileName);
+		if (!file_exists($dirName)) {
+			$old = umask(0);
+			$result = mkdir($dirName, 0775, true);
+			umask($old);
+			if ($result === false) {
+				throw new TDBMException("Unable to create directory: '".$dirName."'.");
+			}
+		}
+	}
+
+	private function dumpFile(string $fileName, string $content) : void
+	{
+		$this->ensureDirectoryExist($fileName);
+		$fileSystem = new Filesystem();
+		$fileSystem->dumpFile($fileName, $content);
+		@chmod($fileName, 0664);
+	}
+
+	/**
+	 * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
+	 *
+	 * @param Type $type The DBAL type
+	 *
+	 * @return string The PHP type
+	 */
+	public static function dbalTypeToPhpType(Type $type)
+	{
+		$map = [
+			Type::TARRAY => 'array',
+			Type::SIMPLE_ARRAY => 'array',
+			'json' => 'array',  // 'json' is supported from Doctrine DBAL 2.6 only.
+			Type::JSON_ARRAY => 'array',
+			Type::BIGINT => 'string',
+			Type::BOOLEAN => 'bool',
+			Type::DATETIME => '\DateTimeInterface',
+			Type::DATETIMETZ => '\DateTimeInterface',
+			Type::DATE => '\DateTimeInterface',
+			Type::TIME => '\DateTimeInterface',
+			Type::DECIMAL => 'float',
+			Type::INTEGER => 'int',
+			Type::OBJECT => 'string',
+			Type::SMALLINT => 'int',
+			Type::STRING => 'string',
+			Type::TEXT => 'string',
+			Type::BINARY => 'string',
+			Type::BLOB => 'string',
+			Type::FLOAT => 'float',
+			Type::GUID => 'string',
+		];
+
+		return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
+	}
 }

src/Mouf/Database/TDBM/Utils/ScalarBeanPropertyDescriptor.php

Indentation +180 added lines, -180 removed lines

@@ -11,136 +11,136 @@ 
  */
 class ScalarBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor
 {
-    /**
-     * @var Column
-     */
-    private $column;
-    /**
-     * @var NamingStrategyInterface
-     */
-    private $namingStrategy;
-
-    /**
-     * ScalarBeanPropertyDescriptor constructor.
-     * @param Table $table
-     * @param Column $column
-     * @param NamingStrategyInterface $namingStrategy
-     */
-    public function __construct(Table $table, Column $column, NamingStrategyInterface $namingStrategy)
-    {
-        parent::__construct($table);
-        $this->table = $table;
-        $this->column = $column;
-        $this->namingStrategy = $namingStrategy;
-    }
-
-    /**
-     * Returns the foreign-key the column is part of, if any. null otherwise.
-     *
-     * @return ForeignKeyConstraint|null
-     */
-    public function getForeignKey()
-    {
-        return false;
-    }
-
-    /**
-     * Returns the param annotation for this property (useful for constructor).
-     *
-     * @return string
-     */
-    public function getParamAnnotation()
-    {
-        $className = $this->getClassName();
-        $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType());
-
-        $str = '     * @param %s %s';
-
-        return sprintf($str, $paramType, $this->getVariableName());
-    }
-
-    public function getUpperCamelCaseName()
-    {
-        return TDBMDaoGenerator::toCamelCase($this->column->getName());
-    }
-
-    /**
-     * Returns the name of the class linked to this property or null if this is not a foreign key.
-     *
-     * @return null|string
-     */
-    public function getClassName()
-    {
-        return;
-    }
-
-    /**
-     * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
-     *
-     * @return bool
-     */
-    public function isCompulsory()
-    {
-        return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null;
-    }
-
-    /**
-     * Returns true if the property has a default value.
-     *
-     * @return bool
-     */
-    public function hasDefault()
-    {
-        return $this->column->getDefault() !== null;
-    }
-
-    /**
-     * Returns the code that assigns a value to its default value.
-     *
-     * @return string
-     */
-    public function assignToDefaultCode()
-    {
-        $str = '        $this->%s(%s);';
-
-        $default = $this->column->getDefault();
-
-        if (strtoupper($default) === 'CURRENT_TIMESTAMP') {
-            $defaultCode = 'new \DateTimeImmutable()';
-        } else {
-            $defaultCode = var_export($this->column->getDefault(), true);
-        }
-
-        return sprintf($str, $this->getSetterName(), $defaultCode);
-    }
-
-    /**
-     * Returns true if the property is the primary key.
-     *
-     * @return bool
-     */
-    public function isPrimaryKey()
-    {
-        return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns());
-    }
-
-    /**
-     * Returns the PHP code for getters and setters.
-     *
-     * @return string
-     */
-    public function getGetterSetterCode()
-    {
-        $type = $this->column->getType();
-        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
-
-        $columnGetterName = $this->getGetterName();
-        $columnSetterName = $this->getSetterName();
-
-        // A column type can be forced if it is not nullable and not auto-incrementable (for auto-increment columns, we can get "null" as long as the bean is not saved).
-        $isNullable = !$this->column->getNotnull() || $this->column->getAutoincrement();
-
-        $getterAndSetterCode = '    /**
+	/**
+	 * @var Column
+	 */
+	private $column;
+	/**
+	 * @var NamingStrategyInterface
+	 */
+	private $namingStrategy;
+
+	/**
+	 * ScalarBeanPropertyDescriptor constructor.
+	 * @param Table $table
+	 * @param Column $column
+	 * @param NamingStrategyInterface $namingStrategy
+	 */
+	public function __construct(Table $table, Column $column, NamingStrategyInterface $namingStrategy)
+	{
+		parent::__construct($table);
+		$this->table = $table;
+		$this->column = $column;
+		$this->namingStrategy = $namingStrategy;
+	}
+
+	/**
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
+	 *
+	 * @return ForeignKeyConstraint|null
+	 */
+	public function getForeignKey()
+	{
+		return false;
+	}
+
+	/**
+	 * Returns the param annotation for this property (useful for constructor).
+	 *
+	 * @return string
+	 */
+	public function getParamAnnotation()
+	{
+		$className = $this->getClassName();
+		$paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType());
+
+		$str = '     * @param %s %s';
+
+		return sprintf($str, $paramType, $this->getVariableName());
+	}
+
+	public function getUpperCamelCaseName()
+	{
+		return TDBMDaoGenerator::toCamelCase($this->column->getName());
+	}
+
+	/**
+	 * Returns the name of the class linked to this property or null if this is not a foreign key.
+	 *
+	 * @return null|string
+	 */
+	public function getClassName()
+	{
+		return;
+	}
+
+	/**
+	 * Returns true if the property is compulsory (and therefore should be fetched in the constructor).
+	 *
+	 * @return bool
+	 */
+	public function isCompulsory()
+	{
+		return $this->column->getNotnull() && !$this->column->getAutoincrement() && $this->column->getDefault() === null;
+	}
+
+	/**
+	 * Returns true if the property has a default value.
+	 *
+	 * @return bool
+	 */
+	public function hasDefault()
+	{
+		return $this->column->getDefault() !== null;
+	}
+
+	/**
+	 * Returns the code that assigns a value to its default value.
+	 *
+	 * @return string
+	 */
+	public function assignToDefaultCode()
+	{
+		$str = '        $this->%s(%s);';
+
+		$default = $this->column->getDefault();
+
+		if (strtoupper($default) === 'CURRENT_TIMESTAMP') {
+			$defaultCode = 'new \DateTimeImmutable()';
+		} else {
+			$defaultCode = var_export($this->column->getDefault(), true);
+		}
+
+		return sprintf($str, $this->getSetterName(), $defaultCode);
+	}
+
+	/**
+	 * Returns true if the property is the primary key.
+	 *
+	 * @return bool
+	 */
+	public function isPrimaryKey()
+	{
+		return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns());
+	}
+
+	/**
+	 * Returns the PHP code for getters and setters.
+	 *
+	 * @return string
+	 */
+	public function getGetterSetterCode()
+	{
+		$type = $this->column->getType();
+		$normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
+
+		$columnGetterName = $this->getGetterName();
+		$columnSetterName = $this->getSetterName();
+
+		// A column type can be forced if it is not nullable and not auto-incrementable (for auto-increment columns, we can get "null" as long as the bean is not saved).
+		$isNullable = !$this->column->getNotnull() || $this->column->getAutoincrement();
+
+		$getterAndSetterCode = '    /**
      * The getter for the "%s" column.
      *
      * @return %s
@@ -162,54 +162,54 @@ 
 
 ';
 
-        return sprintf($getterAndSetterCode,
-            // Getter
-            $this->column->getName(),
-            $normalizedType.($isNullable ? '|null' : ''),
-            $columnGetterName,
-            ($isNullable ? '?' : ''),
-            $normalizedType,
-            var_export($this->column->getName(), true),
-            var_export($this->table->getName(), true),
-            // Setter
-            $this->column->getName(),
-            $normalizedType,
-            $this->column->getName(),
-            $columnSetterName,
-            $this->column->getNotnull() ? '' : '?',
-            $normalizedType,
-                //$castTo,
-            $this->column->getName(),
-            var_export($this->column->getName(), true),
-            $this->column->getName(),
-            var_export($this->table->getName(), true)
-        );
-    }
-
-    /**
-     * Returns the part of code useful when doing json serialization.
-     *
-     * @return string
-     */
-    public function getJsonSerializeCode()
-    {
-        $type = $this->column->getType();
-        $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
-
-        if ($normalizedType == '\\DateTimeInterface') {
-            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null) ? null : $this->'.$this->getGetterName()."()->format('c');\n";
-        } else {
-            return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n";
-        }
-    }
-
-    /**
-     * Returns the column name.
-     *
-     * @return string
-     */
-    public function getColumnName()
-    {
-        return $this->column->getName();
-    }
+		return sprintf($getterAndSetterCode,
+			// Getter
+			$this->column->getName(),
+			$normalizedType.($isNullable ? '|null' : ''),
+			$columnGetterName,
+			($isNullable ? '?' : ''),
+			$normalizedType,
+			var_export($this->column->getName(), true),
+			var_export($this->table->getName(), true),
+			// Setter
+			$this->column->getName(),
+			$normalizedType,
+			$this->column->getName(),
+			$columnSetterName,
+			$this->column->getNotnull() ? '' : '?',
+			$normalizedType,
+				//$castTo,
+			$this->column->getName(),
+			var_export($this->column->getName(), true),
+			$this->column->getName(),
+			var_export($this->table->getName(), true)
+		);
+	}
+
+	/**
+	 * Returns the part of code useful when doing json serialization.
+	 *
+	 * @return string
+	 */
+	public function getJsonSerializeCode()
+	{
+		$type = $this->column->getType();
+		$normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type);
+
+		if ($normalizedType == '\\DateTimeInterface') {
+			return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = ($this->'.$this->getGetterName().'() === null) ? null : $this->'.$this->getGetterName()."()->format('c');\n";
+		} else {
+			return '        $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n";
+		}
+	}
+
+	/**
+	 * Returns the column name.
+	 *
+	 * @return string
+	 */
+	public function getColumnName()
+	{
+		return $this->column->getName();
+	}
 }

src/Mouf/Database/TDBM/Utils/PivotTableMethodsDescriptor.php

Indentation +136 added lines, -136 removed lines

@@ -7,105 +7,105 @@ 
 
 class PivotTableMethodsDescriptor implements MethodDescriptorInterface
 {
-    /**
-     * @var Table
-     */
-    private $pivotTable;
-
-    private $useAlternateName = false;
-
-    /**
-     * @var ForeignKeyConstraint
-     */
-    private $localFk;
-
-    /**
-     * @var ForeignKeyConstraint
-     */
-    private $remoteFk;
-    /**
-     * @var NamingStrategyInterface
-     */
-    private $namingStrategy;
-
-    /**
-     * @param Table $pivotTable The pivot table
-     * @param ForeignKeyConstraint $localFk
-     * @param ForeignKeyConstraint $remoteFk
-     * @param NamingStrategyInterface $namingStrategy
-     */
-    public function __construct(Table $pivotTable, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk, NamingStrategyInterface $namingStrategy)
-    {
-        $this->pivotTable = $pivotTable;
-        $this->localFk = $localFk;
-        $this->remoteFk = $remoteFk;
-        $this->namingStrategy = $namingStrategy;
-    }
-
-    /**
-     * Requests the use of an alternative name for this method.
-     */
-    public function useAlternativeName()
-    {
-        $this->useAlternateName = true;
-    }
-
-    /**
-     * Returns the name of the method to be generated.
-     *
-     * @return string
-     */
-    public function getName() : string
-    {
-        if (!$this->useAlternateName) {
-            return 'get'.TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName());
-        } else {
-            return 'get'.TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
-        }
-    }
-
-    /**
-     * Returns the plural name.
-     *
-     * @return string
-     */
-    private function getPluralName() : string
-    {
-        if (!$this->useAlternateName) {
-            return TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName());
-        } else {
-            return TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
-        }
-    }
-
-    /**
-     * Returns the singular name.
-     *
-     * @return string
-     */
-    private function getSingularName() : string
-    {
-        if (!$this->useAlternateName) {
-            return TDBMDaoGenerator::toCamelCase(TDBMDaoGenerator::toSingular($this->remoteFk->getForeignTableName()));
-        } else {
-            return TDBMDaoGenerator::toCamelCase(TDBMDaoGenerator::toSingular($this->remoteFk->getForeignTableName())).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
-        }
-    }
-
-    /**
-     * Returns the code of the method.
-     *
-     * @return string
-     */
-    public function getCode() : string
-    {
-        $singularName = $this->getSingularName();
-        $pluralName = $this->getPluralName();
-        $remoteBeanName = $this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName());
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
-        $pluralVariableName = $variableName.'s';
-
-        $str = '    /**
+	/**
+	 * @var Table
+	 */
+	private $pivotTable;
+
+	private $useAlternateName = false;
+
+	/**
+	 * @var ForeignKeyConstraint
+	 */
+	private $localFk;
+
+	/**
+	 * @var ForeignKeyConstraint
+	 */
+	private $remoteFk;
+	/**
+	 * @var NamingStrategyInterface
+	 */
+	private $namingStrategy;
+
+	/**
+	 * @param Table $pivotTable The pivot table
+	 * @param ForeignKeyConstraint $localFk
+	 * @param ForeignKeyConstraint $remoteFk
+	 * @param NamingStrategyInterface $namingStrategy
+	 */
+	public function __construct(Table $pivotTable, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk, NamingStrategyInterface $namingStrategy)
+	{
+		$this->pivotTable = $pivotTable;
+		$this->localFk = $localFk;
+		$this->remoteFk = $remoteFk;
+		$this->namingStrategy = $namingStrategy;
+	}
+
+	/**
+	 * Requests the use of an alternative name for this method.
+	 */
+	public function useAlternativeName()
+	{
+		$this->useAlternateName = true;
+	}
+
+	/**
+	 * Returns the name of the method to be generated.
+	 *
+	 * @return string
+	 */
+	public function getName() : string
+	{
+		if (!$this->useAlternateName) {
+			return 'get'.TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName());
+		} else {
+			return 'get'.TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
+		}
+	}
+
+	/**
+	 * Returns the plural name.
+	 *
+	 * @return string
+	 */
+	private function getPluralName() : string
+	{
+		if (!$this->useAlternateName) {
+			return TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName());
+		} else {
+			return TDBMDaoGenerator::toCamelCase($this->remoteFk->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
+		}
+	}
+
+	/**
+	 * Returns the singular name.
+	 *
+	 * @return string
+	 */
+	private function getSingularName() : string
+	{
+		if (!$this->useAlternateName) {
+			return TDBMDaoGenerator::toCamelCase(TDBMDaoGenerator::toSingular($this->remoteFk->getForeignTableName()));
+		} else {
+			return TDBMDaoGenerator::toCamelCase(TDBMDaoGenerator::toSingular($this->remoteFk->getForeignTableName())).'By'.TDBMDaoGenerator::toCamelCase($this->pivotTable->getName());
+		}
+	}
+
+	/**
+	 * Returns the code of the method.
+	 *
+	 * @return string
+	 */
+	public function getCode() : string
+	{
+		$singularName = $this->getSingularName();
+		$pluralName = $this->getPluralName();
+		$remoteBeanName = $this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName());
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
+		$pluralVariableName = $variableName.'s';
+
+		$str = '    /**
      * Returns the list of %s associated to this bean via the %s pivot table.
      *
      * @return %s[]
@@ -116,9 +116,9 @@ 
     }
 ';
 
-        $getterCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $pluralName, var_export($this->remoteFk->getLocalTableName(), true));
+		$getterCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $pluralName, var_export($this->remoteFk->getLocalTableName(), true));
 
-        $str = '    /**
+		$str = '    /**
      * Adds a relationship with %s associated to this bean via the %s pivot table.
      *
      * @param %s %s
@@ -129,9 +129,9 @@ 
     }
 ';
 
-        $adderCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
+		$adderCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
 
-        $str = '    /**
+		$str = '    /**
      * Deletes the relationship with %s associated to this bean via the %s pivot table.
      *
      * @param %s %s
@@ -142,9 +142,9 @@ 
     }
 ';
 
-        $removerCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
+		$removerCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
 
-        $str = '    /**
+		$str = '    /**
      * Returns whether this bean is associated with %s via the %s pivot table.
      *
      * @param %s %s
@@ -156,9 +156,9 @@ 
     }
 ';
 
-        $hasCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
+		$hasCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($this->remoteFk->getLocalTableName(), true), $variableName);
 
-        $str = '    /**
+		$str = '    /**
      * Sets all relationships with %s associated to this bean via the %s pivot table.
      * Exiting relationships will be removed and replaced by the provided relationships.
      *
@@ -170,38 +170,38 @@ 
     }
 ';
 
-        $setterCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($this->remoteFk->getLocalTableName(), true), $pluralVariableName);
-
-        $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode;
-
-        return $code;
-    }
-
-    /**
-     * Returns an array of classes that needs a "use" for this method.
-     *
-     * @return string[]
-     */
-    public function getUsedClasses() : array
-    {
-        return [$this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName())];
-    }
-
-    /**
-     * Returns the code to past in jsonSerialize.
-     *
-     * @return string
-     */
-    public function getJsonSerializeCode() : string
-    {
-        $remoteBeanName = $this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName());
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
-
-        return '        if (!$stopRecursion) {
+		$setterCode = sprintf($str, $remoteBeanName, $this->pivotTable->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($this->remoteFk->getLocalTableName(), true), $pluralVariableName);
+
+		$code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode;
+
+		return $code;
+	}
+
+	/**
+	 * Returns an array of classes that needs a "use" for this method.
+	 *
+	 * @return string[]
+	 */
+	public function getUsedClasses() : array
+	{
+		return [$this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName())];
+	}
+
+	/**
+	 * Returns the code to past in jsonSerialize.
+	 *
+	 * @return string
+	 */
+	public function getJsonSerializeCode() : string
+	{
+		$remoteBeanName = $this->namingStrategy->getBeanClassName($this->remoteFk->getForeignTableName());
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
+
+		return '        if (!$stopRecursion) {
             $array[\''.lcfirst($this->getPluralName()).'\'] = array_map(function ('.$remoteBeanName.' '.$variableName.') {
                 return '.$variableName.'->jsonSerialize(true);
             }, $this->'.$this->getName().'());
         }
 ';
-    }
+	}
 }

src/Mouf/Database/TDBM/Utils/GeneratorEventDispatcher.php

Indentation +22 added lines, -22 removed lines

@@ -7,28 +7,28 @@
 
 class GeneratorEventDispatcher implements GeneratorListenerInterface
 {
-    /**
-     * @var GeneratorListenerInterface[]
-     */
-    private $listeners;
+	/**
+	 * @var GeneratorListenerInterface[]
+	 */
+	private $listeners;
 
-    /**
-     * GeneratorEventDispatcher constructor.
-     * @param GeneratorListenerInterface[] $listeners
-     */
-    public function __construct(array $listeners)
-    {
-        $this->listeners = $listeners;
-    }
+	/**
+	 * GeneratorEventDispatcher constructor.
+	 * @param GeneratorListenerInterface[] $listeners
+	 */
+	public function __construct(array $listeners)
+	{
+		$this->listeners = $listeners;
+	}
 
-    /**
-     * @param ConfigurationInterface $configuration
-     * @param BeanDescriptorInterface[] $beanDescriptors
-     */
-    public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void
-    {
-        foreach ($this->listeners as $listener) {
-            $listener->onGenerate($configuration, $beanDescriptors);
-        }
-    }
+	/**
+	 * @param ConfigurationInterface $configuration
+	 * @param BeanDescriptorInterface[] $beanDescriptors
+	 */
+	public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void
+	{
+		foreach ($this->listeners as $listener) {
+			$listener->onGenerate($configuration, $beanDescriptors);
+		}
+	}
 }

src/Mouf/Database/TDBM/Utils/VoidListener.php

Indentation +8 added lines, -8 removed lines

@@ -11,12 +11,12 @@
 class VoidListener implements GeneratorListenerInterface
 {
 
-    /**
-     * @param ConfigurationInterface $configuration
-     * @param BeanDescriptorInterface[] $beanDescriptors
-     */
-    public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void
-    {
-        // Let's do nothing.
-    }
+	/**
+	 * @param ConfigurationInterface $configuration
+	 * @param BeanDescriptorInterface[] $beanDescriptors
+	 */
+	public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void
+	{
+		// Let's do nothing.
+	}
 }