thecodingmachine / database.tdbm

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];
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -78,7 +78,7 @@ 
 
         $results = [];
 
-        for ($i = 0, $count = count($parsed['ORDER']); $i < $count; ++$i) {
+        for ($i = 0, $count = count($parsed['ORDER']); $i<$count; ++$i) {
             $orderItem = $parsed['ORDER'][$i];
             if ($orderItem['expr_type'] === 'colref') {
                 $parts = $orderItem['no_quotes']['parts'];
@@ -97,9 +97,9 @@ 
                 ];
             } else {
                 $position = $orderItem['position'];
-                if ($i + 1 < $count) {
-                    $nextPosition = $parsed['ORDER'][$i + 1]['position'];
-                    $str = substr($sql, $position, $nextPosition - $position);
+                if ($i+1<$count) {
+                    $nextPosition = $parsed['ORDER'][$i+1]['position'];
+                    $str = substr($sql, $position, $nextPosition-$position);
                 } else {
                     $str = substr($sql, $position);
                 }

src/Mouf/Database/TDBM/UncheckedOrderBy.php

Indentation +18 added lines, -18 removed lines

@@ -20,24 +20,24 @@
  */
 class UncheckedOrderBy
 {
-    /**
-     * @var string
-     */
-    private $orderBy;
+	/**
+	 * @var string
+	 */
+	private $orderBy;
 
-    /**
-     * @param $orderBy
-     */
-    public function __construct(string $orderBy)
-    {
-        $this->orderBy = $orderBy;
-    }
+	/**
+	 * @param $orderBy
+	 */
+	public function __construct(string $orderBy)
+	{
+		$this->orderBy = $orderBy;
+	}
 
-    /**
-     * @return string
-     */
-    public function getOrderBy() : string
-    {
-        return $this->orderBy;
-    }
+	/**
+	 * @return string
+	 */
+	public function getOrderBy() : string
+	{
+		return $this->orderBy;
+	}
 }

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

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
         $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
 
         $pkColumnNames = $this->schema->getTable($this->mainTable)->getPrimaryKeyColumns();
-        $pkColumnNames = array_map(function ($pkColumn) {
+        $pkColumnNames = array_map(function($pkColumn) {
             return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
         }, $pkColumnNames);
 

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/Utils/ScalarBeanPropertyDescriptor.php

Indentation +167 added lines, -167 removed lines

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

src/Mouf/Database/TDBM/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;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -55,19 +55,19 @@ 
             ];
         }
 
-        $sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) {
+        $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) {
+        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);
+            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) {
+        $pkColumnNames = array_map(function($pkColumn) {
             return $this->tdbmService->getConnection()->quoteIdentifier($this->mainTable).'.'.$this->tdbmService->getConnection()->quoteIdentifier($pkColumn);
         }, $pkColumnNames);
 
@@ -128,7 +128,7 @@ 
      */
     private function getParentRelationshipForeignKeys($tableName)
     {
-        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
+        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function() use ($tableName) {
             return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
         });
     }
@@ -157,7 +157,7 @@ 
      */
     private function getChildrenRelationshipForeignKeys(string $tableName) : array
     {
-        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
+        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function() use ($tableName) {
             return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
         });
     }
@@ -172,7 +172,7 @@ 
         $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
 
         if (!empty($children)) {
-            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
+            $fksTables = array_map(function(ForeignKeyConstraint $fk) {
                 return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
             }, $children);
 

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

Indentation +543 added lines, -543 removed lines

@@ -16,228 +16,228 @@ 
  */
 class BeanDescriptor
 {
-    /**
-     * @var Table
-     */
-    private $table;
-
-    /**
-     * @var SchemaAnalyzer
-     */
-    private $schemaAnalyzer;
-
-    /**
-     * @var Schema
-     */
-    private $schema;
-
-    /**
-     * @var AbstractBeanPropertyDescriptor[]
-     */
-    private $beanPropertyDescriptors = [];
-
-    /**
-     * @var TDBMSchemaAnalyzer
-     */
-    private $tdbmSchemaAnalyzer;
-
-    public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
-    {
-        $this->table = $table;
-        $this->schemaAnalyzer = $schemaAnalyzer;
-        $this->schema = $schema;
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
-        $this->initBeanPropertyDescriptors();
-    }
-
-    private function initBeanPropertyDescriptors()
-    {
-        $this->beanPropertyDescriptors = $this->getProperties($this->table);
-    }
-
-    /**
-     * Returns the foreign-key the column is part of, if any. null otherwise.
-     *
-     * @param Table  $table
-     * @param Column $column
-     *
-     * @return ForeignKeyConstraint|null
-     */
-    private function isPartOfForeignKey(Table $table, Column $column)
-    {
-        $localColumnName = $column->getName();
-        foreach ($table->getForeignKeys() as $foreignKey) {
-            foreach ($foreignKey->getColumns() as $columnName) {
-                if ($columnName === $localColumnName) {
-                    return $foreignKey;
-                }
-            }
-        }
-
-        return;
-    }
-
-    /**
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    public function getBeanPropertyDescriptors()
-    {
-        return $this->beanPropertyDescriptors;
-    }
-
-    /**
-     * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
-     *
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    public function getConstructorProperties()
-    {
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
-            return $property->isCompulsory();
-        });
-
-        return $constructorProperties;
-    }
-
-    /**
-     * Returns the list of columns that have default values for a given table.
-     *
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    public function getPropertiesWithDefault()
-    {
-        $properties = $this->getPropertiesForTable($this->table);
-        $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
-            return $property->hasDefault();
-        });
-
-        return $defaultProperties;
-    }
-
-    /**
-     * Returns the list of properties exposed as getters and setters in this class.
-     *
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    public function getExposedProperties()
-    {
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
-            return $property->getTable()->getName() == $this->table->getName();
-        });
-
-        return $exposedProperties;
-    }
-
-    /**
-     * Returns the list of properties for this table (including parent tables).
-     *
-     * @param Table $table
-     *
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    private function getProperties(Table $table)
-    {
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
-        if ($parentRelationship) {
-            $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
-            $properties = $this->getProperties($parentTable);
-            // we merge properties by overriding property names.
-            $localProperties = $this->getPropertiesForTable($table);
-            foreach ($localProperties as $name => $property) {
-                // We do not override properties if this is a primary key!
-                if ($property->isPrimaryKey()) {
-                    continue;
-                }
-                $properties[$name] = $property;
-            }
-        } else {
-            $properties = $this->getPropertiesForTable($table);
-        }
-
-        return $properties;
-    }
-
-    /**
-     * Returns the list of properties for this table (ignoring parent tables).
-     *
-     * @param Table $table
-     *
-     * @return AbstractBeanPropertyDescriptor[]
-     */
-    private function getPropertiesForTable(Table $table)
-    {
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
-        if ($parentRelationship) {
-            $ignoreColumns = $parentRelationship->getLocalColumns();
-        } else {
-            $ignoreColumns = [];
-        }
-
-        $beanPropertyDescriptors = [];
-
-        foreach ($table->getColumns() as $column) {
-            if (array_search($column->getName(), $ignoreColumns) !== false) {
-                continue;
-            }
-
-            $fk = $this->isPartOfForeignKey($table, $column);
-            if ($fk !== null) {
-                // Check that previously added descriptors are not added on same FK (can happen with multi key FK).
-                foreach ($beanPropertyDescriptors as $beanDescriptor) {
-                    if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
-                        continue 2;
-                    }
-                }
-                // Check that this property is not an inheritance relationship
-                $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
-                if ($parentRelationship === $fk) {
-                    continue;
-                }
-
-                $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
-            } else {
-                $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
-            }
-        }
-
-        // Now, let's get the name of all properties and let's check there is no duplicate.
-        /** @var $names AbstractBeanPropertyDescriptor[] */
-        $names = [];
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
-            $name = $beanDescriptor->getUpperCamelCaseName();
-            if (isset($names[$name])) {
-                $names[$name]->useAlternativeName();
-                $beanDescriptor->useAlternativeName();
-            } else {
-                $names[$name] = $beanDescriptor;
-            }
-        }
-
-        // Final check (throw exceptions if problem arises)
-        $names = [];
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
-            $name = $beanDescriptor->getUpperCamelCaseName();
-            if (isset($names[$name])) {
-                throw new TDBMException('Unsolvable name conflict while generating method name');
-            } else {
-                $names[$name] = $beanDescriptor;
-            }
-        }
-
-        // Last step, let's rebuild the list with a map:
-        $beanPropertyDescriptorsMap = [];
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
-            $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
-        }
-
-        return $beanPropertyDescriptorsMap;
-    }
-
-    public function generateBeanConstructor()
-    {
-        $constructorProperties = $this->getConstructorProperties();
-
-        $constructorCode = '    /**
+	/**
+	 * @var Table
+	 */
+	private $table;
+
+	/**
+	 * @var SchemaAnalyzer
+	 */
+	private $schemaAnalyzer;
+
+	/**
+	 * @var Schema
+	 */
+	private $schema;
+
+	/**
+	 * @var AbstractBeanPropertyDescriptor[]
+	 */
+	private $beanPropertyDescriptors = [];
+
+	/**
+	 * @var TDBMSchemaAnalyzer
+	 */
+	private $tdbmSchemaAnalyzer;
+
+	public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
+	{
+		$this->table = $table;
+		$this->schemaAnalyzer = $schemaAnalyzer;
+		$this->schema = $schema;
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
+		$this->initBeanPropertyDescriptors();
+	}
+
+	private function initBeanPropertyDescriptors()
+	{
+		$this->beanPropertyDescriptors = $this->getProperties($this->table);
+	}
+
+	/**
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
+	 *
+	 * @param Table  $table
+	 * @param Column $column
+	 *
+	 * @return ForeignKeyConstraint|null
+	 */
+	private function isPartOfForeignKey(Table $table, Column $column)
+	{
+		$localColumnName = $column->getName();
+		foreach ($table->getForeignKeys() as $foreignKey) {
+			foreach ($foreignKey->getColumns() as $columnName) {
+				if ($columnName === $localColumnName) {
+					return $foreignKey;
+				}
+			}
+		}
+
+		return;
+	}
+
+	/**
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	public function getBeanPropertyDescriptors()
+	{
+		return $this->beanPropertyDescriptors;
+	}
+
+	/**
+	 * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
+	 *
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	public function getConstructorProperties()
+	{
+		$constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
+			return $property->isCompulsory();
+		});
+
+		return $constructorProperties;
+	}
+
+	/**
+	 * Returns the list of columns that have default values for a given table.
+	 *
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	public function getPropertiesWithDefault()
+	{
+		$properties = $this->getPropertiesForTable($this->table);
+		$defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
+			return $property->hasDefault();
+		});
+
+		return $defaultProperties;
+	}
+
+	/**
+	 * Returns the list of properties exposed as getters and setters in this class.
+	 *
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	public function getExposedProperties()
+	{
+		$exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
+			return $property->getTable()->getName() == $this->table->getName();
+		});
+
+		return $exposedProperties;
+	}
+
+	/**
+	 * Returns the list of properties for this table (including parent tables).
+	 *
+	 * @param Table $table
+	 *
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	private function getProperties(Table $table)
+	{
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
+		if ($parentRelationship) {
+			$parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
+			$properties = $this->getProperties($parentTable);
+			// we merge properties by overriding property names.
+			$localProperties = $this->getPropertiesForTable($table);
+			foreach ($localProperties as $name => $property) {
+				// We do not override properties if this is a primary key!
+				if ($property->isPrimaryKey()) {
+					continue;
+				}
+				$properties[$name] = $property;
+			}
+		} else {
+			$properties = $this->getPropertiesForTable($table);
+		}
+
+		return $properties;
+	}
+
+	/**
+	 * Returns the list of properties for this table (ignoring parent tables).
+	 *
+	 * @param Table $table
+	 *
+	 * @return AbstractBeanPropertyDescriptor[]
+	 */
+	private function getPropertiesForTable(Table $table)
+	{
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
+		if ($parentRelationship) {
+			$ignoreColumns = $parentRelationship->getLocalColumns();
+		} else {
+			$ignoreColumns = [];
+		}
+
+		$beanPropertyDescriptors = [];
+
+		foreach ($table->getColumns() as $column) {
+			if (array_search($column->getName(), $ignoreColumns) !== false) {
+				continue;
+			}
+
+			$fk = $this->isPartOfForeignKey($table, $column);
+			if ($fk !== null) {
+				// Check that previously added descriptors are not added on same FK (can happen with multi key FK).
+				foreach ($beanPropertyDescriptors as $beanDescriptor) {
+					if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
+						continue 2;
+					}
+				}
+				// Check that this property is not an inheritance relationship
+				$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
+				if ($parentRelationship === $fk) {
+					continue;
+				}
+
+				$beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
+			} else {
+				$beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
+			}
+		}
+
+		// Now, let's get the name of all properties and let's check there is no duplicate.
+		/** @var $names AbstractBeanPropertyDescriptor[] */
+		$names = [];
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
+			$name = $beanDescriptor->getUpperCamelCaseName();
+			if (isset($names[$name])) {
+				$names[$name]->useAlternativeName();
+				$beanDescriptor->useAlternativeName();
+			} else {
+				$names[$name] = $beanDescriptor;
+			}
+		}
+
+		// Final check (throw exceptions if problem arises)
+		$names = [];
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
+			$name = $beanDescriptor->getUpperCamelCaseName();
+			if (isset($names[$name])) {
+				throw new TDBMException('Unsolvable name conflict while generating method name');
+			} else {
+				$names[$name] = $beanDescriptor;
+			}
+		}
+
+		// Last step, let's rebuild the list with a map:
+		$beanPropertyDescriptorsMap = [];
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
+			$beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
+		}
+
+		return $beanPropertyDescriptorsMap;
+	}
+
+	public function generateBeanConstructor()
+	{
+		$constructorProperties = $this->getConstructorProperties();
+
+		$constructorCode = '    /**
      * The constructor takes all compulsory arguments.
      *
 %s
@@ -248,110 +248,110 @@ 
     }
     ';
 
-        $paramAnnotations = [];
-        $arguments = [];
-        $assigns = [];
-        $parentConstructorArguments = [];
-
-        foreach ($constructorProperties as $property) {
-            $className = $property->getClassName();
-            if ($className) {
-                $arguments[] = $className.' '.$property->getVariableName();
-            } else {
-                $arguments[] = $property->getVariableName();
-            }
-            $paramAnnotations[] = $property->getParamAnnotation();
-            if ($property->getTable()->getName() === $this->table->getName()) {
-                $assigns[] = $property->getConstructorAssignCode();
-            } else {
-                $parentConstructorArguments[] = $property->getVariableName();
-            }
-        }
-
-        $parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
-
-        foreach ($this->getPropertiesWithDefault() as $property) {
-            $assigns[] = $property->assignToDefaultCode();
-        }
-
-        return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns));
-    }
-
-    public function getDirectForeignKeysDescriptors()
-    {
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
-
-        $descriptors = [];
-
-        foreach ($fks as $fk) {
-            $descriptors[] = new DirectForeignKeyMethodDescriptor($fk, $this->table);
-        }
-
-        return $descriptors;
-    }
-
-    private function getPivotTableDescriptors()
-    {
-        $descs = [];
-        foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
-            // There are exactly 2 FKs since this is a pivot table.
-            $fks = array_values($table->getForeignKeys());
-
-            if ($fks[0]->getForeignTableName() === $this->table->getName()) {
-                list($localFk, $remoteFk) = $fks;
-            } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
-                list($remoteFk, $localFk) = $fks;
-            } else {
-                continue;
-            }
-
-            $descs[] = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk);
-        }
-
-        return $descs;
-    }
-
-    /**
-     * Returns the list of method descriptors (and applies the alternative name if needed).
-     *
-     * @return MethodDescriptorInterface[]
-     */
-    private function getMethodDescriptors()
-    {
-        $directForeignKeyDescriptors = $this->getDirectForeignKeysDescriptors();
-        $pivotTableDescriptors = $this->getPivotTableDescriptors();
-
-        $descriptors = array_merge($directForeignKeyDescriptors, $pivotTableDescriptors);
-
-        // Descriptors by method names
-        $descriptorsByMethodName = [];
-
-        foreach ($descriptors as $descriptor) {
-            $descriptorsByMethodName[$descriptor->getName()][] = $descriptor;
-        }
-
-        foreach ($descriptorsByMethodName as $descriptorsForMethodName) {
-            if (count($descriptorsForMethodName) > 1) {
-                foreach ($descriptorsForMethodName as $descriptor) {
-                    $descriptor->useAlternativeName();
-                }
-            }
-        }
-
-        return $descriptors;
-    }
-
-    public function generateJsonSerialize()
-    {
-        $tableName = $this->table->getName();
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
-        if ($parentFk !== null) {
-            $initializer = '$array = parent::jsonSerialize($stopRecursion);';
-        } else {
-            $initializer = '$array = [];';
-        }
-
-        $str = '
+		$paramAnnotations = [];
+		$arguments = [];
+		$assigns = [];
+		$parentConstructorArguments = [];
+
+		foreach ($constructorProperties as $property) {
+			$className = $property->getClassName();
+			if ($className) {
+				$arguments[] = $className.' '.$property->getVariableName();
+			} else {
+				$arguments[] = $property->getVariableName();
+			}
+			$paramAnnotations[] = $property->getParamAnnotation();
+			if ($property->getTable()->getName() === $this->table->getName()) {
+				$assigns[] = $property->getConstructorAssignCode();
+			} else {
+				$parentConstructorArguments[] = $property->getVariableName();
+			}
+		}
+
+		$parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
+
+		foreach ($this->getPropertiesWithDefault() as $property) {
+			$assigns[] = $property->assignToDefaultCode();
+		}
+
+		return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns));
+	}
+
+	public function getDirectForeignKeysDescriptors()
+	{
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
+
+		$descriptors = [];
+
+		foreach ($fks as $fk) {
+			$descriptors[] = new DirectForeignKeyMethodDescriptor($fk, $this->table);
+		}
+
+		return $descriptors;
+	}
+
+	private function getPivotTableDescriptors()
+	{
+		$descs = [];
+		foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
+			// There are exactly 2 FKs since this is a pivot table.
+			$fks = array_values($table->getForeignKeys());
+
+			if ($fks[0]->getForeignTableName() === $this->table->getName()) {
+				list($localFk, $remoteFk) = $fks;
+			} elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
+				list($remoteFk, $localFk) = $fks;
+			} else {
+				continue;
+			}
+
+			$descs[] = new PivotTableMethodsDescriptor($table, $localFk, $remoteFk);
+		}
+
+		return $descs;
+	}
+
+	/**
+	 * Returns the list of method descriptors (and applies the alternative name if needed).
+	 *
+	 * @return MethodDescriptorInterface[]
+	 */
+	private function getMethodDescriptors()
+	{
+		$directForeignKeyDescriptors = $this->getDirectForeignKeysDescriptors();
+		$pivotTableDescriptors = $this->getPivotTableDescriptors();
+
+		$descriptors = array_merge($directForeignKeyDescriptors, $pivotTableDescriptors);
+
+		// Descriptors by method names
+		$descriptorsByMethodName = [];
+
+		foreach ($descriptors as $descriptor) {
+			$descriptorsByMethodName[$descriptor->getName()][] = $descriptor;
+		}
+
+		foreach ($descriptorsByMethodName as $descriptorsForMethodName) {
+			if (count($descriptorsForMethodName) > 1) {
+				foreach ($descriptorsForMethodName as $descriptor) {
+					$descriptor->useAlternativeName();
+				}
+			}
+		}
+
+		return $descriptors;
+	}
+
+	public function generateJsonSerialize()
+	{
+		$tableName = $this->table->getName();
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
+		if ($parentFk !== null) {
+			$initializer = '$array = parent::jsonSerialize($stopRecursion);';
+		} else {
+			$initializer = '$array = [];';
+		}
+
+		$str = '
     /**
      * Serializes the object for JSON encoding.
      *
@@ -367,76 +367,76 @@ 
     }
 ';
 
-        $propertiesCode = '';
-        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
-            $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
-        }
-
-        // Many2many relationships
-        $methodsCode = '';
-        foreach ($this->getMethodDescriptors() as $methodDescriptor) {
-            $methodsCode .= $methodDescriptor->getJsonSerializeCode();
-        }
-
-        return sprintf($str, $initializer, $propertiesCode, $methodsCode);
-    }
-
-    /**
-     * Returns as an array the class we need to extend from and the list of use statements.
-     *
-     * @return array
-     */
-    private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
-    {
-        $classes = [];
-        if ($parentFk !== null) {
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
-            $classes[] = $extends;
-        }
-
-        foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
-            $className = $beanPropertyDescriptor->getClassName();
-            if (null !== $className) {
-                $classes[] = $beanPropertyDescriptor->getClassName();
-            }
-        }
-
-        foreach ($this->getMethodDescriptors() as $descriptor) {
-            $classes = array_merge($classes, $descriptor->getUsedClasses());
-        }
-
-        $classes = array_unique($classes);
-
-        return $classes;
-    }
-
-    /**
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
-     *
-     * @param string $beannamespace The namespace of the bean
-     */
-    public function generatePhpCode($beannamespace)
-    {
-        $tableName = $this->table->getName();
-        $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
-        $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
-
-        $classes = $this->generateExtendsAndUseStatements($parentFk);
-
-        $uses = array_map(function ($className) use ($beannamespace) {
-            return 'use '.$beannamespace.'\\'.$className.";\n";
-        }, $classes);
-        $use = implode('', $uses);
-
-        if ($parentFk !== null) {
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
-        } else {
-            $extends = 'AbstractTDBMObject';
-            $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
-        }
-
-        $str = "<?php
+		$propertiesCode = '';
+		foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
+			$propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
+		}
+
+		// Many2many relationships
+		$methodsCode = '';
+		foreach ($this->getMethodDescriptors() as $methodDescriptor) {
+			$methodsCode .= $methodDescriptor->getJsonSerializeCode();
+		}
+
+		return sprintf($str, $initializer, $propertiesCode, $methodsCode);
+	}
+
+	/**
+	 * Returns as an array the class we need to extend from and the list of use statements.
+	 *
+	 * @return array
+	 */
+	private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
+	{
+		$classes = [];
+		if ($parentFk !== null) {
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
+			$classes[] = $extends;
+		}
+
+		foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
+			$className = $beanPropertyDescriptor->getClassName();
+			if (null !== $className) {
+				$classes[] = $beanPropertyDescriptor->getClassName();
+			}
+		}
+
+		foreach ($this->getMethodDescriptors() as $descriptor) {
+			$classes = array_merge($classes, $descriptor->getUsedClasses());
+		}
+
+		$classes = array_unique($classes);
+
+		return $classes;
+	}
+
+	/**
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
+	 *
+	 * @param string $beannamespace The namespace of the bean
+	 */
+	public function generatePhpCode($beannamespace)
+	{
+		$tableName = $this->table->getName();
+		$baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
+		$className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
+
+		$classes = $this->generateExtendsAndUseStatements($parentFk);
+
+		$uses = array_map(function ($className) use ($beannamespace) {
+			return 'use '.$beannamespace.'\\'.$className.";\n";
+		}, $classes);
+		$use = implode('', $uses);
+
+		if ($parentFk !== null) {
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
+		} else {
+			$extends = 'AbstractTDBMObject';
+			$use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
+		}
+
+		$str = "<?php
 namespace {$beannamespace}\\Generated;
 
 use Mouf\\Database\\TDBM\\ResultIterator;
@@ -456,129 +456,129 @@ 
 {
 ";
 
-        $str .= $this->generateBeanConstructor();
+		$str .= $this->generateBeanConstructor();
 
-        foreach ($this->getExposedProperties() as $property) {
-            $str .= $property->getGetterSetterCode();
-        }
+		foreach ($this->getExposedProperties() as $property) {
+			$str .= $property->getGetterSetterCode();
+		}
 
-        foreach ($this->getMethodDescriptors() as $methodDescriptor) {
-            $str .= $methodDescriptor->getCode();
-        }
-        $str .= $this->generateJsonSerialize();
+		foreach ($this->getMethodDescriptors() as $methodDescriptor) {
+			$str .= $methodDescriptor->getCode();
+		}
+		$str .= $this->generateJsonSerialize();
 
-        $str .= $this->generateGetUsedTablesCode();
+		$str .= $this->generateGetUsedTablesCode();
 
-        $str .= $this->generateOnDeleteCode();
+		$str .= $this->generateOnDeleteCode();
 
-        $str .= '}
+		$str .= '}
 ';
 
-        return $str;
-    }
-
-    /**
-     * @param string $beanNamespace
-     * @param string $beanClassName
-     *
-     * @return array first element: list of used beans, second item: PHP code as a string
-     */
-    public function generateFindByDaoCode($beanNamespace, $beanClassName)
-    {
-        $code = '';
-        $usedBeans = [];
-        foreach ($this->table->getIndexes() as $index) {
-            if (!$index->isPrimary()) {
-                list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
-                $code .= $codeForIndex;
-                $usedBeans = array_merge($usedBeans, $usedBeansForIndex);
-            }
-        }
-
-        return [$usedBeans, $code];
-    }
-
-    /**
-     * @param Index  $index
-     * @param string $beanNamespace
-     * @param string $beanClassName
-     *
-     * @return array first element: list of used beans, second item: PHP code as a string
-     */
-    private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
-    {
-        $columns = $index->getColumns();
-        $usedBeans = [];
-
-        /*
+		return $str;
+	}
+
+	/**
+	 * @param string $beanNamespace
+	 * @param string $beanClassName
+	 *
+	 * @return array first element: list of used beans, second item: PHP code as a string
+	 */
+	public function generateFindByDaoCode($beanNamespace, $beanClassName)
+	{
+		$code = '';
+		$usedBeans = [];
+		foreach ($this->table->getIndexes() as $index) {
+			if (!$index->isPrimary()) {
+				list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
+				$code .= $codeForIndex;
+				$usedBeans = array_merge($usedBeans, $usedBeansForIndex);
+			}
+		}
+
+		return [$usedBeans, $code];
+	}
+
+	/**
+	 * @param Index  $index
+	 * @param string $beanNamespace
+	 * @param string $beanClassName
+	 *
+	 * @return array first element: list of used beans, second item: PHP code as a string
+	 */
+	private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
+	{
+		$columns = $index->getColumns();
+		$usedBeans = [];
+
+		/*
          * The list of elements building this index (expressed as columns or foreign keys)
          * @var AbstractBeanPropertyDescriptor[]
          */
-        $elements = [];
-
-        foreach ($columns as $column) {
-            $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
-            if ($fk !== null) {
-                if (!in_array($fk, $elements)) {
-                    $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
-                }
-            } else {
-                $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
-            }
-        }
-
-        // If the index is actually only a foreign key, let's bypass it entirely.
-        if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
-            return [[], ''];
-        }
-
-        $methodNameComponent = [];
-        $functionParameters = [];
-        $first = true;
-        foreach ($elements as $element) {
-            $methodNameComponent[] = $element->getUpperCamelCaseName();
-            $functionParameter = $element->getClassName();
-            if ($functionParameter) {
-                $usedBeans[] = $beanNamespace.'\\'.$functionParameter;
-                $functionParameter .= ' ';
-            }
-            $functionParameter .= $element->getVariableName();
-            if ($first) {
-                $first = false;
-            } else {
-                $functionParameter .= ' = null';
-            }
-            $functionParameters[] = $functionParameter;
-        }
-        if ($index->isUnique()) {
-            $methodName = 'findOneBy'.implode('And', $methodNameComponent);
-            $calledMethod = 'findOne';
-            $returnType = "{$beanClassName}";
-        } else {
-            $methodName = 'findBy'.implode('And', $methodNameComponent);
-            $returnType = "{$beanClassName}[]|ResultIterator|ResultArray";
-            $calledMethod = 'find';
-        }
-        $functionParametersString = implode(', ', $functionParameters);
-
-        $count = 0;
-
-        $params = [];
-        $filterArrayCode = '';
-        $commentArguments = [];
-        foreach ($elements as $element) {
-            $params[] = $element->getParamAnnotation();
-            if ($element instanceof ScalarBeanPropertyDescriptor) {
-                $filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
-            } else {
-                ++$count;
-                $filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
-            }
-            $commentArguments[] = substr($element->getVariableName(), 1);
-        }
-        $paramsString = implode("\n", $params);
-
-        $code = "
+		$elements = [];
+
+		foreach ($columns as $column) {
+			$fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
+			if ($fk !== null) {
+				if (!in_array($fk, $elements)) {
+					$elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
+				}
+			} else {
+				$elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
+			}
+		}
+
+		// If the index is actually only a foreign key, let's bypass it entirely.
+		if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
+			return [[], ''];
+		}
+
+		$methodNameComponent = [];
+		$functionParameters = [];
+		$first = true;
+		foreach ($elements as $element) {
+			$methodNameComponent[] = $element->getUpperCamelCaseName();
+			$functionParameter = $element->getClassName();
+			if ($functionParameter) {
+				$usedBeans[] = $beanNamespace.'\\'.$functionParameter;
+				$functionParameter .= ' ';
+			}
+			$functionParameter .= $element->getVariableName();
+			if ($first) {
+				$first = false;
+			} else {
+				$functionParameter .= ' = null';
+			}
+			$functionParameters[] = $functionParameter;
+		}
+		if ($index->isUnique()) {
+			$methodName = 'findOneBy'.implode('And', $methodNameComponent);
+			$calledMethod = 'findOne';
+			$returnType = "{$beanClassName}";
+		} else {
+			$methodName = 'findBy'.implode('And', $methodNameComponent);
+			$returnType = "{$beanClassName}[]|ResultIterator|ResultArray";
+			$calledMethod = 'find';
+		}
+		$functionParametersString = implode(', ', $functionParameters);
+
+		$count = 0;
+
+		$params = [];
+		$filterArrayCode = '';
+		$commentArguments = [];
+		foreach ($elements as $element) {
+			$params[] = $element->getParamAnnotation();
+			if ($element instanceof ScalarBeanPropertyDescriptor) {
+				$filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
+			} else {
+				++$count;
+				$filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
+			}
+			$commentArguments[] = substr($element->getVariableName(), 1);
+		}
+		$paramsString = implode("\n", $params);
+
+		$code = "
     /**
      * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).".
      *
@@ -596,27 +596,27 @@ 
     }
 ";
 
-        return [$usedBeans, $code];
-    }
-
-    /**
-     * Generates the code for the getUsedTable protected method.
-     *
-     * @return string
-     */
-    private function generateGetUsedTablesCode()
-    {
-        $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null;
-        if ($hasParentRelationship) {
-            $code = sprintf('        $tables = parent::getUsedTables();
+		return [$usedBeans, $code];
+	}
+
+	/**
+	 * Generates the code for the getUsedTable protected method.
+	 *
+	 * @return string
+	 */
+	private function generateGetUsedTablesCode()
+	{
+		$hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null;
+		if ($hasParentRelationship) {
+			$code = sprintf('        $tables = parent::getUsedTables();
         $tables[] = %s;
         
         return $tables;', var_export($this->table->getName(), true));
-        } else {
-            $code = sprintf('        return [ %s ];', var_export($this->table->getName(), true));
-        }
+		} else {
+			$code = sprintf('        return [ %s ];', var_export($this->table->getName(), true));
+		}
 
-        return sprintf('
+		return sprintf('
     /**
      * Returns an array of used tables by this bean (from parent to child relationship).
      *
@@ -627,20 +627,20 @@ 
 %s    
     }
 ', $code);
-    }
-
-    private function generateOnDeleteCode()
-    {
-        $code = '';
-        $relationships = $this->getPropertiesForTable($this->table);
-        foreach ($relationships as $relationship) {
-            if ($relationship instanceof ObjectBeanPropertyDescriptor) {
-                $code .= sprintf('        $this->setRef('.var_export($relationship->getForeignKey()->getName(), true).', null, '.var_export($this->table->getName(), true).");\n");
-            }
-        }
-
-        if ($code) {
-            return sprintf('
+	}
+
+	private function generateOnDeleteCode()
+	{
+		$code = '';
+		$relationships = $this->getPropertiesForTable($this->table);
+		foreach ($relationships as $relationship) {
+			if ($relationship instanceof ObjectBeanPropertyDescriptor) {
+				$code .= sprintf('        $this->setRef('.var_export($relationship->getForeignKey()->getName(), true).', null, '.var_export($this->table->getName(), true).");\n");
+			}
+		}
+
+		if ($code) {
+			return sprintf('
     /**
      * Method called when the bean is removed from database.
      *
@@ -651,8 +651,8 @@ 
 %s
     }
 ', $code);
-        }
+		}
 
-        return '';
-    }
+		return '';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -92,7 +92,7 @@ 
      */
     public function getConstructorProperties()
     {
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
+        $constructorProperties = array_filter($this->beanPropertyDescriptors, function(AbstractBeanPropertyDescriptor $property) {
             return $property->isCompulsory();
         });
 
@@ -107,7 +107,7 @@ 
     public function getPropertiesWithDefault()
     {
         $properties = $this->getPropertiesForTable($this->table);
-        $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
+        $defaultProperties = array_filter($properties, function(AbstractBeanPropertyDescriptor $property) {
             return $property->hasDefault();
         });
 
@@ -121,7 +121,7 @@ 
      */
     public function getExposedProperties()
     {
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
+        $exposedProperties = array_filter($this->beanPropertyDescriptors, function(AbstractBeanPropertyDescriptor $property) {
             return $property->getTable()->getName() == $this->table->getName();
         });
 
@@ -331,7 +331,7 @@ 
         }
 
         foreach ($descriptorsByMethodName as $descriptorsForMethodName) {
-            if (count($descriptorsForMethodName) > 1) {
+            if (count($descriptorsForMethodName)>1) {
                 foreach ($descriptorsForMethodName as $descriptor) {
                     $descriptor->useAlternativeName();
                 }
@@ -424,7 +424,7 @@ 
 
         $classes = $this->generateExtendsAndUseStatements($parentFk);
 
-        $uses = array_map(function ($className) use ($beannamespace) {
+        $uses = array_map(function($className) use ($beannamespace) {
             return 'use '.$beannamespace.'\\'.$className.";\n";
         }, $classes);
         $use = implode('', $uses);

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;
 }