thecodingmachine / database.tdbm

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

Indentation +594 added lines, -594 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
@@ -247,70 +247,70 @@ 
 %s    }
     ';
 
-        $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));
-
-        $defaultAssigns = [];
-        foreach ($this->getPropertiesWithDefault() as $property) {
-            $defaultAssigns[] = $property->assignToDefaultCode();
-        }
-
-        return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns));
-    }
-
-    public function generateDirectForeignKeysCode()
-    {
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
-
-        $fksByTable = [];
-
-        foreach ($fks as $fk) {
-            $fksByTable[$fk->getLocalTableName()][] = $fk;
-        }
-
-        /* @var $fksByMethodName ForeignKeyConstraint[] */
-        $fksByMethodName = [];
-
-        foreach ($fksByTable as $tableName => $fksForTable) {
-            if (count($fksForTable) > 1) {
-                foreach ($fksForTable as $fk) {
-                    $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
-
-                    $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
-
-                    $methodName .= implode('And', $camelizedColumns);
-
-                    $fksByMethodName[$methodName] = $fk;
-                }
-            } else {
-                $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
-                $fksByMethodName[$methodName] = $fksForTable[0];
-            }
-        }
-
-        $code = '';
-
-        foreach ($fksByMethodName as $methodName => $fk) {
-            $getterCode = '    /**
+		$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));
+
+		$defaultAssigns = [];
+		foreach ($this->getPropertiesWithDefault() as $property) {
+			$defaultAssigns[] = $property->assignToDefaultCode();
+		}
+
+		return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns));
+	}
+
+	public function generateDirectForeignKeysCode()
+	{
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
+
+		$fksByTable = [];
+
+		foreach ($fks as $fk) {
+			$fksByTable[$fk->getLocalTableName()][] = $fk;
+		}
+
+		/* @var $fksByMethodName ForeignKeyConstraint[] */
+		$fksByMethodName = [];
+
+		foreach ($fksByTable as $tableName => $fksForTable) {
+			if (count($fksForTable) > 1) {
+				foreach ($fksForTable as $fk) {
+					$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
+
+					$camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
+
+					$methodName .= implode('And', $camelizedColumns);
+
+					$fksByMethodName[$methodName] = $fk;
+				}
+			} else {
+				$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
+				$fksByMethodName[$methodName] = $fksForTable[0];
+			}
+		}
+
+		$code = '';
+
+		foreach ($fksByMethodName as $methodName => $fk) {
+			$getterCode = '    /**
      * Returns the list of %s pointing to this bean via the %s column.
      *
      * @return %s[]|ResultIterator
@@ -322,111 +322,111 @@ 
 
 ';
 
-            list($sql, $parametersCode) = $this->getFilters($fk);
-
-            $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
-            $code .= sprintf($getterCode,
-                $beanClass,
-                implode(', ', $fk->getColumns()),
-                $beanClass,
-                $methodName,
-                var_export($fk->getLocalTableName(), true),
-                $sql,
-                $parametersCode
-            );
-        }
-
-        return $code;
-    }
-
-    private function getFilters(ForeignKeyConstraint $fk)
-    {
-        $sqlParts = [];
-        $counter = 0;
-        $parameters = [];
-
-        $pkColumns = $this->table->getPrimaryKeyColumns();
-
-        foreach ($fk->getLocalColumns() as $columnName) {
-            $paramName = 'tdbmparam'.$counter;
-            $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
-
-            $pkColumn = $pkColumns[$counter];
-            $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
-            ++$counter;
-        }
-        $sql = "'".implode(' AND ', $sqlParts)."'";
-        $parametersCode = '[ '.implode(', ', $parameters).' ]';
-
-        return [$sql, $parametersCode];
-    }
-
-    /**
-     * Generate code section about pivot tables.
-     *
-     * @return string
-     */
-    public function generatePivotTableCode()
-    {
-        $finalDescs = $this->getPivotTableDescriptors();
-
-        $code = '';
-
-        foreach ($finalDescs as $desc) {
-            $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
-        }
-
-        return $code;
-    }
-
-    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()) {
-                $localFK = $fks[0];
-                $remoteFK = $fks[1];
-            } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
-                $localFK = $fks[1];
-                $remoteFK = $fks[0];
-            } else {
-                continue;
-            }
-
-            $descs[$remoteFK->getForeignTableName()][] = [
-                'table' => $table,
-                'localFK' => $localFK,
-                'remoteFK' => $remoteFK,
-            ];
-        }
-
-        $finalDescs = [];
-        foreach ($descs as $descArray) {
-            if (count($descArray) > 1) {
-                foreach ($descArray as $desc) {
-                    $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
-                    $finalDescs[] = $desc;
-                }
-            } else {
-                $desc = $descArray[0];
-                $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
-                $finalDescs[] = $desc;
-            }
-        }
-
-        return $finalDescs;
-    }
-
-    public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
-    {
-        $singularName = TDBMDaoGenerator::toSingular($name);
-        $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
-
-        $str = '    /**
+			list($sql, $parametersCode) = $this->getFilters($fk);
+
+			$beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
+			$code .= sprintf($getterCode,
+				$beanClass,
+				implode(', ', $fk->getColumns()),
+				$beanClass,
+				$methodName,
+				var_export($fk->getLocalTableName(), true),
+				$sql,
+				$parametersCode
+			);
+		}
+
+		return $code;
+	}
+
+	private function getFilters(ForeignKeyConstraint $fk)
+	{
+		$sqlParts = [];
+		$counter = 0;
+		$parameters = [];
+
+		$pkColumns = $this->table->getPrimaryKeyColumns();
+
+		foreach ($fk->getLocalColumns() as $columnName) {
+			$paramName = 'tdbmparam'.$counter;
+			$sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
+
+			$pkColumn = $pkColumns[$counter];
+			$parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
+			++$counter;
+		}
+		$sql = "'".implode(' AND ', $sqlParts)."'";
+		$parametersCode = '[ '.implode(', ', $parameters).' ]';
+
+		return [$sql, $parametersCode];
+	}
+
+	/**
+	 * Generate code section about pivot tables.
+	 *
+	 * @return string
+	 */
+	public function generatePivotTableCode()
+	{
+		$finalDescs = $this->getPivotTableDescriptors();
+
+		$code = '';
+
+		foreach ($finalDescs as $desc) {
+			$code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
+		}
+
+		return $code;
+	}
+
+	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()) {
+				$localFK = $fks[0];
+				$remoteFK = $fks[1];
+			} elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
+				$localFK = $fks[1];
+				$remoteFK = $fks[0];
+			} else {
+				continue;
+			}
+
+			$descs[$remoteFK->getForeignTableName()][] = [
+				'table' => $table,
+				'localFK' => $localFK,
+				'remoteFK' => $remoteFK,
+			];
+		}
+
+		$finalDescs = [];
+		foreach ($descs as $descArray) {
+			if (count($descArray) > 1) {
+				foreach ($descArray as $desc) {
+					$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
+					$finalDescs[] = $desc;
+				}
+			} else {
+				$desc = $descArray[0];
+				$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
+				$finalDescs[] = $desc;
+			}
+		}
+
+		return $finalDescs;
+	}
+
+	public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
+	{
+		$singularName = TDBMDaoGenerator::toSingular($name);
+		$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
+
+		$str = '    /**
      * Returns the list of %s associated to this bean via the %s pivot table.
      *
      * @return %s[]
@@ -436,9 +436,9 @@ 
     }
 ';
 
-        $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
+		$getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
 
-        $str = '    /**
+		$str = '    /**
      * Adds a relationship with %s associated to this bean via the %s pivot table.
      *
      * @param %s %s
@@ -448,9 +448,9 @@ 
     }
 ';
 
-        $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
+		$adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
 
-        $str = '    /**
+		$str = '    /**
      * Deletes the relationship with %s associated to this bean via the %s pivot table.
      *
      * @param %s %s
@@ -460,9 +460,9 @@ 
     }
 ';
 
-        $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
+		$removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
 
-        $str = '    /**
+		$str = '    /**
      * Returns whether this bean is associated with %s via the %s pivot table.
      *
      * @param %s %s
@@ -473,24 +473,24 @@ 
     }
 ';
 
-        $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
+		$hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
 
-        $code = $getterCode.$adderCode.$removerCode.$hasCode;
+		$code = $getterCode.$adderCode.$removerCode.$hasCode;
 
-        return $code;
-    }
+		return $code;
+	}
 
-    public function generateJsonSerialize()
-    {
-        $tableName = $this->table->getName();
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
-        if ($parentFk !== null) {
-            $initializer = '$array = parent::jsonSerialize();';
-        } else {
-            $initializer = '$array = [];';
-        }
+	public function generateJsonSerialize()
+	{
+		$tableName = $this->table->getName();
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
+		if ($parentFk !== null) {
+			$initializer = '$array = parent::jsonSerialize();';
+		} else {
+			$initializer = '$array = [];';
+		}
 
-        $str = '
+		$str = '
     /**
      * Serializes the object for JSON encoding
      *
@@ -506,89 +506,89 @@ 
     }
 ';
 
-        $propertiesCode = '';
-        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
-            $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
-        }
+		$propertiesCode = '';
+		foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
+			$propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
+		}
 
-        // Many to many relationships:
+		// Many to many relationships:
 
-        $descs = $this->getPivotTableDescriptors();
+		$descs = $this->getPivotTableDescriptors();
 
-        $many2manyCode = '';
+		$many2manyCode = '';
 
-        foreach ($descs as $desc) {
-            $remoteFK = $desc['remoteFK'];
-            $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
-            $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
+		foreach ($descs as $desc) {
+			$remoteFK = $desc['remoteFK'];
+			$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
+			$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
 
-            $many2manyCode .= '        if (!$stopRecursion) {
+			$many2manyCode .= '        if (!$stopRecursion) {
             $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') {
                 return '.$variableName.'->jsonSerialize(true);
             }, $this->get'.$desc['name'].'());
         }
         ';
-        }
-
-        return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
-    }
-
-    /**
-     * 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->getPivotTableDescriptors() as $descriptor) {
-            /* @var $fk ForeignKeyConstraint */
-            $fk = $descriptor['remoteFK'];
-            $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
-        }
-
-        $classes = array_flip(array_flip($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
+		}
+
+		return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
+	}
+
+	/**
+	 * 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->getPivotTableDescriptors() as $descriptor) {
+			/* @var $fk ForeignKeyConstraint */
+			$fk = $descriptor['remoteFK'];
+			$classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
+		}
+
+		$classes = array_flip(array_flip($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;
@@ -606,122 +606,122 @@ 
 {
 ";
 
-        $str .= $this->generateBeanConstructor();
+		$str .= $this->generateBeanConstructor();
 
-        foreach ($this->getExposedProperties() as $property) {
-            $str .= $property->getGetterSetterCode();
-        }
+		foreach ($this->getExposedProperties() as $property) {
+			$str .= $property->getGetterSetterCode();
+		}
 
-        $str .= $this->generateDirectForeignKeysCode();
-        $str .= $this->generatePivotTableCode();
-        $str .= $this->generateJsonSerialize();
+		$str .= $this->generateDirectForeignKeysCode();
+		$str .= $this->generatePivotTableCode();
+		$str .= $this->generateJsonSerialize();
 
-        $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';
-        } else {
-            $methodName = 'findBy'.implode('And', $methodNameComponent);
-            $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';
+		} else {
+			$methodName = 'findBy'.implode('And', $methodNameComponent);
+			$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).".
      *
@@ -739,6 +739,6 @@ 
     }
 ";
 
-        return [$usedBeans, $code];
-    }
+		return [$usedBeans, $code];
+	}
 }

src/Mouf/Database/TDBM/TDBMSchemaAnalyzer.php

Indentation +132 added lines, -132 removed lines

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