thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/DbRow.php

Indentation +379 added lines, -379 removed lines

@@ -27,170 +27,170 @@ 
  */
 class DbRow
 {
-    /**
-     * The service this object is bound to.
-     *
-     * @var TDBMService
-     */
-    protected $tdbmService;
-
-    /**
-     * The object containing this db row.
-     *
-     * @var AbstractTDBMObject
-     */
-    private $object;
-
-    /**
-     * The name of the table the object if issued from.
-     *
-     * @var string
-     */
-    private $dbTableName;
-
-    /**
-     * The array of columns returned from database.
-     *
-     * @var array
-     */
-    private $dbRow = array();
-
-    /**
-     * @var AbstractTDBMObject[]
-     */
-    private $references = array();
-
-    /**
-     * 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;
-
-    /**
-     * The values of the primary key.
-     * This is set when the object is in "loaded" state.
-     *
-     * @var array An array of column => value
-     */
-    private $primaryKeys;
-
-    /**
-     * You should never call the constructor directly. Instead, you should use the
-     * TDBMService class that will create TDBMObjects for you.
-     *
-     * Used with id!=false when we want to retrieve an existing object
-     * and id==false if we want a new object
-     *
-     * @param AbstractTDBMObject $object      The object containing this db row
-     * @param string             $table_name
-     * @param array              $primaryKeys
-     * @param TDBMService        $tdbmService
-     *
-     * @throws TDBMException
-     * @throws TDBMInvalidOperationException
-     */
-    public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
-    {
-        $this->object = $object;
-        $this->dbTableName = $table_name;
-
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
-
-        if ($tdbmService === null) {
-            if (!empty($primaryKeys)) {
-                throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
-            }
-        } else {
-            $this->tdbmService = $tdbmService;
-
-            if (!empty($primaryKeys)) {
-                $this->_setPrimaryKeys($primaryKeys);
-                if (!empty($dbRow)) {
-                    $this->dbRow = $dbRow;
-                    $this->status = TDBMObjectStateEnum::STATE_LOADED;
-                } else {
-                    $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
-                }
-                $tdbmService->_addToCache($this);
-            } else {
-                $this->status = TDBMObjectStateEnum::STATE_NEW;
-                $this->tdbmService->_addToToSaveObjectList($this);
-            }
-        }
-    }
-
-    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;
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
-        $this->tdbmService->_addToToSaveObjectList($this);
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
-     * If the object is in state 'not loaded', this method performs a query in database to load the object.
-     *
-     * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
-     * cannot be found).
-     */
-    public function _dbLoadIfNotLoaded()
-    {
-        if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
-            $connection = $this->tdbmService->getConnection();
-
-            /// buildFilterFromFilterBag($filter_bag)
-            list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
-
-            $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
-            $result = $connection->executeQuery($sql, $parameters);
-
-            if ($result->rowCount() === 0) {
-                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
-            }
-
-            $row = $result->fetch(\PDO::FETCH_ASSOC);
-
-            $this->dbRow = [];
-            $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
-
-            foreach ($row as $key => $value) {
-                $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
-            }
-
-            $result->closeCursor();
-
-            $this->status = TDBMObjectStateEnum::STATE_LOADED;
-        }
-    }
-
-    public function get($var)
-    {
-        $this->_dbLoadIfNotLoaded();
-
-        // Let's first check if the key exist.
-        if (!isset($this->dbRow[$var])) {
-            /*
+	/**
+	 * The service this object is bound to.
+	 *
+	 * @var TDBMService
+	 */
+	protected $tdbmService;
+
+	/**
+	 * The object containing this db row.
+	 *
+	 * @var AbstractTDBMObject
+	 */
+	private $object;
+
+	/**
+	 * The name of the table the object if issued from.
+	 *
+	 * @var string
+	 */
+	private $dbTableName;
+
+	/**
+	 * The array of columns returned from database.
+	 *
+	 * @var array
+	 */
+	private $dbRow = array();
+
+	/**
+	 * @var AbstractTDBMObject[]
+	 */
+	private $references = array();
+
+	/**
+	 * 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;
+
+	/**
+	 * The values of the primary key.
+	 * This is set when the object is in "loaded" state.
+	 *
+	 * @var array An array of column => value
+	 */
+	private $primaryKeys;
+
+	/**
+	 * You should never call the constructor directly. Instead, you should use the
+	 * TDBMService class that will create TDBMObjects for you.
+	 *
+	 * Used with id!=false when we want to retrieve an existing object
+	 * and id==false if we want a new object
+	 *
+	 * @param AbstractTDBMObject $object      The object containing this db row
+	 * @param string             $table_name
+	 * @param array              $primaryKeys
+	 * @param TDBMService        $tdbmService
+	 *
+	 * @throws TDBMException
+	 * @throws TDBMInvalidOperationException
+	 */
+	public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
+	{
+		$this->object = $object;
+		$this->dbTableName = $table_name;
+
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
+
+		if ($tdbmService === null) {
+			if (!empty($primaryKeys)) {
+				throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
+			}
+		} else {
+			$this->tdbmService = $tdbmService;
+
+			if (!empty($primaryKeys)) {
+				$this->_setPrimaryKeys($primaryKeys);
+				if (!empty($dbRow)) {
+					$this->dbRow = $dbRow;
+					$this->status = TDBMObjectStateEnum::STATE_LOADED;
+				} else {
+					$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
+				}
+				$tdbmService->_addToCache($this);
+			} else {
+				$this->status = TDBMObjectStateEnum::STATE_NEW;
+				$this->tdbmService->_addToToSaveObjectList($this);
+			}
+		}
+	}
+
+	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;
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
+		$this->tdbmService->_addToToSaveObjectList($this);
+	}
+
+	/**
+	 * 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;
+	}
+
+	/**
+	 * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
+	 * If the object is in state 'not loaded', this method performs a query in database to load the object.
+	 *
+	 * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
+	 * cannot be found).
+	 */
+	public function _dbLoadIfNotLoaded()
+	{
+		if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
+			$connection = $this->tdbmService->getConnection();
+
+			/// buildFilterFromFilterBag($filter_bag)
+			list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
+
+			$sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
+			$result = $connection->executeQuery($sql, $parameters);
+
+			if ($result->rowCount() === 0) {
+				throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
+			}
+
+			$row = $result->fetch(\PDO::FETCH_ASSOC);
+
+			$this->dbRow = [];
+			$types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
+
+			foreach ($row as $key => $value) {
+				$this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
+			}
+
+			$result->closeCursor();
+
+			$this->status = TDBMObjectStateEnum::STATE_LOADED;
+		}
+	}
+
+	public function get($var)
+	{
+		$this->_dbLoadIfNotLoaded();
+
+		// Let's first check if the key exist.
+		if (!isset($this->dbRow[$var])) {
+			/*
             // Unable to find column.... this is an error if the object has been retrieved from database.
             // If it's a new object, well, that may not be an error after all!
             // Let's check if the column does exist in the table
@@ -210,39 +210,39 @@ 
             $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
 
             throw new TDBMException($str);*/
-            return;
-        }
-
-        $value = $this->dbRow[$var];
-        if ($value instanceof \DateTime) {
-            if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
-                return \DateTimeImmutable::createFromMutable($value);
-            } else {
-                return new \DateTimeImmutable($value->format('c'));
-            }
-        }
-
-        return $this->dbRow[$var];
-    }
-
-    /**
-     * Returns true if a column is set, false otherwise.
-     *
-     * @param string $var
-     *
-     * @return bool
-     */
-    /*public function has($var) {
+			return;
+		}
+
+		$value = $this->dbRow[$var];
+		if ($value instanceof \DateTime) {
+			if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
+				return \DateTimeImmutable::createFromMutable($value);
+			} else {
+				return new \DateTimeImmutable($value->format('c'));
+			}
+		}
+
+		return $this->dbRow[$var];
+	}
+
+	/**
+	 * Returns true if a column is set, false otherwise.
+	 *
+	 * @param string $var
+	 *
+	 * @return bool
+	 */
+	/*public function has($var) {
         $this->_dbLoadIfNotLoaded();
 
         return isset($this->dbRow[$var]);
     }*/
 
-    public function set($var, $value)
-    {
-        $this->_dbLoadIfNotLoaded();
+	public function set($var, $value)
+	{
+		$this->_dbLoadIfNotLoaded();
 
-        /*
+		/*
         // Ok, let's start by checking the column type
         $type = $this->db_connection->getColumnType($this->dbTableName, $var);
 
@@ -252,193 +252,193 @@ 
         }
         */
 
-        /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
+		/*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
             throw new TDBMException("Error! Changing primary key value is forbidden.");*/
-        $this->dbRow[$var] = $value;
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
-            $this->tdbmService->_addToToSaveObjectList($this);
-        }
-    }
-
-    /**
-     * @param string             $foreignKeyName
-     * @param AbstractTDBMObject $bean
-     */
-    public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
-    {
-        $this->references[$foreignKeyName] = $bean;
-
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
-            $this->tdbmService->_addToToSaveObjectList($this);
-        }
-    }
-
-    /**
-     * @param string $foreignKeyName A unique name for this reference
-     *
-     * @return AbstractTDBMObject|null
-     */
-    public function getRef($foreignKeyName)
-    {
-        if (array_key_exists($foreignKeyName, $this->references)) {
-            return $this->references[$foreignKeyName];
-        } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->tdbmService === null) {
-            // If the object is new and has no property, then it has to be empty.
-            return;
-        } else {
-            $this->_dbLoadIfNotLoaded();
-
-            // Let's match the name of the columns to the primary key values
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
-
-            $values = [];
-            foreach ($fk->getLocalColumns() as $column) {
-                if (!isset($this->dbRow[$column])) {
-                    return;
-                }
-                $values[] = $this->dbRow[$column];
-            }
-
-            $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
-
-            return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
-        }
-    }
-
-    /**
-     * Returns the name of the table this object comes from.
-     *
-     * @return string
-     */
-    public function _getDbTableName()
-    {
-        return $this->dbTableName;
-    }
-
-    /**
-     * 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 load the row (before we lose the ID!)
-        $this->_dbLoadIfNotLoaded();
-
-        //Let's set the status to detached
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
-
-        $this->primaryKeys = [];
-
-        //Now unset the PK from the row
-        if ($this->tdbmService) {
-            $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
-            foreach ($pk_array as $pk) {
-                $this->dbRow[$pk] = null;
-            }
-        }
-    }
-
-    /**
-     * Returns raw database row.
-     *
-     * @return array
-     */
-    public function _getDbRow()
-    {
-        // Let's merge $dbRow and $references
-        $dbRow = $this->dbRow;
-
-        foreach ($this->references as $foreignKeyName => $reference) {
-            // Let's match the name of the columns to the primary key values
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
-            $localColumns = $fk->getLocalColumns();
-
-            if ($reference !== null) {
-                $refDbRows = $reference->_getDbRows();
-                $firstRefDbRow = reset($refDbRows);
-                $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
-                    $dbRow[$localColumns[$i]] = $pkValues[$i];
-                }
-            } else {
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
-                    $dbRow[$localColumns[$i]] = null;
-                }
-            }
-        }
-
-        return $dbRow;
-    }
-
-    /**
-     * Returns references array.
-     *
-     * @return AbstractTDBMObject[]
-     */
-    public function _getReferences()
-    {
-        return $this->references;
-    }
-
-    /**
-     * Returns the values of the primary key.
-     * This is set when the object is in "loaded" state.
-     *
-     * @return array
-     */
-    public function _getPrimaryKeys()
-    {
-        return $this->primaryKeys;
-    }
-
-    /**
-     * Sets the values of the primary key.
-     * This is set when the object is in "loaded" state.
-     *
-     * @param array $primaryKeys
-     */
-    public function _setPrimaryKeys(array $primaryKeys)
-    {
-        $this->primaryKeys = $primaryKeys;
-        foreach ($this->primaryKeys as $column => $value) {
-            $this->dbRow[$column] = $value;
-        }
-    }
-
-    /**
-     * Returns the TDBMObject this bean is associated to.
-     *
-     * @return AbstractTDBMObject
-     */
-    public function getTDBMObject()
-    {
-        return $this->object;
-    }
-
-    /**
-     * Sets the TDBMObject this bean is associated to.
-     * Only used when cloning.
-     *
-     * @param AbstractTDBMObject $object
-     */
-    public function setTDBMObject(AbstractTDBMObject $object)
-    {
-        $this->object = $object;
-    }
+		$this->dbRow[$var] = $value;
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
+			$this->tdbmService->_addToToSaveObjectList($this);
+		}
+	}
+
+	/**
+	 * @param string             $foreignKeyName
+	 * @param AbstractTDBMObject $bean
+	 */
+	public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
+	{
+		$this->references[$foreignKeyName] = $bean;
+
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
+			$this->tdbmService->_addToToSaveObjectList($this);
+		}
+	}
+
+	/**
+	 * @param string $foreignKeyName A unique name for this reference
+	 *
+	 * @return AbstractTDBMObject|null
+	 */
+	public function getRef($foreignKeyName)
+	{
+		if (array_key_exists($foreignKeyName, $this->references)) {
+			return $this->references[$foreignKeyName];
+		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->tdbmService === null) {
+			// If the object is new and has no property, then it has to be empty.
+			return;
+		} else {
+			$this->_dbLoadIfNotLoaded();
+
+			// Let's match the name of the columns to the primary key values
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
+
+			$values = [];
+			foreach ($fk->getLocalColumns() as $column) {
+				if (!isset($this->dbRow[$column])) {
+					return;
+				}
+				$values[] = $this->dbRow[$column];
+			}
+
+			$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
+
+			return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
+		}
+	}
+
+	/**
+	 * Returns the name of the table this object comes from.
+	 *
+	 * @return string
+	 */
+	public function _getDbTableName()
+	{
+		return $this->dbTableName;
+	}
+
+	/**
+	 * 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 load the row (before we lose the ID!)
+		$this->_dbLoadIfNotLoaded();
+
+		//Let's set the status to detached
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
+
+		$this->primaryKeys = [];
+
+		//Now unset the PK from the row
+		if ($this->tdbmService) {
+			$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
+			foreach ($pk_array as $pk) {
+				$this->dbRow[$pk] = null;
+			}
+		}
+	}
+
+	/**
+	 * Returns raw database row.
+	 *
+	 * @return array
+	 */
+	public function _getDbRow()
+	{
+		// Let's merge $dbRow and $references
+		$dbRow = $this->dbRow;
+
+		foreach ($this->references as $foreignKeyName => $reference) {
+			// Let's match the name of the columns to the primary key values
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
+			$localColumns = $fk->getLocalColumns();
+
+			if ($reference !== null) {
+				$refDbRows = $reference->_getDbRows();
+				$firstRefDbRow = reset($refDbRows);
+				$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
+				for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
+					$dbRow[$localColumns[$i]] = $pkValues[$i];
+				}
+			} else {
+				for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
+					$dbRow[$localColumns[$i]] = null;
+				}
+			}
+		}
+
+		return $dbRow;
+	}
+
+	/**
+	 * Returns references array.
+	 *
+	 * @return AbstractTDBMObject[]
+	 */
+	public function _getReferences()
+	{
+		return $this->references;
+	}
+
+	/**
+	 * Returns the values of the primary key.
+	 * This is set when the object is in "loaded" state.
+	 *
+	 * @return array
+	 */
+	public function _getPrimaryKeys()
+	{
+		return $this->primaryKeys;
+	}
+
+	/**
+	 * Sets the values of the primary key.
+	 * This is set when the object is in "loaded" state.
+	 *
+	 * @param array $primaryKeys
+	 */
+	public function _setPrimaryKeys(array $primaryKeys)
+	{
+		$this->primaryKeys = $primaryKeys;
+		foreach ($this->primaryKeys as $column => $value) {
+			$this->dbRow[$column] = $value;
+		}
+	}
+
+	/**
+	 * Returns the TDBMObject this bean is associated to.
+	 *
+	 * @return AbstractTDBMObject
+	 */
+	public function getTDBMObject()
+	{
+		return $this->object;
+	}
+
+	/**
+	 * Sets the TDBMObject this bean is associated to.
+	 * Only used when cloning.
+	 *
+	 * @param AbstractTDBMObject $object
+	 */
+	public function setTDBMObject(AbstractTDBMObject $object)
+	{
+		$this->object = $object;
+	}
 }

src/Mouf/Database/TDBM/AlterableResultIterator.php

Indentation +245 added lines, -245 removed lines

@@ -14,274 +14,274 @@
  */
 class AlterableResultIterator implements Result, \ArrayAccess, \JsonSerializable
 {
-    /**
-     * @var \Iterator|null
-     */
-    private $resultIterator;
+	/**
+	 * @var \Iterator|null
+	 */
+	private $resultIterator;
 
-    /**
-     * Key: the object to alter in the result set.
-     * Value: "add" => the object will be added to the resultset (if it is not found in it)
-     *        "delete" => the object will be removed from the resultset (if found).
-     *
-     * @var \SplObjectStorage
-     */
-    private $alterations;
+	/**
+	 * Key: the object to alter in the result set.
+	 * Value: "add" => the object will be added to the resultset (if it is not found in it)
+	 *        "delete" => the object will be removed from the resultset (if found).
+	 *
+	 * @var \SplObjectStorage
+	 */
+	private $alterations;
 
-    /**
-     * The result array from the result set.
-     *
-     * @var array|null
-     */
-    private $resultArray;
+	/**
+	 * The result array from the result set.
+	 *
+	 * @var array|null
+	 */
+	private $resultArray;
 
-    /**
-     * @param \Iterator|null $resultIterator
-     */
-    public function __construct(\Iterator $resultIterator = null)
-    {
-        $this->resultIterator = $resultIterator;
-        $this->alterations = new \SplObjectStorage();
-    }
+	/**
+	 * @param \Iterator|null $resultIterator
+	 */
+	public function __construct(\Iterator $resultIterator = null)
+	{
+		$this->resultIterator = $resultIterator;
+		$this->alterations = new \SplObjectStorage();
+	}
 
-    /**
-     * Sets a new iterator as the base iterator to be altered.
-     *
-     * @param \Iterator $resultIterator
-     */
-    public function setResultIterator(\Iterator $resultIterator)
-    {
-        $this->resultIterator = $resultIterator;
-        $this->resultArray = null;
-    }
+	/**
+	 * Sets a new iterator as the base iterator to be altered.
+	 *
+	 * @param \Iterator $resultIterator
+	 */
+	public function setResultIterator(\Iterator $resultIterator)
+	{
+		$this->resultIterator = $resultIterator;
+		$this->resultArray = null;
+	}
 
-    /**
-     * Returns the non altered result iterator (or null if none exist).
-     *
-     * @return \Iterator|null
-     */
-    public function getUnderlyingResultIterator()
-    {
-        return $this->resultIterator;
-    }
+	/**
+	 * Returns the non altered result iterator (or null if none exist).
+	 *
+	 * @return \Iterator|null
+	 */
+	public function getUnderlyingResultIterator()
+	{
+		return $this->resultIterator;
+	}
 
-    /**
-     * Adds an additional object to the result set (if not already available).
-     *
-     * @param $object
-     */
-    public function add($object)
-    {
-        $this->alterations->attach($object, 'add');
+	/**
+	 * Adds an additional object to the result set (if not already available).
+	 *
+	 * @param $object
+	 */
+	public function add($object)
+	{
+		$this->alterations->attach($object, 'add');
 
-        if ($this->resultArray !== null) {
-            $foundKey = array_search($object, $this->resultArray, true);
-            if ($foundKey === false) {
-                $this->resultArray[] = $object;
-            }
-        }
-    }
+		if ($this->resultArray !== null) {
+			$foundKey = array_search($object, $this->resultArray, true);
+			if ($foundKey === false) {
+				$this->resultArray[] = $object;
+			}
+		}
+	}
 
-    /**
-     * Removes an object from the result set.
-     *
-     * @param $object
-     */
-    public function remove($object)
-    {
-        $this->alterations->attach($object, 'delete');
+	/**
+	 * Removes an object from the result set.
+	 *
+	 * @param $object
+	 */
+	public function remove($object)
+	{
+		$this->alterations->attach($object, 'delete');
 
-        if ($this->resultArray !== null) {
-            $foundKey = array_search($object, $this->resultArray, true);
-            if ($foundKey !== false) {
-                unset($this->resultArray[$foundKey]);
-            }
-        }
-    }
+		if ($this->resultArray !== null) {
+			$foundKey = array_search($object, $this->resultArray, true);
+			if ($foundKey !== false) {
+				unset($this->resultArray[$foundKey]);
+			}
+		}
+	}
 
-    /**
-     * Casts the result set to a PHP array.
-     *
-     * @return array
-     */
-    public function toArray()
-    {
-        if ($this->resultArray === null) {
-            if ($this->resultIterator !== null) {
-                $this->resultArray = iterator_to_array($this->resultIterator);
-            } else {
-                $this->resultArray = [];
-            }
+	/**
+	 * Casts the result set to a PHP array.
+	 *
+	 * @return array
+	 */
+	public function toArray()
+	{
+		if ($this->resultArray === null) {
+			if ($this->resultIterator !== null) {
+				$this->resultArray = iterator_to_array($this->resultIterator);
+			} else {
+				$this->resultArray = [];
+			}
 
-            foreach ($this->alterations as $obj) {
-                $action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL
+			foreach ($this->alterations as $obj) {
+				$action = $this->alterations->getInfo(); // return, if exists, associated with cur. obj. data; else NULL
 
-                $foundKey = array_search($obj, $this->resultArray, true);
+				$foundKey = array_search($obj, $this->resultArray, true);
 
-                if ($action === 'add' && $foundKey === false) {
-                    $this->resultArray[] = $obj;
-                } elseif ($action === 'delete' && $foundKey !== false) {
-                    unset($this->resultArray[$foundKey]);
-                }
-            }
-        }
+				if ($action === 'add' && $foundKey === false) {
+					$this->resultArray[] = $obj;
+				} elseif ($action === 'delete' && $foundKey !== false) {
+					unset($this->resultArray[$foundKey]);
+				}
+			}
+		}
 
-        return array_values($this->resultArray);
-    }
+		return array_values($this->resultArray);
+	}
 
-    /**
-     * Whether a offset exists.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
-     *
-     * @param mixed $offset <p>
-     *                      An offset to check for.
-     *                      </p>
-     *
-     * @return bool true on success or false on failure.
-     *              </p>
-     *              <p>
-     *              The return value will be casted to boolean if non-boolean was returned.
-     *
-     * @since 5.0.0
-     */
-    public function offsetExists($offset)
-    {
-        return isset($this->toArray()[$offset]);
-    }
+	/**
+	 * Whether a offset exists.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      An offset to check for.
+	 *                      </p>
+	 *
+	 * @return bool true on success or false on failure.
+	 *              </p>
+	 *              <p>
+	 *              The return value will be casted to boolean if non-boolean was returned.
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetExists($offset)
+	{
+		return isset($this->toArray()[$offset]);
+	}
 
-    /**
-     * Offset to retrieve.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to retrieve.
-     *                      </p>
-     *
-     * @return mixed Can return all value types.
-     *
-     * @since 5.0.0
-     */
-    public function offsetGet($offset)
-    {
-        return $this->toArray()[$offset];
-    }
+	/**
+	 * Offset to retrieve.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to retrieve.
+	 *                      </p>
+	 *
+	 * @return mixed Can return all value types.
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetGet($offset)
+	{
+		return $this->toArray()[$offset];
+	}
 
-    /**
-     * Offset to set.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to assign the value to.
-     *                      </p>
-     * @param mixed $value  <p>
-     *                      The value to set.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetSet($offset, $value)
-    {
-        throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.');
-    }
+	/**
+	 * Offset to set.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to assign the value to.
+	 *                      </p>
+	 * @param mixed $value  <p>
+	 *                      The value to set.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetSet($offset, $value)
+	{
+		throw new TDBMInvalidOperationException('You can set values in a TDBM result set, even in an alterable one. Use the add method instead.');
+	}
 
-    /**
-     * Offset to unset.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to unset.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetUnset($offset)
-    {
-        throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.');
-    }
+	/**
+	 * Offset to unset.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to unset.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetUnset($offset)
+	{
+		throw new TDBMInvalidOperationException('You can unset values in a TDBM result set, even in an alterable one. Use the delete method instead.');
+	}
 
-    /**
-     * @param int $offset
-     *
-     * @return \Porpaginas\Page
-     */
-    public function take($offset, $limit)
-    {
-        // TODO: replace this with a class implementing the map method.
-        return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
-    }
+	/**
+	 * @param int $offset
+	 *
+	 * @return \Porpaginas\Page
+	 */
+	public function take($offset, $limit)
+	{
+		// TODO: replace this with a class implementing the map method.
+		return new ArrayPage(array_slice($this->toArray(), $offset, $limit), $offset, $limit, count($this->toArray()));
+	}
 
-    /**
-     * Return the number of all results in the paginatable.
-     *
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->toArray());
-    }
+	/**
+	 * Return the number of all results in the paginatable.
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->toArray());
+	}
 
-    /**
-     * Return an iterator over all results of the paginatable.
-     *
-     * @return Iterator
-     */
-    public function getIterator()
-    {
-        if ($this->alterations->count() === 0) {
-            if ($this->resultIterator !== null) {
-                return $this->resultIterator;
-            } else {
-                return new \ArrayIterator([]);
-            }
-        } else {
-            return new \ArrayIterator($this->toArray());
-        }
-    }
+	/**
+	 * Return an iterator over all results of the paginatable.
+	 *
+	 * @return Iterator
+	 */
+	public function getIterator()
+	{
+		if ($this->alterations->count() === 0) {
+			if ($this->resultIterator !== null) {
+				return $this->resultIterator;
+			} else {
+				return new \ArrayIterator([]);
+			}
+		} else {
+			return new \ArrayIterator($this->toArray());
+		}
+	}
 
-    /**
-     * Specify data which should be serialized to JSON.
-     *
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     *
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     *               which is a value of any type other than a resource.
-     *
-     * @since 5.4.0
-     */
-    public function jsonSerialize()
-    {
-        return $this->toArray();
-    }
+	/**
+	 * Specify data which should be serialized to JSON.
+	 *
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 *
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
+	 *               which is a value of any type other than a resource.
+	 *
+	 * @since 5.4.0
+	 */
+	public function jsonSerialize()
+	{
+		return $this->toArray();
+	}
 
-    /**
-     * Returns only one value (the first) of the result set.
-     * Returns null if no value exists.
-     *
-     * @return mixed|null
-     */
-    public function first()
-    {
-        $page = $this->take(0, 1);
-        foreach ($page as $bean) {
-            return $bean;
-        }
+	/**
+	 * Returns only one value (the first) of the result set.
+	 * Returns null if no value exists.
+	 *
+	 * @return mixed|null
+	 */
+	public function first()
+	{
+		$page = $this->take(0, 1);
+		foreach ($page as $bean) {
+			return $bean;
+		}
 
-        return;
-    }
+		return;
+	}
 
-    /**
-     * Returns a new iterator mapping any call using the $callable function.
-     *
-     * @param callable $callable
-     *
-     * @return MapIterator
-     */
-    public function map(callable $callable)
-    {
-        return new MapIterator($this->getIterator(), $callable);
-    }
+	/**
+	 * Returns a new iterator mapping any call using the $callable function.
+	 *
+	 * @param callable $callable
+	 *
+	 * @return MapIterator
+	 */
+	public function map(callable $callable)
+	{
+		return new MapIterator($this->getIterator(), $callable);
+	}
 }

src/Mouf/Database/TDBM/MapIterator.php

Indentation +87 added lines, -87 removed lines

@@ -11,91 +11,91 @@
  */
 class MapIterator implements Iterator, \JsonSerializable
 {
-    /**
-     * @var Iterator
-     */
-    protected $iterator;
-
-    /**
-     * @var callable Modifies the current item in iterator
-     */
-    protected $callable;
-
-    /**
-     * @param $iterator Iterator|array
-     * @param $callable callable This can have two parameters
-     *
-     * @throws TDBMException
-     */
-    public function __construct($iterator, callable $callable)
-    {
-        if (is_array($iterator)) {
-            $this->iterator = new \ArrayIterator($iterator);
-        } elseif (!($iterator instanceof Iterator)) {
-            throw new TDBMException('$iterator parameter must be an instance of Iterator');
-        } else {
-            $this->iterator = $iterator;
-        }
-
-        if ($callable instanceof \Closure) {
-            // make sure there's one argument
-            $reflection = new \ReflectionObject($callable);
-            if ($reflection->hasMethod('__invoke')) {
-                $method = $reflection->getMethod('__invoke');
-                if ($method->getNumberOfParameters() !== 1) {
-                    throw new TDBMException('$callable must accept one and only one parameter.');
-                }
-            }
-        }
-
-        $this->callable = $callable;
-    }
-
-    /**
-     * Alters the current item with $this->callable and returns a new item.
-     * Be careful with your types as we can't do static type checking here!
-     *
-     * @return mixed
-     */
-    public function current()
-    {
-        $callable = $this->callable;
-
-        return $callable($this->iterator->current());
-    }
-
-    public function next()
-    {
-        $this->iterator->next();
-    }
-
-    public function key()
-    {
-        return $this->iterator->key();
-    }
-
-    public function valid()
-    {
-        return $this->iterator->valid();
-    }
-
-    public function rewind()
-    {
-        $this->iterator->rewind();
-    }
-
-    /**
-     * Casts the iterator to a PHP array.
-     *
-     * @return array
-     */
-    public function toArray()
-    {
-        return iterator_to_array($this);
-    }
-
-    public function jsonSerialize()
-    {
-        return $this->toArray();
-    }
+	/**
+	 * @var Iterator
+	 */
+	protected $iterator;
+
+	/**
+	 * @var callable Modifies the current item in iterator
+	 */
+	protected $callable;
+
+	/**
+	 * @param $iterator Iterator|array
+	 * @param $callable callable This can have two parameters
+	 *
+	 * @throws TDBMException
+	 */
+	public function __construct($iterator, callable $callable)
+	{
+		if (is_array($iterator)) {
+			$this->iterator = new \ArrayIterator($iterator);
+		} elseif (!($iterator instanceof Iterator)) {
+			throw new TDBMException('$iterator parameter must be an instance of Iterator');
+		} else {
+			$this->iterator = $iterator;
+		}
+
+		if ($callable instanceof \Closure) {
+			// make sure there's one argument
+			$reflection = new \ReflectionObject($callable);
+			if ($reflection->hasMethod('__invoke')) {
+				$method = $reflection->getMethod('__invoke');
+				if ($method->getNumberOfParameters() !== 1) {
+					throw new TDBMException('$callable must accept one and only one parameter.');
+				}
+			}
+		}
+
+		$this->callable = $callable;
+	}
+
+	/**
+	 * Alters the current item with $this->callable and returns a new item.
+	 * Be careful with your types as we can't do static type checking here!
+	 *
+	 * @return mixed
+	 */
+	public function current()
+	{
+		$callable = $this->callable;
+
+		return $callable($this->iterator->current());
+	}
+
+	public function next()
+	{
+		$this->iterator->next();
+	}
+
+	public function key()
+	{
+		return $this->iterator->key();
+	}
+
+	public function valid()
+	{
+		return $this->iterator->valid();
+	}
+
+	public function rewind()
+	{
+		$this->iterator->rewind();
+	}
+
+	/**
+	 * Casts the iterator to a PHP array.
+	 *
+	 * @return array
+	 */
+	public function toArray()
+	{
+		return iterator_to_array($this);
+	}
+
+	public function jsonSerialize()
+	{
+		return $this->toArray();
+	}
 }

src/Mouf/Database/TDBM/TDBMSchemaAnalyzer.php

Indentation +134 added lines, -134 removed lines

@@ -14,138 +14,138 @@
  */
 class TDBMSchemaAnalyzer
 {
-    private $connection;
-
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * @var string
-     */
-    private $cachePrefix;
-
-    /**
-     * @var Cache
-     */
-    private $cache;
-
-    /**
-     * @var SchemaAnalyzer
-     */
-    private $schemaAnalyzer;
-
-    /**
-     * @param Connection     $connection     The DBAL DB connection to use
-     * @param Cache          $cache          A cache service to be used
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
-     *                                       Will be automatically created if not passed
-     */
-    public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
-    {
-        $this->connection = $connection;
-        $this->cache = $cache;
-        $this->schemaAnalyzer = $schemaAnalyzer;
-    }
-
-    /**
-     * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
-     *
-     * @return string
-     */
-    public function getCachePrefix()
-    {
-        if ($this->cachePrefix === null) {
-            $this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
-        }
-
-        return $this->cachePrefix;
-    }
-
-    /**
-     * Returns the (cached) schema.
-     *
-     * @return Schema
-     */
-    public function getSchema()
-    {
-        if ($this->schema === null) {
-            $cacheKey = $this->getCachePrefix().'_schema';
-            if ($this->cache->contains($cacheKey)) {
-                $this->schema = $this->cache->fetch($cacheKey);
-            } else {
-                $this->schema = $this->connection->getSchemaManager()->createSchema();
-                $this->cache->save($cacheKey, $this->schema);
-            }
-        }
-
-        return $this->schema;
-    }
-
-    /**
-     * Returns the list of pivot tables linked to table $tableName.
-     *
-     * @param string $tableName
-     *
-     * @return array|string[]
-     */
-    public function getPivotTableLinkedToTable($tableName)
-    {
-        $cacheKey = $this->getCachePrefix().'_pivottables_link_'.$tableName;
-        if ($this->cache->contains($cacheKey)) {
-            return $this->cache->fetch($cacheKey);
-        }
-
-        $pivotTables = [];
-
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
-        foreach ($junctionTables as $table) {
-            $fks = $table->getForeignKeys();
-            foreach ($fks as $fk) {
-                if ($fk->getForeignTableName() == $tableName) {
-                    $pivotTables[] = $table->getName();
-                    break;
-                }
-            }
-        }
-
-        $this->cache->save($cacheKey, $pivotTables);
-
-        return $pivotTables;
-    }
-
-    /**
-     * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
-     * from junction tables and from inheritance.
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    public function getIncomingForeignKeys($tableName)
-    {
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
-        $junctionTableNames = array_map(function (Table $table) {
-            return $table->getName();
-        }, $junctionTables);
-        $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
-
-        $fks = [];
-        foreach ($this->getSchema()->getTables() as $table) {
-            foreach ($table->getForeignKeys() as $fk) {
-                if ($fk->getForeignTableName() === $tableName) {
-                    if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
-                        continue;
-                    }
-                    foreach ($childrenRelationships as $childFk) {
-                        if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
-                            continue 2;
-                        }
-                    }
-                    $fks[] = $fk;
-                }
-            }
-        }
-
-        return $fks;
-    }
+	private $connection;
+
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * @var string
+	 */
+	private $cachePrefix;
+
+	/**
+	 * @var Cache
+	 */
+	private $cache;
+
+	/**
+	 * @var SchemaAnalyzer
+	 */
+	private $schemaAnalyzer;
+
+	/**
+	 * @param Connection     $connection     The DBAL DB connection to use
+	 * @param Cache          $cache          A cache service to be used
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
+	 *                                       Will be automatically created if not passed
+	 */
+	public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
+	{
+		$this->connection = $connection;
+		$this->cache = $cache;
+		$this->schemaAnalyzer = $schemaAnalyzer;
+	}
+
+	/**
+	 * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
+	 *
+	 * @return string
+	 */
+	public function getCachePrefix()
+	{
+		if ($this->cachePrefix === null) {
+			$this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
+		}
+
+		return $this->cachePrefix;
+	}
+
+	/**
+	 * Returns the (cached) schema.
+	 *
+	 * @return Schema
+	 */
+	public function getSchema()
+	{
+		if ($this->schema === null) {
+			$cacheKey = $this->getCachePrefix().'_schema';
+			if ($this->cache->contains($cacheKey)) {
+				$this->schema = $this->cache->fetch($cacheKey);
+			} else {
+				$this->schema = $this->connection->getSchemaManager()->createSchema();
+				$this->cache->save($cacheKey, $this->schema);
+			}
+		}
+
+		return $this->schema;
+	}
+
+	/**
+	 * Returns the list of pivot tables linked to table $tableName.
+	 *
+	 * @param string $tableName
+	 *
+	 * @return array|string[]
+	 */
+	public function getPivotTableLinkedToTable($tableName)
+	{
+		$cacheKey = $this->getCachePrefix().'_pivottables_link_'.$tableName;
+		if ($this->cache->contains($cacheKey)) {
+			return $this->cache->fetch($cacheKey);
+		}
+
+		$pivotTables = [];
+
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
+		foreach ($junctionTables as $table) {
+			$fks = $table->getForeignKeys();
+			foreach ($fks as $fk) {
+				if ($fk->getForeignTableName() == $tableName) {
+					$pivotTables[] = $table->getName();
+					break;
+				}
+			}
+		}
+
+		$this->cache->save($cacheKey, $pivotTables);
+
+		return $pivotTables;
+	}
+
+	/**
+	 * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
+	 * from junction tables and from inheritance.
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	public function getIncomingForeignKeys($tableName)
+	{
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
+		$junctionTableNames = array_map(function (Table $table) {
+			return $table->getName();
+		}, $junctionTables);
+		$childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
+
+		$fks = [];
+		foreach ($this->getSchema()->getTables() as $table) {
+			foreach ($table->getForeignKeys() as $fk) {
+				if ($fk->getForeignTableName() === $tableName) {
+					if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
+						continue;
+					}
+					foreach ($childrenRelationships as $childFk) {
+						if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
+							continue 2;
+						}
+					}
+					$fks[] = $fk;
+				}
+			}
+		}
+
+		return $fks;
+	}
 }

src/Mouf/Database/TDBM/InnerResultArray.php

Indentation +89 added lines, -89 removed lines

@@ -27,100 +27,100 @@
  */
 class InnerResultArray extends InnerResultIterator
 {
-    /**
-     * The list of results already fetched.
-     *
-     * @var AbstractTDBMObject[]
-     */
-    private $results = [];
+	/**
+	 * The list of results already fetched.
+	 *
+	 * @var AbstractTDBMObject[]
+	 */
+	private $results = [];
 
-    /**
-     * Whether a offset exists.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
-     *
-     * @param mixed $offset <p>
-     *                      An offset to check for.
-     *                      </p>
-     *
-     * @return bool true on success or false on failure.
-     *              </p>
-     *              <p>
-     *              The return value will be casted to boolean if non-boolean was returned
-     *
-     * @since 5.0.0
-     */
-    public function offsetExists($offset)
-    {
-        try {
-            $this->toIndex($offset);
-        } catch (TDBMInvalidOffsetException $e) {
-            return false;
-        }
+	/**
+	 * Whether a offset exists.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      An offset to check for.
+	 *                      </p>
+	 *
+	 * @return bool true on success or false on failure.
+	 *              </p>
+	 *              <p>
+	 *              The return value will be casted to boolean if non-boolean was returned
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetExists($offset)
+	{
+		try {
+			$this->toIndex($offset);
+		} catch (TDBMInvalidOffsetException $e) {
+			return false;
+		}
 
-        return true;
-    }
+		return true;
+	}
 
-    /**
-     * Offset to retrieve.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to retrieve.
-     *                      </p>
-     *
-     * @return mixed Can return all value types
-     *
-     * @since 5.0.0
-     */
-    public function offsetGet($offset)
-    {
-        $this->toIndex($offset);
+	/**
+	 * Offset to retrieve.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to retrieve.
+	 *                      </p>
+	 *
+	 * @return mixed Can return all value types
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetGet($offset)
+	{
+		$this->toIndex($offset);
 
-        return $this->results[$offset];
-    }
+		return $this->results[$offset];
+	}
 
-    private function toIndex($offset)
-    {
-        if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) {
-            throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.');
-        }
-        if ($this->statement === null) {
-            $this->executeQuery();
-        }
-        while (!isset($this->results[$offset])) {
-            $this->next();
-            if ($this->current === null) {
-                throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
-            }
-        }
-    }
+	private function toIndex($offset)
+	{
+		if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) {
+			throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.');
+		}
+		if ($this->statement === null) {
+			$this->executeQuery();
+		}
+		while (!isset($this->results[$offset])) {
+			$this->next();
+			if ($this->current === null) {
+				throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.');
+			}
+		}
+	}
 
-    public function next()
-    {
-        // Let's overload the next() method to store the result.
-        if (isset($this->results[$this->key + 1])) {
-            ++$this->key;
-            $this->current = $this->results[$this->key];
-        } else {
-            parent::next();
-            if ($this->current !== null) {
-                $this->results[$this->key] = $this->current;
-            }
-        }
-    }
+	public function next()
+	{
+		// Let's overload the next() method to store the result.
+		if (isset($this->results[$this->key + 1])) {
+			++$this->key;
+			$this->current = $this->results[$this->key];
+		} else {
+			parent::next();
+			if ($this->current !== null) {
+				$this->results[$this->key] = $this->current;
+			}
+		}
+	}
 
-    /**
-     * Overloads the rewind implementation.
-     * Do not reexecute the query.
-     */
-    public function rewind()
-    {
-        if (!$this->fetchStarted) {
-            $this->executeQuery();
-        }
-        $this->key = -1;
-        $this->next();
-    }
+	/**
+	 * Overloads the rewind implementation.
+	 * Do not reexecute the query.
+	 */
+	public function rewind()
+	{
+		if (!$this->fetchStarted) {
+			$this->executeQuery();
+		}
+		$this->key = -1;
+		$this->next();
+	}
 }

src/Mouf/Database/TDBM/TDBMObject.php

Indentation +34 added lines, -34 removed lines

@@ -33,42 +33,42 @@
  */
 class TDBMObject extends AbstractTDBMObject
 {
-    public function getProperty($var, $tableName = null)
-    {
-        return $this->get($var, $tableName);
-    }
+	public function getProperty($var, $tableName = null)
+	{
+		return $this->get($var, $tableName);
+	}
 
-    public function setProperty($var, $value, $tableName = null)
-    {
-        $this->set($var, $value, $tableName);
-    }
+	public function setProperty($var, $value, $tableName = null)
+	{
+		$this->set($var, $value, $tableName);
+	}
 
-    /**
-     * Specify data which should be serialized to JSON.
-     *
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     *
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     *               which is a value of any type other than a resource
-     *
-     * @since 5.4.0
-     */
-    public function jsonSerialize()
-    {
-        throw new TDBMException('Json serialization is only implemented for generated beans.');
-    }
+	/**
+	 * Specify data which should be serialized to JSON.
+	 *
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 *
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
+	 *               which is a value of any type other than a resource
+	 *
+	 * @since 5.4.0
+	 */
+	public function jsonSerialize()
+	{
+		throw new TDBMException('Json serialization is only implemented for generated beans.');
+	}
 
-    /**
-     * Returns an array of used tables by this bean (from parent to child relationship).
-     *
-     * @return string[]
-     */
-    protected function getUsedTables()
-    {
-        $tableNames = array_keys($this->dbRows);
-        $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
-        $tableNames = array_reverse($tableNames);
+	/**
+	 * Returns an array of used tables by this bean (from parent to child relationship).
+	 *
+	 * @return string[]
+	 */
+	protected function getUsedTables()
+	{
+		$tableNames = array_keys($this->dbRows);
+		$tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
+		$tableNames = array_reverse($tableNames);
 
-        return $tableNames;
-    }
+		return $tableNames;
+	}
 }

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

Indentation +474 added lines, -474 removed lines

@@ -17,202 +17,202 @@ 
  */
 class TDBMDaoGenerator
 {
-    /**
-     * @var SchemaAnalyzer
-     */
-    private $schemaAnalyzer;
-
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * The root directory of the project.
-     *
-     * @var string
-     */
-    private $rootPath;
-
-    /**
-     * Name of composer file.
-     *
-     * @var string
-     */
-    private $composerFile;
-
-    /**
-     * @var TDBMSchemaAnalyzer
-     */
-    private $tdbmSchemaAnalyzer;
-
-    /**
-     * Constructor.
-     *
-     * @param SchemaAnalyzer     $schemaAnalyzer
-     * @param Schema             $schema
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
-     */
-    public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
-    {
-        $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->schema = $schema;
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
-        $this->rootPath = __DIR__.'/../../../../../../../../';
-        $this->composerFile = 'composer.json';
-    }
-
-    /**
-     * Generates all the daos and beans.
-     *
-     * @param string $daoFactoryClassName The classe name of the DAO factory
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone
-     *
-     * @return \string[] the list of tables
-     *
-     * @throws TDBMException
-     */
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
-    {
-        $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
-        // 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->schemaAnalyzer->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);
-        });
-
-        foreach ($tableList as $table) {
-            $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
-        }
-
-        $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
-
-        // Ok, let's return the list of all tables.
-        // These will be used by the calling script to create Mouf instances.
-
-        return array_map(function (Table $table) {
-            return $table->getName();
-        }, $tableList);
-    }
-
-    /**
-     * Generates in one method call the daos and the beans for one table.
-     *
-     * @param Table           $table
-     * @param string          $daonamespace
-     * @param string          $beannamespace
-     * @param ClassNameMapper $classNameMapper
-     * @param bool            $storeInUtc
-     *
-     * @throws TDBMException
-     */
-    public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
-    {
-        $tableName = $table->getName();
-        $daoName = $this->getDaoNameFromTableName($tableName);
-        $beanName = $this->getBeanNameFromTableName($tableName);
-        $baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
-        $baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
-
-        $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
-    }
-
-    /**
-     * Returns the name of the bean class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBeanNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'Bean';
-    }
-
-    /**
-     * Returns the name of the DAO class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getDaoNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'Dao';
-    }
-
-    /**
-     * Returns the name of the base bean class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBaseBeanNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
-    }
-
-    /**
-     * Returns the name of the base DAO class from the table name.
-     *
-     * @param $tableName
-     *
-     * @return string
-     */
-    public static function getBaseDaoNameFromTableName($tableName)
-    {
-        return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
-    }
-
-    /**
-     * 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
-     * @param string          $beannamespace   The namespace of the bean
-     * @param ClassNameMapper $classNameMapper
-     *
-     * @throws TDBMException
-     */
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
-    {
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
-
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
-        if (empty($possibleBaseFileNames)) {
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
-        }
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
-
-        $this->ensureDirectoryExist($possibleBaseFileName);
-        file_put_contents($possibleBaseFileName, $str);
-        @chmod($possibleBaseFileName, 0664);
-
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
-        if (empty($possibleFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-        if (!file_exists($possibleFileName)) {
-            $tableName = $table->getName();
-            $str = "<?php
+	/**
+	 * @var SchemaAnalyzer
+	 */
+	private $schemaAnalyzer;
+
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * The root directory of the project.
+	 *
+	 * @var string
+	 */
+	private $rootPath;
+
+	/**
+	 * Name of composer file.
+	 *
+	 * @var string
+	 */
+	private $composerFile;
+
+	/**
+	 * @var TDBMSchemaAnalyzer
+	 */
+	private $tdbmSchemaAnalyzer;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param SchemaAnalyzer     $schemaAnalyzer
+	 * @param Schema             $schema
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
+	 */
+	public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
+	{
+		$this->schemaAnalyzer = $schemaAnalyzer;
+		$this->schema = $schema;
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
+		$this->rootPath = __DIR__.'/../../../../../../../../';
+		$this->composerFile = 'composer.json';
+	}
+
+	/**
+	 * Generates all the daos and beans.
+	 *
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone
+	 *
+	 * @return \string[] the list of tables
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
+	{
+		$classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
+		// 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->schemaAnalyzer->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);
+		});
+
+		foreach ($tableList as $table) {
+			$this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
+		}
+
+		$this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
+
+		// Ok, let's return the list of all tables.
+		// These will be used by the calling script to create Mouf instances.
+
+		return array_map(function (Table $table) {
+			return $table->getName();
+		}, $tableList);
+	}
+
+	/**
+	 * Generates in one method call the daos and the beans for one table.
+	 *
+	 * @param Table           $table
+	 * @param string          $daonamespace
+	 * @param string          $beannamespace
+	 * @param ClassNameMapper $classNameMapper
+	 * @param bool            $storeInUtc
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
+	{
+		$tableName = $table->getName();
+		$daoName = $this->getDaoNameFromTableName($tableName);
+		$beanName = $this->getBeanNameFromTableName($tableName);
+		$baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
+		$baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
+
+		$beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
+	}
+
+	/**
+	 * Returns the name of the bean class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBeanNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'Bean';
+	}
+
+	/**
+	 * Returns the name of the DAO class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getDaoNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'Dao';
+	}
+
+	/**
+	 * Returns the name of the base bean class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBaseBeanNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
+	}
+
+	/**
+	 * Returns the name of the base DAO class from the table name.
+	 *
+	 * @param $tableName
+	 *
+	 * @return string
+	 */
+	public static function getBaseDaoNameFromTableName($tableName)
+	{
+		return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
+	}
+
+	/**
+	 * 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
+	 * @param string          $beannamespace   The namespace of the bean
+	 * @param ClassNameMapper $classNameMapper
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
+	{
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
+
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
+		if (empty($possibleBaseFileNames)) {
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
+		}
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
+
+		$this->ensureDirectoryExist($possibleBaseFileName);
+		file_put_contents($possibleBaseFileName, $str);
+		@chmod($possibleBaseFileName, 0664);
+
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
+		if (empty($possibleFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+		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.
@@ -229,76 +229,76 @@ 
 {
 
 }";
-            $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName, $str);
-            @chmod($possibleFileName, 0664);
-        }
-    }
-
-    /**
-     * 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
-     * @param string          $daonamespace
-     * @param string          $beannamespace
-     * @param ClassNameMapper $classNameMapper
-     *
-     * @throws TDBMException
-     */
-    public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
-    {
-        $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->ensureDirectoryExist($possibleFileName);
+			file_put_contents($possibleFileName, $str);
+			@chmod($possibleFileName, 0664);
+		}
+	}
+
+	/**
+	 * 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
+	 * @param string          $daonamespace
+	 * @param string          $beannamespace
+	 * @param ClassNameMapper $classNameMapper
+	 *
+	 * @throws TDBMException
+	 */
+	public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
+	{
+		$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.
@@ -375,10 +375,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.
@@ -393,8 +393,8 @@ 
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
     }
     ";
-        }
-        $str .= "
+		}
+		$str .= "
     /**
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
      *
@@ -493,33 +493,33 @@ 
     }
 ";
 
-        $str .= $findByDaoCode;
-        $str .= '}
+		$str .= $findByDaoCode;
+		$str .= '}
 ';
 
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
-        if (empty($possibleBaseFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
-
-        $this->ensureDirectoryExist($possibleBaseFileName);
-        file_put_contents($possibleBaseFileName, $str);
-        @chmod($possibleBaseFileName, 0664);
-
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
-        if (empty($possibleFileNames)) {
-            // @codeCoverageIgnoreStart
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
-            // @codeCoverageIgnoreEnd
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-
-        // Now, let's generate the "editable" class
-        if (!file_exists($possibleFileName)) {
-            $str = "<?php
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
+		if (empty($possibleBaseFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
+
+		$this->ensureDirectoryExist($possibleBaseFileName);
+		file_put_contents($possibleBaseFileName, $str);
+		@chmod($possibleBaseFileName, 0664);
+
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
+		if (empty($possibleFileNames)) {
+			// @codeCoverageIgnoreStart
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
+			// @codeCoverageIgnoreEnd
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+
+		// Now, let's generate the "editable" class
+		if (!file_exists($possibleFileName)) {
+			$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -538,22 +538,22 @@ 
 
 }
 ";
-            $this->ensureDirectoryExist($possibleFileName);
-            file_put_contents($possibleFileName, $str);
-            @chmod($possibleFileName, 0664);
-        }
-    }
-
-    /**
-     * Generates the factory bean.
-     *
-     * @param Table[] $tableList
-     */
-    private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
-    {
-        // For each table, let's write a property.
-
-        $str = "<?php
+			$this->ensureDirectoryExist($possibleFileName);
+			file_put_contents($possibleFileName, $str);
+			@chmod($possibleFileName, 0664);
+		}
+	}
+
+	/**
+	 * Generates the factory bean.
+	 *
+	 * @param Table[] $tableList
+	 */
+	private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
+	{
+		// For each table, let's write a property.
+
+		$str = "<?php
 
 /*
  * This file has been automatically generated by TDBM.
@@ -562,13 +562,13 @@ 
 
 namespace {$daoNamespace}\\Generated;
 ";
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
-            $str .= "use {$daoNamespace}\\".$daoClassName.";\n";
-        }
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
+			$str .= "use {$daoNamespace}\\".$daoClassName.";\n";
+		}
 
-        $str .= "
+		$str .= "
 /**
  * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM.
  *
@@ -577,12 +577,12 @@ 
 {
 ";
 
-        foreach ($tableList as $table) {
-            $tableName = $table->getName();
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
-            $daoInstanceName = self::toVariableName($daoClassName);
+		foreach ($tableList as $table) {
+			$tableName = $table->getName();
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
+			$daoInstanceName = self::toVariableName($daoClassName);
 
-            $str .= '    /**
+			$str .= '    /**
      * @var '.$daoClassName.'
      */
     private $'.$daoInstanceName.';
@@ -607,158 +607,158 @@ 
     }
 
 ';
-        }
+		}
 
-        $str .= '
+		$str .= '
 }
 ';
 
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
-        if (empty($possibleFileNames)) {
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
-        }
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
-
-        $this->ensureDirectoryExist($possibleFileName);
-        file_put_contents($possibleFileName, $str);
-        @chmod($possibleFileName, 0664);
-    }
-
-    /**
-     * 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($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."'.");
-            }
-        }
-    }
-
-    /**
-     * Absolute path to composer json file.
-     *
-     * @param string $composerFile
-     */
-    public function setComposerFile($composerFile)
-    {
-        $this->rootPath = dirname($composerFile).'/';
-        $this->composerFile = basename($composerFile);
-    }
-
-    /**
-     * 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',
-            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();
-    }
-
-    /**
-     * @param string $beanNamespace
-     *
-     * @return \string[] Returns a map mapping table name to beans name
-     */
-    public function buildTableToBeanMap($beanNamespace)
-    {
-        $tableToBeanMap = [];
-
-        $tables = $this->schema->getTables();
-
-        foreach ($tables as $table) {
-            $tableName = $table->getName();
-            $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
-        }
-
-        return $tableToBeanMap;
-    }
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
+		if (empty($possibleFileNames)) {
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
+		}
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
+
+		$this->ensureDirectoryExist($possibleFileName);
+		file_put_contents($possibleFileName, $str);
+		@chmod($possibleFileName, 0664);
+	}
+
+	/**
+	 * 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($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."'.");
+			}
+		}
+	}
+
+	/**
+	 * Absolute path to composer json file.
+	 *
+	 * @param string $composerFile
+	 */
+	public function setComposerFile($composerFile)
+	{
+		$this->rootPath = dirname($composerFile).'/';
+		$this->composerFile = basename($composerFile);
+	}
+
+	/**
+	 * 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',
+			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();
+	}
+
+	/**
+	 * @param string $beanNamespace
+	 *
+	 * @return \string[] Returns a map mapping table name to beans name
+	 */
+	public function buildTableToBeanMap($beanNamespace)
+	{
+		$tableToBeanMap = [];
+
+		$tables = $this->schema->getTables();
+
+		foreach ($tables as $table) {
+			$tableName = $table->getName();
+			$tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
+		}
+
+		return $tableToBeanMap;
+	}
 }

src/Mouf/Database/TDBM/InnerResultIterator.php

Indentation +263 added lines, -263 removed lines

@@ -29,267 +29,267 @@
  */
 class InnerResultIterator implements \Iterator, \Countable, \ArrayAccess
 {
-    /**
-     * @var Statement
-     */
-    protected $statement;
-
-    protected $fetchStarted = false;
-    private $objectStorage;
-    private $className;
-
-    private $tdbmService;
-    private $magicSql;
-    private $parameters;
-    private $limit;
-    private $offset;
-    private $columnDescriptors;
-    private $magicQuery;
-
-    /**
-     * The key of the current retrieved object.
-     *
-     * @var int
-     */
-    protected $key = -1;
-
-    protected $current = null;
-
-    private $databasePlatform;
-
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
-    public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger)
-    {
-        $this->magicSql = $magicSql;
-        $this->objectStorage = $objectStorage;
-        $this->className = $className;
-        $this->tdbmService = $tdbmService;
-        $this->parameters = $parameters;
-        $this->limit = $limit;
-        $this->offset = $offset;
-        $this->columnDescriptors = $columnDescriptors;
-        $this->magicQuery = $magicQuery;
-        $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
-        $this->logger = $logger;
-    }
-
-    protected function executeQuery()
-    {
-        $sql = $this->magicQuery->build($this->magicSql, $this->parameters);
-        $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);
-
-        $this->logger->debug('Running SQL request: '.$sql);
-
-        $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);
-
-        $this->fetchStarted = true;
-    }
-
-    /**
-     * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
-     *
-     * @return int
-     */
-    public function count()
-    {
-        if (!$this->fetchStarted) {
-            $this->executeQuery();
-        }
-
-        return $this->statement->rowCount();
-    }
-
-    /**
-     * Fetches record at current cursor.
-     *
-     * @return AbstractTDBMObject|null
-     */
-    public function current()
-    {
-        return $this->current;
-    }
-
-    /**
-     * Returns the current result's key.
-     *
-     * @return int
-     */
-    public function key()
-    {
-        return $this->key;
-    }
-
-    /**
-     * Advances the cursor to the next result.
-     * Casts the database result into one (or several) beans.
-     */
-    public function next()
-    {
-        $row = $this->statement->fetch(\PDO::FETCH_NUM);
-        if ($row) {
-
-            // array<tablegroup, array<table, array<column, value>>>
-            $beansData = [];
-            foreach ($row as $i => $value) {
-                $columnDescriptor = $this->columnDescriptors[$i];
-
-                if ($columnDescriptor['tableGroup'] === null) {
-                    // A column can have no tableGroup (if it comes from an ORDER BY expression)
-                    continue;
-                }
-
-                // Let's cast the value according to its type
-                $value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform);
-
-                $beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value;
-            }
-
-            $reflectionClassCache = [];
-            $firstBean = true;
-            foreach ($beansData as $beanData) {
-
-                // Let's find the bean class name associated to the bean.
-
-                list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData);
-
-                if ($this->className !== null) {
-                    $actualClassName = $this->className;
-                }
-
-                // Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched:
-                foreach ($beanData as $tableName => $descriptors) {
-                    if (!in_array($tableName, $tablesUsed)) {
-                        unset($beanData[$tableName]);
-                    }
-                }
-
-                // Must we create the bean? Let's see in the cache if we have a mapping DbRow?
-                // Let's get the first object mapping a row:
-                // We do this loop only for the first table
-
-                $primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]);
-                $hash = $this->tdbmService->getObjectHash($primaryKeys);
-
-                if ($this->objectStorage->has($mainBeanTableName, $hash)) {
-                    $dbRow = $this->objectStorage->get($mainBeanTableName, $hash);
-                    $bean = $dbRow->getTDBMObject();
-                } else {
-                    // Let's construct the bean
-                    if (!isset($reflectionClassCache[$actualClassName])) {
-                        $reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName);
-                    }
-                    // Let's bypass the constructor when creating the bean!
-                    $bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor();
-                    $bean->_constructFromData($beanData, $this->tdbmService);
-                }
-
-                // The first bean is the one containing the main table.
-                if ($firstBean) {
-                    $firstBean = false;
-                    $this->current = $bean;
-                }
-            }
-
-            ++$this->key;
-        } else {
-            $this->current = null;
-        }
-    }
-
-    /**
-     * Moves the cursor to the beginning of the result set.
-     */
-    public function rewind()
-    {
-        $this->executeQuery();
-        $this->key = -1;
-        $this->next();
-    }
-    /**
-     * Checks if the cursor is reading a valid result.
-     *
-     * @return bool
-     */
-    public function valid()
-    {
-        return $this->current !== null;
-    }
-
-    /**
-     * Whether a offset exists.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
-     *
-     * @param mixed $offset <p>
-     *                      An offset to check for.
-     *                      </p>
-     *
-     * @return bool true on success or false on failure.
-     *              </p>
-     *              <p>
-     *              The return value will be casted to boolean if non-boolean was returned
-     *
-     * @since 5.0.0
-     */
-    public function offsetExists($offset)
-    {
-        throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
-    }
-
-    /**
-     * Offset to retrieve.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetget.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to retrieve.
-     *                      </p>
-     *
-     * @return mixed Can return all value types
-     *
-     * @since 5.0.0
-     */
-    public function offsetGet($offset)
-    {
-        throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
-    }
-
-    /**
-     * Offset to set.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to assign the value to.
-     *                      </p>
-     * @param mixed $value  <p>
-     *                      The value to set.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetSet($offset, $value)
-    {
-        throw new TDBMInvalidOperationException('You can set values in a TDBM result set.');
-    }
-
-    /**
-     * Offset to unset.
-     *
-     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
-     *
-     * @param mixed $offset <p>
-     *                      The offset to unset.
-     *                      </p>
-     *
-     * @since 5.0.0
-     */
-    public function offsetUnset($offset)
-    {
-        throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.');
-    }
+	/**
+	 * @var Statement
+	 */
+	protected $statement;
+
+	protected $fetchStarted = false;
+	private $objectStorage;
+	private $className;
+
+	private $tdbmService;
+	private $magicSql;
+	private $parameters;
+	private $limit;
+	private $offset;
+	private $columnDescriptors;
+	private $magicQuery;
+
+	/**
+	 * The key of the current retrieved object.
+	 *
+	 * @var int
+	 */
+	protected $key = -1;
+
+	protected $current = null;
+
+	private $databasePlatform;
+
+	/**
+	 * @var LoggerInterface
+	 */
+	private $logger;
+
+	public function __construct($magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, LoggerInterface $logger)
+	{
+		$this->magicSql = $magicSql;
+		$this->objectStorage = $objectStorage;
+		$this->className = $className;
+		$this->tdbmService = $tdbmService;
+		$this->parameters = $parameters;
+		$this->limit = $limit;
+		$this->offset = $offset;
+		$this->columnDescriptors = $columnDescriptors;
+		$this->magicQuery = $magicQuery;
+		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
+		$this->logger = $logger;
+	}
+
+	protected function executeQuery()
+	{
+		$sql = $this->magicQuery->build($this->magicSql, $this->parameters);
+		$sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);
+
+		$this->logger->debug('Running SQL request: '.$sql);
+
+		$this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);
+
+		$this->fetchStarted = true;
+	}
+
+	/**
+	 * Counts found records (this is the number of records fetched, taking into account the LIMIT and OFFSET settings).
+	 *
+	 * @return int
+	 */
+	public function count()
+	{
+		if (!$this->fetchStarted) {
+			$this->executeQuery();
+		}
+
+		return $this->statement->rowCount();
+	}
+
+	/**
+	 * Fetches record at current cursor.
+	 *
+	 * @return AbstractTDBMObject|null
+	 */
+	public function current()
+	{
+		return $this->current;
+	}
+
+	/**
+	 * Returns the current result's key.
+	 *
+	 * @return int
+	 */
+	public function key()
+	{
+		return $this->key;
+	}
+
+	/**
+	 * Advances the cursor to the next result.
+	 * Casts the database result into one (or several) beans.
+	 */
+	public function next()
+	{
+		$row = $this->statement->fetch(\PDO::FETCH_NUM);
+		if ($row) {
+
+			// array<tablegroup, array<table, array<column, value>>>
+			$beansData = [];
+			foreach ($row as $i => $value) {
+				$columnDescriptor = $this->columnDescriptors[$i];
+
+				if ($columnDescriptor['tableGroup'] === null) {
+					// A column can have no tableGroup (if it comes from an ORDER BY expression)
+					continue;
+				}
+
+				// Let's cast the value according to its type
+				$value = $columnDescriptor['type']->convertToPHPValue($value, $this->databasePlatform);
+
+				$beansData[$columnDescriptor['tableGroup']][$columnDescriptor['table']][$columnDescriptor['column']] = $value;
+			}
+
+			$reflectionClassCache = [];
+			$firstBean = true;
+			foreach ($beansData as $beanData) {
+
+				// Let's find the bean class name associated to the bean.
+
+				list($actualClassName, $mainBeanTableName, $tablesUsed) = $this->tdbmService->_getClassNameFromBeanData($beanData);
+
+				if ($this->className !== null) {
+					$actualClassName = $this->className;
+				}
+
+				// Let's filter out the beanData that is not used (because it belongs to a part of the hierarchy that is not fetched:
+				foreach ($beanData as $tableName => $descriptors) {
+					if (!in_array($tableName, $tablesUsed)) {
+						unset($beanData[$tableName]);
+					}
+				}
+
+				// Must we create the bean? Let's see in the cache if we have a mapping DbRow?
+				// Let's get the first object mapping a row:
+				// We do this loop only for the first table
+
+				$primaryKeys = $this->tdbmService->_getPrimaryKeysFromObjectData($mainBeanTableName, $beanData[$mainBeanTableName]);
+				$hash = $this->tdbmService->getObjectHash($primaryKeys);
+
+				if ($this->objectStorage->has($mainBeanTableName, $hash)) {
+					$dbRow = $this->objectStorage->get($mainBeanTableName, $hash);
+					$bean = $dbRow->getTDBMObject();
+				} else {
+					// Let's construct the bean
+					if (!isset($reflectionClassCache[$actualClassName])) {
+						$reflectionClassCache[$actualClassName] = new \ReflectionClass($actualClassName);
+					}
+					// Let's bypass the constructor when creating the bean!
+					$bean = $reflectionClassCache[$actualClassName]->newInstanceWithoutConstructor();
+					$bean->_constructFromData($beanData, $this->tdbmService);
+				}
+
+				// The first bean is the one containing the main table.
+				if ($firstBean) {
+					$firstBean = false;
+					$this->current = $bean;
+				}
+			}
+
+			++$this->key;
+		} else {
+			$this->current = null;
+		}
+	}
+
+	/**
+	 * Moves the cursor to the beginning of the result set.
+	 */
+	public function rewind()
+	{
+		$this->executeQuery();
+		$this->key = -1;
+		$this->next();
+	}
+	/**
+	 * Checks if the cursor is reading a valid result.
+	 *
+	 * @return bool
+	 */
+	public function valid()
+	{
+		return $this->current !== null;
+	}
+
+	/**
+	 * Whether a offset exists.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      An offset to check for.
+	 *                      </p>
+	 *
+	 * @return bool true on success or false on failure.
+	 *              </p>
+	 *              <p>
+	 *              The return value will be casted to boolean if non-boolean was returned
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetExists($offset)
+	{
+		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
+	}
+
+	/**
+	 * Offset to retrieve.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetget.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to retrieve.
+	 *                      </p>
+	 *
+	 * @return mixed Can return all value types
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetGet($offset)
+	{
+		throw new TDBMInvalidOperationException('You cannot access this result set via index because it was fetched in CURSOR mode. Use ARRAY_MODE instead.');
+	}
+
+	/**
+	 * Offset to set.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to assign the value to.
+	 *                      </p>
+	 * @param mixed $value  <p>
+	 *                      The value to set.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetSet($offset, $value)
+	{
+		throw new TDBMInvalidOperationException('You can set values in a TDBM result set.');
+	}
+
+	/**
+	 * Offset to unset.
+	 *
+	 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
+	 *
+	 * @param mixed $offset <p>
+	 *                      The offset to unset.
+	 *                      </p>
+	 *
+	 * @since 5.0.0
+	 */
+	public function offsetUnset($offset)
+	{
+		throw new TDBMInvalidOperationException('You can unset values in a TDBM result set.');
+	}
 }

src/Mouf/Database/TDBM/OrderByAnalyzer.php

Indentation +118 added lines, -118 removed lines

@@ -12,122 +12,122 @@
  */
 class OrderByAnalyzer
 {
-    /**
-     * The content of the cache variable.
-     *
-     * @var Cache
-     */
-    private $cache;
-
-    /**
-     * @var string
-     */
-    private $cachePrefix;
-
-    /**
-     * OrderByAnalyzer constructor.
-     *
-     * @param Cache       $cache
-     * @param string|null $cachePrefix
-     */
-    public function __construct(Cache $cache, $cachePrefix = null)
-    {
-        $this->cache = $cache;
-        $this->cachePrefix = $cachePrefix;
-    }
-
-    /**
-     * Returns an array for each sorted "column" in the form:.
-     *
-     * [
-     *      [
-     *          'type' => 'colref',
-     *          'table' => null,
-     *          'column' => 'a',
-     *          'direction' => 'ASC'
-     *      ],
-     *      [
-     *          'type' => 'expr',
-     *          'expr' => 'RAND()',
-     *          'direction' => 'DESC'
-     *      ]
-     * ]
-     *
-     * @param string $orderBy
-     *
-     * @return array
-     */
-    public function analyzeOrderBy(string $orderBy) : array
-    {
-        $key = $this->cachePrefix.'_order_by_analysis_'.$orderBy;
-        $results = $this->cache->fetch($key);
-        if ($results !== false) {
-            return $results;
-        }
-        $results = $this->analyzeOrderByNoCache($orderBy);
-        $this->cache->save($key, $results);
-
-        return $results;
-    }
-
-    private function analyzeOrderByNoCache(string $orderBy) : array
-    {
-        $sqlParser = new PHPSQLParser();
-        $sql = 'SELECT 1 FROM a ORDER BY '.$orderBy;
-        $parsed = $sqlParser->parse($sql, true);
-
-        $results = [];
-
-        for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) {
-            $orderItem = $parsed['ORDER'][$i];
-            if ($orderItem['expr_type'] === 'colref') {
-                $parts = $orderItem['no_quotes']['parts'];
-                $columnName = array_pop($parts);
-                if (!empty($parts)) {
-                    $tableName = array_pop($parts);
-                } else {
-                    $tableName = null;
-                }
-
-                $results[] = [
-                    'type' => 'colref',
-                    'table' => $tableName,
-                    'column' => $columnName,
-                    'direction' => $orderItem['direction'],
-                ];
-            } else {
-                $position = $orderItem['position'];
-                if ($i + 1 < $count) {
-                    $nextPosition = $parsed['ORDER'][$i + 1]['position'];
-                    $str = substr($sql, $position, $nextPosition - $position);
-                } else {
-                    $str = substr($sql, $position);
-                }
-
-                $str = trim($str, " \t\r\n,");
-
-                $results[] = [
-                    'type' => 'expr',
-                    'expr' => $this->trimDirection($str),
-                    'direction' => $orderItem['direction'],
-                ];
-            }
-        }
-
-        return $results;
-    }
-
-    /**
-     * Trims the ASC/DESC direction at the end of the string.
-     *
-     * @param string $sql
-     *
-     * @return string
-     */
-    private function trimDirection(string $sql) : string
-    {
-        preg_match('/^(.*)(\s+(DESC|ASC|))*$/Ui', $sql, $matches);
-
-        return $matches[1];
-    }
+	/**
+	 * The content of the cache variable.
+	 *
+	 * @var Cache
+	 */
+	private $cache;
+
+	/**
+	 * @var string
+	 */
+	private $cachePrefix;
+
+	/**
+	 * OrderByAnalyzer constructor.
+	 *
+	 * @param Cache       $cache
+	 * @param string|null $cachePrefix
+	 */
+	public function __construct(Cache $cache, $cachePrefix = null)
+	{
+		$this->cache = $cache;
+		$this->cachePrefix = $cachePrefix;
+	}
+
+	/**
+	 * Returns an array for each sorted "column" in the form:.
+	 *
+	 * [
+	 *      [
+	 *          'type' => 'colref',
+	 *          'table' => null,
+	 *          'column' => 'a',
+	 *          'direction' => 'ASC'
+	 *      ],
+	 *      [
+	 *          'type' => 'expr',
+	 *          'expr' => 'RAND()',
+	 *          'direction' => 'DESC'
+	 *      ]
+	 * ]
+	 *
+	 * @param string $orderBy
+	 *
+	 * @return array
+	 */
+	public function analyzeOrderBy(string $orderBy) : array
+	{
+		$key = $this->cachePrefix.'_order_by_analysis_'.$orderBy;
+		$results = $this->cache->fetch($key);
+		if ($results !== false) {
+			return $results;
+		}
+		$results = $this->analyzeOrderByNoCache($orderBy);
+		$this->cache->save($key, $results);
+
+		return $results;
+	}
+
+	private function analyzeOrderByNoCache(string $orderBy) : array
+	{
+		$sqlParser = new PHPSQLParser();
+		$sql = 'SELECT 1 FROM a ORDER BY '.$orderBy;
+		$parsed = $sqlParser->parse($sql, true);
+
+		$results = [];
+
+		for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) {
+			$orderItem = $parsed['ORDER'][$i];
+			if ($orderItem['expr_type'] === 'colref') {
+				$parts = $orderItem['no_quotes']['parts'];
+				$columnName = array_pop($parts);
+				if (!empty($parts)) {
+					$tableName = array_pop($parts);
+				} else {
+					$tableName = null;
+				}
+
+				$results[] = [
+					'type' => 'colref',
+					'table' => $tableName,
+					'column' => $columnName,
+					'direction' => $orderItem['direction'],
+				];
+			} else {
+				$position = $orderItem['position'];
+				if ($i + 1 < $count) {
+					$nextPosition = $parsed['ORDER'][$i + 1]['position'];
+					$str = substr($sql, $position, $nextPosition - $position);
+				} else {
+					$str = substr($sql, $position);
+				}
+
+				$str = trim($str, " \t\r\n,");
+
+				$results[] = [
+					'type' => 'expr',
+					'expr' => $this->trimDirection($str),
+					'direction' => $orderItem['direction'],
+				];
+			}
+		}
+
+		return $results;
+	}
+
+	/**
+	 * Trims the ASC/DESC direction at the end of the string.
+	 *
+	 * @param string $sql
+	 *
+	 * @return string
+	 */
+	private function trimDirection(string $sql) : string
+	{
+		preg_match('/^(.*)(\s+(DESC|ASC|))*$/Ui', $sql, $matches);
+
+		return $matches[1];
+	}
 }