/**
* Compute the difference between two Foreign key objects
*
* @param ForeignKey $fromFk
* @param ForeignKey $toFk
*
* @param boolean $caseInsensitive Whether the comparison is case insensitive.
* False by default.
*
* @return boolean false if the two fks are similar, true if they have differences
*/
public static function computeDiff(ForeignKey $fromFk, ForeignKey $toFk, $caseInsensitive = false)
{
// Check for differences in local and remote table
$test = $caseInsensitive ? strtolower($fromFk->getTableName()) != strtolower($toFk->getTableName()) : $fromFk->getTableName() != $toFk->getTableName();
if ($test) {
return true;
}
$test = $caseInsensitive ? strtolower($fromFk->getForeignTableName()) != strtolower($toFk->getForeignTableName()) : $fromFk->getForeignTableName() != $toFk->getForeignTableName();
if ($test) {
return true;
}
// compare columns
$fromFkLocalColumns = $fromFk->getLocalColumns();
sort($fromFkLocalColumns);
$toFkLocalColumns = $toFk->getLocalColumns();
sort($toFkLocalColumns);
if (array_map('strtolower', $fromFkLocalColumns) != array_map('strtolower', $toFkLocalColumns)) {
return true;
}
$fromFkForeignColumns = $fromFk->getForeignColumns();
sort($fromFkForeignColumns);
$toFkForeignColumns = $toFk->getForeignColumns();
sort($toFkForeignColumns);
if (array_map('strtolower', $fromFkForeignColumns) != array_map('strtolower', $toFkForeignColumns)) {
return true;
}
// compare on
if ($fromFk->normalizeFKey($fromFk->getOnUpdate()) != $toFk->normalizeFKey($toFk->getOnUpdate())) {
return true;
}
if ($fromFk->normalizeFKey($fromFk->getOnDelete()) != $toFk->normalizeFKey($toFk->getOnDelete())) {
return true;
}
// compare skipSql
if ($fromFk->isSkipSql() != $toFk->isSkipSql()) {
return true;
}
return false;
}
public function getForeignKeyDDL(ForeignKey $fk)
{
if ($fk->isSkipSql() || $fk->isPolymorphic()) {
return;
}
$pattern = 'CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s)';
$script = sprintf($pattern, $this->quoteIdentifier($fk->getName()), $this->getColumnListDDL($fk->getLocalColumnObjects()), $this->quoteIdentifier($fk->getForeignTableName()), $this->getColumnListDDL($fk->getForeignColumnObjects()));
if ($fk->hasOnUpdate() && $fk->getOnUpdate() != ForeignKey::SETNULL) {
$script .= ' ON UPDATE ' . $fk->getOnUpdate();
}
if ($fk->hasOnDelete() && $fk->getOnDelete() != ForeignKey::SETNULL) {
$script .= ' ON DELETE ' . $fk->getOnDelete();
}
return $script;
}
protected static function getRefRelatedBySuffix(ForeignKey $fk)
{
$relCol = '';
foreach ($fk->getLocalForeignMapping() as $localColumnName => $foreignColumnName) {
$localTable = $fk->getTable();
$localColumn = $localTable->getColumn($localColumnName);
if (!$localColumn) {
throw new RuntimeException(sprintf('Could not fetch column: %s in table %s.', $localColumnName, $localTable->getName()));
}
$foreignKeysToForeignTable = $localTable->getForeignKeysReferencingTable($fk->getForeignTableName());
if ($fk->getForeignTableName() == $fk->getTableName()) {
// self referential foreign key
$relCol .= $fk->getForeignTable()->getColumn($foreignColumnName)->getPhpName();
if (count($foreignKeysToForeignTable) > 1) {
// several self-referential foreign keys
$relCol .= array_search($fk, $foreignKeysToForeignTable);
}
} elseif (count($foreignKeysToForeignTable) > 1 || count($fk->getForeignTable()->getForeignKeysReferencingTable($fk->getTableName())) > 0) {
// several foreign keys to the same table, or symmetrical foreign key in foreign table
$relCol .= $localColumn->getPhpName();
}
}
if (!empty($relCol)) {
$relCol = 'RelatedBy' . $relCol;
}
return $relCol;
}
public function getForeignKeyDDL(ForeignKey $fk)
{
if ($fk->isSkipSql() || $fk->isPolymorphic()) {
return;
}
$pattern = "CONSTRAINT %s\n FOREIGN KEY (%s) REFERENCES %s (%s)";
$script = sprintf($pattern, $this->quoteIdentifier($fk->getName()), $this->getColumnListDDL($fk->getLocalColumnObjects()), $this->quoteIdentifier($fk->getForeignTableName()), $this->getColumnListDDL($fk->getForeignColumnObjects()));
if ($fk->hasOnDelete()) {
$script .= "\n ON DELETE " . $fk->getOnDelete();
}
return $script;
}
public function getForeignKeyDDL(ForeignKey $fk)
{
if ($fk->isSkipSql() || !$this->foreignKeySupport) {
return;
}
$pattern = "FOREIGN KEY (%s) REFERENCES %s (%s)";
$script = sprintf($pattern, $this->getColumnListDDL($fk->getLocalColumns()), $this->quoteIdentifier($fk->getForeignTableName()), $this->getColumnListDDL($fk->getForeignColumns()));
if ($fk->hasOnUpdate()) {
$script .= "\n ON UPDATE " . $fk->getOnUpdate();
}
if ($fk->hasOnDelete()) {
$script .= "\n ON DELETE " . $fk->getOnDelete();
}
return $script;
}
public function getForeignKeyDDL(ForeignKey $fk)
{
$pattern = "\n-- SQLite does not support foreign keys; this is just for reference\n-- FOREIGN KEY (%s) REFERENCES %s (%s)\n";
return sprintf($pattern, $this->getColumnListDDL($fk->getLocalColumns()), $fk->getForeignTableName(), $this->getColumnListDDL($fk->getForeignColumns()));
}
public function testGetInverseForeignKey()
{
$database = $this->getDatabaseMock('bookstore');
$platform = $this->getPlatformMock(true);
$foreignTable = $this->getTableMock('authors');
$localTable = $this->getTableMock('books', ['platform' => $platform, 'database' => $database]);
$database->expects($this->any())->method('getTable')->with($this->equalTo('bookstore.authors'))->will($this->returnValue($foreignTable));
$inversedFk = new ForeignKey();
$inversedFk->addReference('id', 'author_id');
$inversedFk->setTable($localTable);
$inversedFk->setForeignSchemaName('bookstore');
$inversedFk->setForeignTableCommonName('authors');
$foreignTable->expects($this->any())->method('getForeignKeys')->will($this->returnValue([$inversedFk]));
$fk = new ForeignKey();
$fk->setTable($localTable);
$fk->addReference('author_id', 'id');
$fk->setForeignSchemaName('bookstore');
$fk->setForeignTableCommonName('authors');
$this->assertSame('authors', $fk->getForeignTableCommonName());
$this->assertSame('bookstore.authors', $fk->getForeignTableName());
$this->assertInstanceOf('Propel\\Generator\\Model\\Table', $fk->getForeignTable());
$this->assertSame($inversedFk, $fk->getInverseFK());
$this->assertTrue($fk->isMatchedByInverseFK());
}
