/**
* Returns a F0FDatabaseIterator based on a given relation
*
* @param array $relation Indexed array holding relation definition.
* tableClass => name of the related table class
* localKey => name of the local key
* remoteKey => name of the remote key
* pivotTable => name of the pivot table (optional)
* theirPivotKey => name of the remote key in the pivot table (mandatory if pivotTable is set)
* ourPivotKey => name of our key in the pivot table (mandatory if pivotTable is set)
*
* @return F0FDatabaseIterator
*
* @throws RuntimeException
* @throws InvalidArgumentException
*/
protected function getIteratorFromRelation($relation)
{
// Sanity checks
if (!isset($relation['tableClass']) || !isset($relation['remoteKey']) || !isset($relation['localKey']) || !$relation['tableClass'] || !$relation['remoteKey'] || !$relation['localKey']) {
throw new InvalidArgumentException('Missing array index for the ' . __METHOD__ . ' method. Please check method signature', 500);
}
if (array_key_exists('pivotTable', $relation)) {
if (!isset($relation['theirPivotKey']) || !isset($relation['ourPivotKey']) || !$relation['pivotTable'] || !$relation['theirPivotKey'] || !$relation['ourPivotKey']) {
throw new InvalidArgumentException('Missing array index for the ' . __METHOD__ . ' method. Please check method signature', 500);
}
}
// Get a table object from the table class name
$tableClass = $relation['tableClass'];
$tableClassParts = F0FInflector::explode($tableClass);
if (count($tableClassParts) < 3) {
throw new InvalidArgumentException('Invalid table class named. It should be something like FooTableBar');
}
$table = F0FTable::getInstance($tableClassParts[2], ucfirst($tableClassParts[0]) . ucfirst($tableClassParts[1]));
// Get the table name
$tableName = $table->getTableName();
// Get the remote and local key names
$remoteKey = $relation['remoteKey'];
$localKey = $relation['localKey'];
// Get the local key's value
$value = $this->table->{$localKey};
// If there's no value for the primary key, let's stop here
if (!$value) {
throw new RuntimeException('Missing value for the primary key of the table ' . $this->table->getTableName(), 500);
}
// This is required to prevent one relation from killing the db cursor used in a different relation...
$oldDb = $this->table->getDbo();
$oldDb->disconnect();
// YES, WE DO NEED TO DISCONNECT BEFORE WE CLONE THE DB OBJECT. ARGH!
$db = clone $oldDb;
// Begin the query
$query = $db->getQuery(true)->select('*')->from($db->qn($tableName));
// Do we have a pivot table?
$hasPivot = array_key_exists('pivotTable', $relation);
// If we don't have pivot it's a straightforward query
if (!$hasPivot) {
$query->where($db->qn($remoteKey) . ' = ' . $db->q($value));
} else {
$subQuery = $db->getQuery(true)->select($db->qn($relation['theirPivotKey']))->from($db->qn($relation['pivotTable']))->where($db->qn($relation['ourPivotKey']) . ' = ' . $db->q($value));
$query->where($db->qn($remoteKey) . ' IN (' . $subQuery . ')');
}
$db->setQuery($query);
$cursor = $db->execute();
$iterator = F0FDatabaseIterator::getIterator($db->name, $cursor, null, $tableClass);
return $iterator;
}
