/**
* Return relations as an array
*
* Array must contain 'type' for relation type, 'id' for the name
* of the PK column of the related table, 'model' for the related class
* name, 'notnull' for nullability. 'local' for the name of the local column
* Key must be the alias of the relation column
*
* @return array
*/
public function getManyRelations()
{
$rels = $this->_table->getRelations();
$relations = array();
foreach ($rels as $rel) {
$relation = array();
if ($rel->getType() == Doctrine_Relation::MANY && isset($rel['refTable'])) {
$relation['id'] = $rel->getTable()->getIdentifier();
$relation['model'] = $rel->getClass();
$relation['local'] = $rel->getLocal();
$definition = $this->_table->getColumnDefinition($rel->getLocal());
$relation['notnull'] = isset($definition['notnull']) ? $definition['notnull'] : false;
$relations[$rel->getAlias()] = $relation;
}
}
return $relations;
}
/**
* Retrieves a column definition from this table schema.
*
* @param string $columnName
* @return array column definition; @see $_columns
*/
public function getColumnDefinition($columnName)
{
$columnDefinition = parent::getColumnDefinition($columnName);
if (!$columnDefinition && $this->hasI18n()) {
$columnDefinition = $this->getI18nTable()->getColumnDefinition($columnName);
}
return $columnDefinition;
}
/**
* Completes the given definition
*
* @param array $def definition array to be completed
* @return array completed definition array
* @todo Description: What does it mean to complete a definition? What is done (not how)?
* Refactor (too long & nesting level)
*/
public function completeDefinition($def)
{
$conn = $this->_table->getConnection();
$def['table'] = $this->getImpl($def['class']);
$def['localTable'] = $this->_table;
$def['class'] = $def['table']->getComponentName();
$foreignClasses = array_merge($def['table']->getOption('parents'), array($def['class']));
$localClasses = array_merge($this->_table->getOption('parents'), array($this->_table->getComponentName()));
$localIdentifierColumnNames = $this->_table->getIdentifierColumnNames();
$localIdentifierCount = count($localIdentifierColumnNames);
$localIdColumnName = array_pop($localIdentifierColumnNames);
$foreignIdentifierColumnNames = $def['table']->getIdentifierColumnNames();
$foreignIdColumnName = array_pop($foreignIdentifierColumnNames);
if (isset($def['local'])) {
$def['local'] = $def['localTable']->getColumnName($def['local']);
if (!isset($def['foreign'])) {
// local key is set, but foreign key is not
// try to guess the foreign key
if ($def['local'] === $localIdColumnName) {
$def['foreign'] = $this->guessColumns($localClasses, $def['table']);
} else {
// the foreign field is likely to be the
// identifier of the foreign class
$def['foreign'] = $foreignIdColumnName;
$def['localKey'] = true;
}
} else {
$def['foreign'] = $def['table']->getColumnName($def['foreign']);
if ($localIdentifierCount == 1) {
if ($def['local'] == $localIdColumnName && isset($def['owningSide']) && $def['owningSide'] === true) {
$def['localKey'] = true;
} else {
if ($def['local'] !== $localIdColumnName && $def['type'] == Doctrine_Relation::ONE) {
$def['localKey'] = true;
}
}
} else {
if ($localIdentifierCount > 1 && !isset($def['localKey'])) {
// It's a composite key and since 'foreign' can not point to a composite
// key currently, we know that 'local' must be the foreign key.
$def['localKey'] = true;
}
}
}
} else {
if (isset($def['foreign'])) {
$def['foreign'] = $def['table']->getColumnName($def['foreign']);
// local key not set, but foreign key is set
// try to guess the local key
if ($def['foreign'] === $foreignIdColumnName) {
$def['localKey'] = true;
try {
$def['local'] = $this->guessColumns($foreignClasses, $this->_table);
} catch (Doctrine_Relation_Exception $e) {
$def['local'] = $localIdColumnName;
}
} else {
$def['local'] = $localIdColumnName;
}
} else {
// neither local or foreign key is being set
// try to guess both keys
$conn = $this->_table->getConnection();
// the following loops are needed for covering inheritance
foreach ($localClasses as $class) {
$table = $conn->getTable($class);
$identifierColumnNames = $table->getIdentifierColumnNames();
$idColumnName = array_pop($identifierColumnNames);
$column = strtolower($table->getComponentName()) . '_' . $idColumnName;
foreach ($foreignClasses as $class2) {
$table2 = $conn->getTable($class2);
if ($table2->hasColumn($column)) {
$def['foreign'] = $column;
$def['local'] = $idColumnName;
return $def;
}
}
}
foreach ($foreignClasses as $class) {
$table = $conn->getTable($class);
$identifierColumnNames = $table->getIdentifierColumnNames();
$idColumnName = array_pop($identifierColumnNames);
$column = strtolower($table->getComponentName()) . '_' . $idColumnName;
foreach ($localClasses as $class2) {
$table2 = $conn->getTable($class2);
if ($table2->hasColumn($column)) {
$def['foreign'] = $idColumnName;
$def['local'] = $column;
$def['localKey'] = true;
return $def;
}
}
}
// auto-add columns and auto-build relation
$columns = array();
foreach ((array) $this->_table->getIdentifierColumnNames() as $id) {
// ?? should this not be $this->_table->getComponentName() ??
$column = strtolower($table->getComponentName()) . '_' . $id;
$col = $this->_table->getColumnDefinition($id);
$type = $col['type'];
$length = $col['length'];
unset($col['type']);
unset($col['length']);
unset($col['autoincrement']);
unset($col['sequence']);
unset($col['primary']);
$def['table']->setColumn($column, $type, $length, $col);
$columns[] = $column;
}
if (count($columns) > 1) {
$def['foreign'] = $columns;
} else {
$def['foreign'] = $columns[0];
}
$def['local'] = $localIdColumnName;
}
}
return $def;
}