thecodingmachine / database.tdbm

src/Mouf/Database/TDBM/QueryFactory/FindObjectsQueryFactory.php

Indentation +38 added lines, -38 removed lines

@@ -11,44 +11,44 @@
  */
 class FindObjectsQueryFactory extends AbstractQueryFactory
 {
-    private $mainTable;
-    private $additionalTablesFetch;
-    private $filterString;
-
-    public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer)
-    {
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
-        $this->mainTable = $mainTable;
-        $this->additionalTablesFetch = $additionalTablesFetch;
-        $this->filterString = $filterString;
-    }
-
-    protected function compute()
-    {
-        list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, $this->additionalTablesFetch, $this->orderBy);
-
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
-
-        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
-        $pkColumnNames = array_map(function ($pkColumn) {
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
-        }, $pkColumnNames);
-
-        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$this->mainTable.')';
-
-        if (!empty($this->filterString)) {
-            $sql .= ' WHERE '.$this->filterString;
-            $countSql .= ' WHERE '.$this->filterString;
-        }
-
-        if (!empty($orderString)) {
-            $sql .= ' ORDER BY '.$orderString;
-        }
-
-        $this->magicSql = $sql;
-        $this->magicSqlCount = $countSql;
-        $this->columnDescList = $columnDescList;
-    }
+	private $mainTable;
+	private $additionalTablesFetch;
+	private $filterString;
+
+	public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer)
+	{
+		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
+		$this->mainTable = $mainTable;
+		$this->additionalTablesFetch = $additionalTablesFetch;
+		$this->filterString = $filterString;
+	}
+
+	protected function compute()
+	{
+		list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, $this->additionalTablesFetch, $this->orderBy);
+
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
+
+		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
+		$pkColumnNames = array_map(function ($pkColumn) {
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
+		}, $pkColumnNames);
+
+		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$this->mainTable.')';
+
+		if (!empty($this->filterString)) {
+			$sql .= ' WHERE '.$this->filterString;
+			$countSql .= ' WHERE '.$this->filterString;
+		}
+
+		if (!empty($orderString)) {
+			$sql .= ' ORDER BY '.$orderString;
+		}
+
+		$this->magicSql = $sql;
+		$this->magicSqlCount = $countSql;
+		$this->columnDescList = $columnDescList;
+	}
 
 
 }

src/Mouf/Database/TDBM/QueryFactory/QueryFactory.php

Indentation +18 added lines, -18 removed lines

@@ -9,25 +9,25 @@
  */
 interface QueryFactory
 {
-    /**
-     * Sets the ORDER BY directive executed in SQL.
-     *
-     * For instance:
-     *
-     *  $queryFactory->sort('label ASC, status DESC');
-     *
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
-     *
-     *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
-     *
-     * @param string|UncheckedOrderBy|null $orderBy
-     */
-    public function sort($orderBy);
+	/**
+	 * Sets the ORDER BY directive executed in SQL.
+	 *
+	 * For instance:
+	 *
+	 *  $queryFactory->sort('label ASC, status DESC');
+	 *
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
+	 *
+	 *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
+	 *
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 */
+	public function sort($orderBy);
 
-    public function getMagicSql() : string;
+	public function getMagicSql() : string;
 
-    public function getMagicSqlCount() : string;
+	public function getMagicSqlCount() : string;
 
-    public function getColumnDescriptors() : array;
+	public function getColumnDescriptors() : array;
 }

src/Mouf/Database/TDBM/ResultIterator.php

Indentation +281 added lines, -281 removed lines

@@ -32,285 +32,285 @@
  */
 class ResultIterator implements Result, \ArrayAccess, \JsonSerializable
 {
-    /**
-     * @var Statement
-     */
-    protected $statement;
-
-    private $objectStorage;
-    private $className;
-
-    private $tdbmService;
-    private $parameters;
-    private $magicQuery;
-
-    /**
-     * @var QueryFactory
-     */
-    private $queryFactory;
-
-    /**
-     * @var InnerResultIterator
-     */
-    private $innerResultIterator;
-
-    private $databasePlatform;
-
-    private $totalCount;
-
-    private $mode;
-
-    private $logger;
-
-    public function __construct(QueryFactory $queryFactory, array $parameters, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger)
-    {
-        if ($mode !== null && $mode !== TDBMService::MODE_CURSOR && $mode !== TDBMService::MODE_ARRAY) {
-            throw new TDBMException("Unknown fetch mode: '".$mode."'");
-        }
-
-        $this->queryFactory = $queryFactory;
-        $this->objectStorage = $objectStorage;
-        $this->className = $className;
-        $this->tdbmService = $tdbmService;
-        $this->parameters = $parameters;
-        $this->magicQuery = $magicQuery;
-        $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
-        $this->mode = $mode;
-        $this->logger = $logger;
-    }
-
-    protected function executeCountQuery()
-    {
-        $sql = $this->magicQuery->build($this->queryFactory->getMagicSqlCount(), $this->parameters);
-        $this->logger->debug('Running count query: '.$sql);
-        $this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters);
-    }
-
-    /**
-     * 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->totalCount === null) {
-            $this->executeCountQuery();
-        }
-
-        return $this->totalCount;
-    }
-
-    /**
-     * Casts the result set to a PHP array.
-     *
-     * @return array
-     */
-    public function toArray()
-    {
-        return iterator_to_array($this->getIterator());
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * Retrieve an external iterator.
-     *
-     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
-     *
-     * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or
-     *                             <b>Traversable</b>
-     *
-     * @since 5.0.0
-     */
-    public function getIterator()
-    {
-        if ($this->innerResultIterator === null) {
-            if ($this->mode === TDBMService::MODE_CURSOR) {
-                $this->innerResultIterator = new InnerResultIterator($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
-            } else {
-                $this->innerResultIterator = new InnerResultArray($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
-            }
-        }
-
-        return $this->innerResultIterator;
-    }
-
-    /**
-     * @param int $offset
-     * @param int $limit
-     *
-     * @return PageIterator
-     */
-    public function take($offset, $limit)
-    {
-        return new PageIterator($this, $this->queryFactory->getMagicSql(), $this->parameters, $limit, $offset, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger);
-    }
-
-    /**
-     * 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 $this->getIterator()->offsetExists($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->getIterator()->offsetGet($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)
-    {
-        return $this->getIterator()->offsetSet($offset, $value);
-    }
-
-    /**
-     * 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)
-    {
-        return $this->getIterator()->offsetUnset($offset);
-    }
-
-    /**
-     * Specify data which should be serialized to JSON.
-     *
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     *
-     * @param bool $stopRecursion Parameter used internally by TDBM to
-     *                            stop embedded objects from embedding
-     *                            other objects
-     *
-     * @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($stopRecursion = false)
-    {
-        return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) {
-            return $item->jsonSerialize($stopRecursion);
-        }, $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;
-        }
-
-        return;
-    }
-
-    /**
-     * Sets the ORDER BY directive executed in SQL and returns a NEW ResultIterator.
-     *
-     * For instance:
-     *
-     *  $resultSet = $resultSet->withOrder('label ASC, status DESC');
-     *
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
-     *
-     *  $resultSet->withOrder(new UncheckedOrderBy('RAND()'))
-     *
-     * @param string|UncheckedOrderBy|null $orderBy
-     *
-     * @return ResultIterator
-     */
-    public function withOrder($orderBy) : ResultIterator
-    {
-        $clone = clone $this;
-        $clone->queryFactory = clone $this->queryFactory;
-        $clone->queryFactory->sort($orderBy);
-        $clone->innerResultIterator = null;
-
-        return $clone;
-    }
-
-    /**
-     * Sets new parameters for the SQL query and returns a NEW ResultIterator.
-     *
-     * For instance:
-     *
-     *  $resultSet = $resultSet->withParameters('label ASC, status DESC');
-     *
-     * @param string|UncheckedOrderBy|null $orderBy
-     *
-     * @return ResultIterator
-     */
-    public function withParameters(array $parameters) : ResultIterator
-    {
-        $clone = clone $this;
-        $clone->parameters = $parameters;
-        $clone->innerResultIterator = null;
-        $clone->totalCount = null;
-
-        return $clone;
-    }
+	/**
+	 * @var Statement
+	 */
+	protected $statement;
+
+	private $objectStorage;
+	private $className;
+
+	private $tdbmService;
+	private $parameters;
+	private $magicQuery;
+
+	/**
+	 * @var QueryFactory
+	 */
+	private $queryFactory;
+
+	/**
+	 * @var InnerResultIterator
+	 */
+	private $innerResultIterator;
+
+	private $databasePlatform;
+
+	private $totalCount;
+
+	private $mode;
+
+	private $logger;
+
+	public function __construct(QueryFactory $queryFactory, array $parameters, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode, LoggerInterface $logger)
+	{
+		if ($mode !== null && $mode !== TDBMService::MODE_CURSOR && $mode !== TDBMService::MODE_ARRAY) {
+			throw new TDBMException("Unknown fetch mode: '".$mode."'");
+		}
+
+		$this->queryFactory = $queryFactory;
+		$this->objectStorage = $objectStorage;
+		$this->className = $className;
+		$this->tdbmService = $tdbmService;
+		$this->parameters = $parameters;
+		$this->magicQuery = $magicQuery;
+		$this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform();
+		$this->mode = $mode;
+		$this->logger = $logger;
+	}
+
+	protected function executeCountQuery()
+	{
+		$sql = $this->magicQuery->build($this->queryFactory->getMagicSqlCount(), $this->parameters);
+		$this->logger->debug('Running count query: '.$sql);
+		$this->totalCount = $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters);
+	}
+
+	/**
+	 * 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->totalCount === null) {
+			$this->executeCountQuery();
+		}
+
+		return $this->totalCount;
+	}
+
+	/**
+	 * Casts the result set to a PHP array.
+	 *
+	 * @return array
+	 */
+	public function toArray()
+	{
+		return iterator_to_array($this->getIterator());
+	}
+
+	/**
+	 * 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);
+	}
+
+	/**
+	 * Retrieve an external iterator.
+	 *
+	 * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
+	 *
+	 * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or
+	 *                             <b>Traversable</b>
+	 *
+	 * @since 5.0.0
+	 */
+	public function getIterator()
+	{
+		if ($this->innerResultIterator === null) {
+			if ($this->mode === TDBMService::MODE_CURSOR) {
+				$this->innerResultIterator = new InnerResultIterator($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
+			} else {
+				$this->innerResultIterator = new InnerResultArray($this->queryFactory->getMagicSql(), $this->parameters, null, null, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->logger);
+			}
+		}
+
+		return $this->innerResultIterator;
+	}
+
+	/**
+	 * @param int $offset
+	 * @param int $limit
+	 *
+	 * @return PageIterator
+	 */
+	public function take($offset, $limit)
+	{
+		return new PageIterator($this, $this->queryFactory->getMagicSql(), $this->parameters, $limit, $offset, $this->queryFactory->getColumnDescriptors(), $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery, $this->mode, $this->logger);
+	}
+
+	/**
+	 * 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 $this->getIterator()->offsetExists($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->getIterator()->offsetGet($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)
+	{
+		return $this->getIterator()->offsetSet($offset, $value);
+	}
+
+	/**
+	 * 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)
+	{
+		return $this->getIterator()->offsetUnset($offset);
+	}
+
+	/**
+	 * Specify data which should be serialized to JSON.
+	 *
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 *
+	 * @param bool $stopRecursion Parameter used internally by TDBM to
+	 *                            stop embedded objects from embedding
+	 *                            other objects
+	 *
+	 * @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($stopRecursion = false)
+	{
+		return array_map(function (AbstractTDBMObject $item) use ($stopRecursion) {
+			return $item->jsonSerialize($stopRecursion);
+		}, $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;
+		}
+
+		return;
+	}
+
+	/**
+	 * Sets the ORDER BY directive executed in SQL and returns a NEW ResultIterator.
+	 *
+	 * For instance:
+	 *
+	 *  $resultSet = $resultSet->withOrder('label ASC, status DESC');
+	 *
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
+	 *
+	 *  $resultSet->withOrder(new UncheckedOrderBy('RAND()'))
+	 *
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 *
+	 * @return ResultIterator
+	 */
+	public function withOrder($orderBy) : ResultIterator
+	{
+		$clone = clone $this;
+		$clone->queryFactory = clone $this->queryFactory;
+		$clone->queryFactory->sort($orderBy);
+		$clone->innerResultIterator = null;
+
+		return $clone;
+	}
+
+	/**
+	 * Sets new parameters for the SQL query and returns a NEW ResultIterator.
+	 *
+	 * For instance:
+	 *
+	 *  $resultSet = $resultSet->withParameters('label ASC, status DESC');
+	 *
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 *
+	 * @return ResultIterator
+	 */
+	public function withParameters(array $parameters) : ResultIterator
+	{
+		$clone = clone $this;
+		$clone->parameters = $parameters;
+		$clone->innerResultIterator = null;
+		$clone->totalCount = null;
+
+		return $clone;
+	}
 }

src/Mouf/Database/TDBM/QueryFactory/AbstractQueryFactory.php

Indentation +210 added lines, -210 removed lines

@@ -10,214 +10,214 @@
 
 abstract class AbstractQueryFactory implements QueryFactory
 {
-    /**
-     * @var TDBMService
-     */
-    protected $tdbmService;
-
-    /**
-     * @var Schema
-     */
-    protected $schema;
-
-    /**
-     * @var OrderByAnalyzer
-     */
-    protected $orderByAnalyzer;
-
-    /**
-     * @var string|UncheckedOrderBy|null
-     */
-    protected $orderBy;
-
-    protected $magicSql;
-    protected $magicSqlCount;
-    protected $columnDescList;
-
-    /**
-     * @param TDBMService $tdbmService
-     */
-    public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
-    {
-        $this->tdbmService = $tdbmService;
-        $this->schema = $schema;
-        $this->orderByAnalyzer = $orderByAnalyzer;
-        $this->orderBy = $orderBy;
-    }
-
-    /**
-     * Returns the column list that must be fetched for the SQL request.
-     *
-     * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
-     *
-     * @param string                       $mainTable
-     * @param array                        $additionalTablesFetch
-     * @param string|UncheckedOrderBy|null $orderBy
-     *
-     * @return array
-     *
-     * @throws \Doctrine\DBAL\Schema\SchemaException
-     */
-    protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
-    {
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
-        // that must be part of the select columns.
-
-        $connection = $this->tdbmService->getConnection();
-
-        $tableGroups = [];
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
-        foreach ($allFetchedTables as $table) {
-            $tableGroups[$table] = $tableGroupName;
-        }
-
-        $columnsList = [];
-        $columnDescList = [];
-        $sortColumn = 0;
-        $reconstructedOrderBy = null;
-
-        if (is_string($orderBy)) {
-            $orderBy = trim($orderBy);
-            if ($orderBy === '') {
-                $orderBy = null;
-            }
-        }
-
-        // Now, let's deal with "order by columns"
-        if ($orderBy !== null) {
-            if ($orderBy instanceof UncheckedOrderBy) {
-                $securedOrderBy = false;
-                $orderBy = $orderBy->getOrderBy();
-                $reconstructedOrderBy = $orderBy;
-            } else {
-                $securedOrderBy = true;
-                $reconstructedOrderBys = [];
-            }
-            $orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
-
-            // If we sort by a column, there is a high chance we will fetch the bean containing this column.
-            // Hence, we should add the table to the $additionalTablesFetch
-            foreach ($orderByColumns as $orderByColumn) {
-                if ($orderByColumn['type'] === 'colref') {
-                    if ($orderByColumn['table'] !== null) {
-                        $additionalTablesFetch[] = $orderByColumn['table'];
-                    }
-                    if ($securedOrderBy) {
-                        $reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
-                    }
-                } elseif ($orderByColumn['type'] === 'expr') {
-                    $sortColumnName = 'sort_column_'.$sortColumn;
-                    $columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
-                    $columnDescList[] = [
-                        'tableGroup' => null,
-                    ];
-                    ++$sortColumn;
-
-                    if ($securedOrderBy) {
-                        throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
-                    }
-                }
-            }
-
-            if ($reconstructedOrderBy === null) {
-                $reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
-            }
-        }
-
-        foreach ($additionalTablesFetch as $additionalTable) {
-            $relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
-            $tableGroupName = $this->getTableGroupName($relatedTables);
-            foreach ($relatedTables as $table) {
-                $tableGroups[$table] = $tableGroupName;
-            }
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
-        }
-
-        // Let's remove any duplicate
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
-
-        // Now, let's build the column list
-        foreach ($allFetchedTables as $table) {
-            foreach ($this->schema->getTable($table)->getColumns() as $column) {
-                $columnName = $column->getName();
-                $columnDescList[] = [
-                    'as' => $table.'____'.$columnName,
-                    'table' => $table,
-                    'column' => $columnName,
-                    'type' => $column->getType(),
-                    'tableGroup' => $tableGroups[$table],
-                ];
-                $columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
-                    $connection->quoteIdentifier($table.'____'.$columnName);
-            }
-        }
-
-        return [$columnDescList, $columnsList, $reconstructedOrderBy];
-    }
-
-    abstract protected function compute();
-
-    /**
-     * Returns an identifier for the group of tables passed in parameter.
-     *
-     * @param string[] $relatedTables
-     *
-     * @return string
-     */
-    protected function getTableGroupName(array $relatedTables)
-    {
-        sort($relatedTables);
-
-        return implode('_``_', $relatedTables);
-    }
-
-    public function getMagicSql() : string
-    {
-        if ($this->magicSql === null) {
-            $this->compute();
-        }
-
-        return $this->magicSql;
-    }
-
-    public function getMagicSqlCount() : string
-    {
-        if ($this->magicSqlCount === null) {
-            $this->compute();
-        }
-
-        return $this->magicSqlCount;
-    }
-
-    public function getColumnDescriptors() : array
-    {
-        if ($this->columnDescList === null) {
-            $this->compute();
-        }
-
-        return $this->columnDescList;
-    }
-
-    /**
-     * Sets the ORDER BY directive executed in SQL.
-     *
-     * For instance:
-     *
-     *  $queryFactory->sort('label ASC, status DESC');
-     *
-     * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
-     * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
-     *
-     *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
-     *
-     * @param string|UncheckedOrderBy|null $orderBy
-     */
-    public function sort($orderBy)
-    {
-        $this->orderBy = $orderBy;
-        $this->magicSql = null;
-        $this->magicSqlCount = null;
-        $this->columnDescList = null;
-    }
+	/**
+	 * @var TDBMService
+	 */
+	protected $tdbmService;
+
+	/**
+	 * @var Schema
+	 */
+	protected $schema;
+
+	/**
+	 * @var OrderByAnalyzer
+	 */
+	protected $orderByAnalyzer;
+
+	/**
+	 * @var string|UncheckedOrderBy|null
+	 */
+	protected $orderBy;
+
+	protected $magicSql;
+	protected $magicSqlCount;
+	protected $columnDescList;
+
+	/**
+	 * @param TDBMService $tdbmService
+	 */
+	public function __construct(TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, $orderBy)
+	{
+		$this->tdbmService = $tdbmService;
+		$this->schema = $schema;
+		$this->orderByAnalyzer = $orderByAnalyzer;
+		$this->orderBy = $orderBy;
+	}
+
+	/**
+	 * Returns the column list that must be fetched for the SQL request.
+	 *
+	 * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
+	 *
+	 * @param string                       $mainTable
+	 * @param array                        $additionalTablesFetch
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 *
+	 * @return array
+	 *
+	 * @throws \Doctrine\DBAL\Schema\SchemaException
+	 */
+	protected function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
+	{
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
+		// that must be part of the select columns.
+
+		$connection = $this->tdbmService->getConnection();
+
+		$tableGroups = [];
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($mainTable);
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
+		foreach ($allFetchedTables as $table) {
+			$tableGroups[$table] = $tableGroupName;
+		}
+
+		$columnsList = [];
+		$columnDescList = [];
+		$sortColumn = 0;
+		$reconstructedOrderBy = null;
+
+		if (is_string($orderBy)) {
+			$orderBy = trim($orderBy);
+			if ($orderBy === '') {
+				$orderBy = null;
+			}
+		}
+
+		// Now, let's deal with "order by columns"
+		if ($orderBy !== null) {
+			if ($orderBy instanceof UncheckedOrderBy) {
+				$securedOrderBy = false;
+				$orderBy = $orderBy->getOrderBy();
+				$reconstructedOrderBy = $orderBy;
+			} else {
+				$securedOrderBy = true;
+				$reconstructedOrderBys = [];
+			}
+			$orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
+
+			// If we sort by a column, there is a high chance we will fetch the bean containing this column.
+			// Hence, we should add the table to the $additionalTablesFetch
+			foreach ($orderByColumns as $orderByColumn) {
+				if ($orderByColumn['type'] === 'colref') {
+					if ($orderByColumn['table'] !== null) {
+						$additionalTablesFetch[] = $orderByColumn['table'];
+					}
+					if ($securedOrderBy) {
+						$reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $connection->quoteIdentifier($orderByColumn['table']).'.' : '').$connection->quoteIdentifier($orderByColumn['column']).' '.$orderByColumn['direction'];
+					}
+				} elseif ($orderByColumn['type'] === 'expr') {
+					$sortColumnName = 'sort_column_'.$sortColumn;
+					$columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
+					$columnDescList[] = [
+						'tableGroup' => null,
+					];
+					++$sortColumn;
+
+					if ($securedOrderBy) {
+						throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
+					}
+				}
+			}
+
+			if ($reconstructedOrderBy === null) {
+				$reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
+			}
+		}
+
+		foreach ($additionalTablesFetch as $additionalTable) {
+			$relatedTables = $this->tdbmService->_getRelatedTablesByInheritance($additionalTable);
+			$tableGroupName = $this->getTableGroupName($relatedTables);
+			foreach ($relatedTables as $table) {
+				$tableGroups[$table] = $tableGroupName;
+			}
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
+		}
+
+		// Let's remove any duplicate
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
+
+		// Now, let's build the column list
+		foreach ($allFetchedTables as $table) {
+			foreach ($this->schema->getTable($table)->getColumns() as $column) {
+				$columnName = $column->getName();
+				$columnDescList[] = [
+					'as' => $table.'____'.$columnName,
+					'table' => $table,
+					'column' => $columnName,
+					'type' => $column->getType(),
+					'tableGroup' => $tableGroups[$table],
+				];
+				$columnsList[] = $connection->quoteIdentifier($table).'.'.$connection->quoteIdentifier($columnName).' as '.
+					$connection->quoteIdentifier($table.'____'.$columnName);
+			}
+		}
+
+		return [$columnDescList, $columnsList, $reconstructedOrderBy];
+	}
+
+	abstract protected function compute();
+
+	/**
+	 * Returns an identifier for the group of tables passed in parameter.
+	 *
+	 * @param string[] $relatedTables
+	 *
+	 * @return string
+	 */
+	protected function getTableGroupName(array $relatedTables)
+	{
+		sort($relatedTables);
+
+		return implode('_``_', $relatedTables);
+	}
+
+	public function getMagicSql() : string
+	{
+		if ($this->magicSql === null) {
+			$this->compute();
+		}
+
+		return $this->magicSql;
+	}
+
+	public function getMagicSqlCount() : string
+	{
+		if ($this->magicSqlCount === null) {
+			$this->compute();
+		}
+
+		return $this->magicSqlCount;
+	}
+
+	public function getColumnDescriptors() : array
+	{
+		if ($this->columnDescList === null) {
+			$this->compute();
+		}
+
+		return $this->columnDescList;
+	}
+
+	/**
+	 * Sets the ORDER BY directive executed in SQL.
+	 *
+	 * For instance:
+	 *
+	 *  $queryFactory->sort('label ASC, status DESC');
+	 *
+	 * **Important:** TDBM does its best to protect you from SQL injection. In particular, it will only allow column names in the "ORDER BY" clause. This means you are safe to pass input from the user directly in the ORDER BY parameter.
+	 * If you want to pass an expression to the ORDER BY clause, you will need to tell TDBM to stop checking for SQL injections. You do this by passing a `UncheckedOrderBy` object as a parameter:
+	 *
+	 *  $queryFactory->sort(new UncheckedOrderBy('RAND()'))
+	 *
+	 * @param string|UncheckedOrderBy|null $orderBy
+	 */
+	public function sort($orderBy)
+	{
+		$this->orderBy = $orderBy;
+		$this->magicSql = null;
+		$this->magicSqlCount = null;
+		$this->columnDescList = null;
+	}
 }

src/Mouf/Database/TDBM/QueryFactory/FindObjectsFromSqlQueryFactory.php

Indentation +187 added lines, -187 removed lines

@@ -15,191 +15,191 @@
  */
 class FindObjectsFromSqlQueryFactory extends AbstractQueryFactory
 {
-    private $mainTable;
-    private $from;
-    private $filterString;
-    private $cache;
-    private $cachePrefix;
-
-    public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
-    {
-        parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
-        $this->mainTable = $mainTable;
-        $this->from = $from;
-        $this->filterString = $filterString;
-        $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->cache = $cache;
-        $this->cachePrefix = $cachePrefix;
-    }
-
-    protected function compute()
-    {
-        $connection = $this->tdbmService->getConnection();
-
-        $columnsList = null;
-
-        $allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
-
-        $columnDescList = [];
-
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
-
-        foreach ($this->schema->getTable($this->mainTable)->getColumns() as $column) {
-            $columnName = $column->getName();
-            $columnDescList[] = [
-                'as' => $columnName,
-                'table' => $this->mainTable,
-                'column' => $columnName,
-                'type' => $column->getType(),
-                'tableGroup' => $tableGroupName,
-            ];
-        }
-
-        $sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) {
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($columnDesc['column']);
-        }, $columnDescList)).' FROM '.$this->from;
-
-        if (count($allFetchedTables) > 1) {
-            list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
-        } elseif ($this->orderBy) {
-            list(, , $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
-        }
-
-        // Let's compute the COUNT.
-        $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
-        $pkColumnNames = array_map(function ($pkColumn) {
-            return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
-        }, $pkColumnNames);
-
-        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
-
-        if (!empty($this->filterString)) {
-            $sql .= ' WHERE '.$this->filterString;
-            $countSql .= ' WHERE '.$this->filterString;
-        }
-
-        if (!empty($orderString)) {
-            $sql .= ' ORDER BY '.$orderString;
-        }
-
-        if (stripos($countSql, 'GROUP BY') !== false) {
-            throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
-        }
-
-        if ($columnsList !== null) {
-            $joinSql = '';
-            $parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
-            foreach ($parentFks as $fk) {
-                $joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0]),
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0])
-                );
-            }
-
-            $childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
-            foreach ($childrenFks as $fk) {
-                $joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getForeignTableName()),
-                    $connection->quoteIdentifier($fk->getForeignColumns()[0]),
-                    $connection->quoteIdentifier($fk->getLocalTableName()),
-                    $connection->quoteIdentifier($fk->getLocalColumns()[0])
-                );
-            }
-
-            $sql = 'SELECT '.implode(', ', $columnsList).' FROM ('.$sql.') AS '.$this->mainTable.' '.$joinSql;
-            if (!empty($orderString)) {
-                $sql .= ' ORDER BY '.$orderString;
-            }
-        }
-
-        $this->magicSql = $sql;
-        $this->magicSqlCount = $countSql;
-        $this->columnDescList = $columnDescList;
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getParentRelationshipForeignKeys($tableName)
-    {
-        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
-            return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
-        });
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getParentRelationshipForeignKeysWithoutCache($tableName)
-    {
-        $parentFks = [];
-        $currentTable = $tableName;
-        while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
-            $currentTable = $currentFk->getForeignTableName();
-            $parentFks[] = $currentFk;
-        }
-
-        return $parentFks;
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getChildrenRelationshipForeignKeys(string $tableName) : array
-    {
-        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
-            return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
-        });
-    }
-
-    /**
-     * @param string $tableName
-     *
-     * @return ForeignKeyConstraint[]
-     */
-    private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
-    {
-        $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
-
-        if (!empty($children)) {
-            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
-                return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
-            }, $children);
-
-            $fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
-
-            return $fks;
-        } else {
-            return [];
-        }
-    }
-
-    /**
-     * Returns an item from cache or computes it using $closure and puts it in cache.
-     *
-     * @param string   $key
-     * @param callable $closure
-     *
-     * @return mixed
-     */
-    protected function fromCache(string $key, callable $closure)
-    {
-        $item = $this->cache->fetch($key);
-        if ($item === false) {
-            $item = $closure();
-            $this->cache->save($key, $item);
-        }
-
-        return $item;
-    }
+	private $mainTable;
+	private $from;
+	private $filterString;
+	private $cache;
+	private $cachePrefix;
+
+	public function __construct(string $mainTable, string $from, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, SchemaAnalyzer $schemaAnalyzer, Cache $cache, string $cachePrefix)
+	{
+		parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
+		$this->mainTable = $mainTable;
+		$this->from = $from;
+		$this->filterString = $filterString;
+		$this->schemaAnalyzer = $schemaAnalyzer;
+		$this->cache = $cache;
+		$this->cachePrefix = $cachePrefix;
+	}
+
+	protected function compute()
+	{
+		$connection = $this->tdbmService->getConnection();
+
+		$columnsList = null;
+
+		$allFetchedTables = $this->tdbmService->_getRelatedTablesByInheritance($this->mainTable);
+
+		$columnDescList = [];
+
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
+
+		foreach ($this->schema->getTable($this->mainTable)->getColumns() as $column) {
+			$columnName = $column->getName();
+			$columnDescList[] = [
+				'as' => $columnName,
+				'table' => $this->mainTable,
+				'column' => $columnName,
+				'type' => $column->getType(),
+				'tableGroup' => $tableGroupName,
+			];
+		}
+
+		$sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) {
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($columnDesc['column']);
+		}, $columnDescList)).' FROM '.$this->from;
+
+		if (count($allFetchedTables) > 1) {
+			list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
+		} elseif ($this->orderBy) {
+			list(, , $orderString) = $this->getColumnsList($this->mainTable, [], $this->orderBy);
+		}
+
+		// Let's compute the COUNT.
+		$pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
+		$pkColumnNames = array_map(function ($pkColumn) {
+			return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
+		}, $pkColumnNames);
+
+		$countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$this->from;
+
+		if (!empty($this->filterString)) {
+			$sql .= ' WHERE '.$this->filterString;
+			$countSql .= ' WHERE '.$this->filterString;
+		}
+
+		if (!empty($orderString)) {
+			$sql .= ' ORDER BY '.$orderString;
+		}
+
+		if (stripos($countSql, 'GROUP BY') !== false) {
+			throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
+		}
+
+		if ($columnsList !== null) {
+			$joinSql = '';
+			$parentFks = $this->getParentRelationshipForeignKeys($this->mainTable);
+			foreach ($parentFks as $fk) {
+				$joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getLocalColumns()[0]),
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getForeignColumns()[0])
+				);
+			}
+
+			$childrenFks = $this->getChildrenRelationshipForeignKeys($this->mainTable);
+			foreach ($childrenFks as $fk) {
+				$joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getForeignTableName()),
+					$connection->quoteIdentifier($fk->getForeignColumns()[0]),
+					$connection->quoteIdentifier($fk->getLocalTableName()),
+					$connection->quoteIdentifier($fk->getLocalColumns()[0])
+				);
+			}
+
+			$sql = 'SELECT '.implode(', ', $columnsList).' FROM ('.$sql.') AS '.$this->mainTable.' '.$joinSql;
+			if (!empty($orderString)) {
+				$sql .= ' ORDER BY '.$orderString;
+			}
+		}
+
+		$this->magicSql = $sql;
+		$this->magicSqlCount = $countSql;
+		$this->columnDescList = $columnDescList;
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getParentRelationshipForeignKeys($tableName)
+	{
+		return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
+			return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
+		});
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getParentRelationshipForeignKeysWithoutCache($tableName)
+	{
+		$parentFks = [];
+		$currentTable = $tableName;
+		while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
+			$currentTable = $currentFk->getForeignTableName();
+			$parentFks[] = $currentFk;
+		}
+
+		return $parentFks;
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getChildrenRelationshipForeignKeys(string $tableName) : array
+	{
+		return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
+			return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
+		});
+	}
+
+	/**
+	 * @param string $tableName
+	 *
+	 * @return ForeignKeyConstraint[]
+	 */
+	private function getChildrenRelationshipForeignKeysWithoutCache(string $tableName) : array
+	{
+		$children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
+
+		if (!empty($children)) {
+			$fksTables = array_map(function (ForeignKeyConstraint $fk) {
+				return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
+			}, $children);
+
+			$fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
+
+			return $fks;
+		} else {
+			return [];
+		}
+	}
+
+	/**
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
+	 *
+	 * @param string   $key
+	 * @param callable $closure
+	 *
+	 * @return mixed
+	 */
+	protected function fromCache(string $key, callable $closure)
+	{
+		$item = $this->cache->fetch($key);
+		if ($item === false) {
+			$item = $closure();
+			$this->cache->save($key, $item);
+		}
+
+		return $item;
+	}
 }

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

Indentation +28 added lines, -28 removed lines

@@ -4,36 +4,36 @@
 
 interface MethodDescriptorInterface
 {
-    /**
-     * Returns the name of the method to be generated.
-     *
-     * @return string
-     */
-    public function getName() : string;
+	/**
+	 * Returns the name of the method to be generated.
+	 *
+	 * @return string
+	 */
+	public function getName() : string;
 
-    /**
-     * Requests the use of an alternative name for this method.
-     */
-    public function useAlternativeName();
+	/**
+	 * Requests the use of an alternative name for this method.
+	 */
+	public function useAlternativeName();
 
-    /**
-     * Returns the code of the method.
-     *
-     * @return string
-     */
-    public function getCode() : string;
+	/**
+	 * Returns the code of the method.
+	 *
+	 * @return string
+	 */
+	public function getCode() : string;
 
-    /**
-     * Returns an array of classes that needs a "use" for this method.
-     *
-     * @return string[]
-     */
-    public function getUsedClasses() : array;
+	/**
+	 * Returns an array of classes that needs a "use" for this method.
+	 *
+	 * @return string[]
+	 */
+	public function getUsedClasses() : array;
 
-    /**
-     * Returns the code to past in jsonSerialize.
-     *
-     * @return string
-     */
-    public function getJsonSerializeCode() : string;
+	/**
+	 * Returns the code to past in jsonSerialize.
+	 *
+	 * @return string
+	 */
+	public function getJsonSerializeCode() : string;
 }

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/TDBMInheritanceException.php

Indentation +17 added lines, -17 removed lines

@@ -7,23 +7,23 @@
  */
 class TDBMInheritanceException extends TDBMException
 {
-    public static function create(array $tables) : TDBMInheritanceException
-    {
-        return new self(sprintf('The tables (%s) cannot be linked by an inheritance relationship. Does your data set contains multiple children for one parent row? (multiple inheritance is not supported by TDBM)', implode(', ', $tables)));
-    }
+	public static function create(array $tables) : TDBMInheritanceException
+	{
+		return new self(sprintf('The tables (%s) cannot be linked by an inheritance relationship. Does your data set contains multiple children for one parent row? (multiple inheritance is not supported by TDBM)', implode(', ', $tables)));
+	}
 
-    public static function extendException(TDBMInheritanceException $e, TDBMService $tdbmService, array $beanData) : TDBMInheritanceException
-    {
-        $pks = [];
-        foreach ($beanData as $table => $row) {
-            $primaryKeyColumns = $tdbmService->getPrimaryKeyColumns($table);
-            foreach ($primaryKeyColumns as $columnName) {
-                if ($row[$columnName] !== null) {
-                    $pks[] = $table.'.'.$columnName.' => '.var_export($row[$columnName], true);
-                }
-            }
-        }
+	public static function extendException(TDBMInheritanceException $e, TDBMService $tdbmService, array $beanData) : TDBMInheritanceException
+	{
+		$pks = [];
+		foreach ($beanData as $table => $row) {
+			$primaryKeyColumns = $tdbmService->getPrimaryKeyColumns($table);
+			foreach ($primaryKeyColumns as $columnName) {
+				if ($row[$columnName] !== null) {
+					$pks[] = $table.'.'.$columnName.' => '.var_export($row[$columnName], true);
+				}
+			}
+		}
 
-        throw new self($e->getMessage().' (row in error: '.implode(', ', $pks).')', 0, $e);
-    }
+		throw new self($e->getMessage().' (row in error: '.implode(', ', $pks).')', 0, $e);
+	}
 }

src/Mouf/Database/TDBM/TDBMCyclicReferenceException.php

Indentation +8 added lines, -8 removed lines

@@ -4,13 +4,13 @@
 
 class TDBMCyclicReferenceException extends TDBMException
 {
-    public static function createCyclicReference(string $tableName, AbstractTDBMObject $object) : TDBMCyclicReferenceException
-    {
-        return new self(sprintf("You are trying a grape of objects that reference each other. Unable to save object '%s' in table '%s'. It is already in the process of being saved.", get_class($object), $tableName));
-    }
+	public static function createCyclicReference(string $tableName, AbstractTDBMObject $object) : TDBMCyclicReferenceException
+	{
+		return new self(sprintf("You are trying a grape of objects that reference each other. Unable to save object '%s' in table '%s'. It is already in the process of being saved.", get_class($object), $tableName));
+	}
 
-    public static function extendCyclicReference(TDBMCyclicReferenceException $e, string $tableName, AbstractTDBMObject $object, string $fkName) : TDBMCyclicReferenceException
-    {
-        return new self($e->getMessage().sprintf(" This object is referenced by an object of type '%s' (table '%s') via foreign key '%s'", get_class($object), $tableName, $fkName), $e->getCode(), $e);
-    }
+	public static function extendCyclicReference(TDBMCyclicReferenceException $e, string $tableName, AbstractTDBMObject $object, string $fkName) : TDBMCyclicReferenceException
+	{
+		return new self($e->getMessage().sprintf(" This object is referenced by an object of type '%s' (table '%s') via foreign key '%s'", get_class($object), $tableName, $fkName), $e->getCode(), $e);
+	}
 }