%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* This file is part of the Nette Framework (http://nette.org)
*
* Copyright (c) 2004 David Grudl (http://davidgrudl.com)
*
* For the full copyright and license information, please view
* the file license.txt that was distributed with this source code.
*/
namespace Nette\Database\Table;
use Nette,
Nette\Database\ISupplementalDriver,
PDO;
/**
* Filtered table representation.
* Selection is based on the great library NotORM http://www.notorm.com written by Jakub Vrana.
*
* @author Jakub Vrana
* @author Jan Skrasek
*
* @property-read string $sql
*/
class Selection extends Nette\Object implements \Iterator, \ArrayAccess, \Countable
{
/** @var Nette\Database\Connection */
protected $connection;
/** @var Nette\Caching\Cache */
protected $cache;
/** @var SqlBuilder */
protected $sqlBuilder;
/** @var string table name */
protected $name;
/** @var string primary key field name */
protected $primary;
/** @var string|bool primary column sequence name, FALSE for autodetection */
protected $primarySequence = FALSE;
/** @var ActiveRow[] data read from database in [primary key => ActiveRow] format */
protected $rows;
/** @var ActiveRow[] modifiable data in [primary key => ActiveRow] format */
protected $data;
/** @var bool */
protected $dataRefreshed = FALSE;
/** @var Selection[] */
protected $referenced = array();
/** @var array of [sqlQuery-hash => grouped data]; used by GroupedSelection */
protected $referencing = array();
/** @var GroupedSelection[] cached array of GroupedSelection prototypes */
protected $referencingPrototype = array();
/** @var array of [conditions => [key => ActiveRow]]; used by GroupedSelection */
protected $aggregation = array();
/** @var array of touched columns */
protected $accessedColumns;
/** @var array of earlier touched columns */
protected $previousAccessedColumns;
/** @var bool should instance observe accessed columns caching */
protected $observeCache = FALSE;
/** @var bool recheck referencing keys */
protected $checkReferenced = FALSE;
/** @var array of primary key values */
protected $keys = array();
/**
* Creates filtered table representation.
* @param string database table name
* @param Nette\Database\Connection
*/
public function __construct($table, Nette\Database\Connection $connection)
{
$this->name = $table;
$this->connection = $connection;
$reflection = $connection->getDatabaseReflection();
$this->primary = $reflection->getPrimary($table);
$this->sqlBuilder = new SqlBuilder($table, $connection, $reflection);
$this->cache = $connection->getCache();
}
public function __destruct()
{
$this->saveCacheState();
}
public function __clone()
{
$this->sqlBuilder = clone $this->sqlBuilder;
}
/**
* @return Nette\Database\Connection
*/
public function getConnection()
{
return $this->connection;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @return string|array
*/
public function getPrimary()
{
return $this->primary;
}
/**
* @return string
*/
public function getPrimarySequence()
{
if ($this->primarySequence === FALSE) {
$this->primarySequence = NULL;
$driver = $this->connection->getSupplementalDriver();
if ($driver->isSupported(ISupplementalDriver::SUPPORT_SEQUENCE)) {
foreach ($driver->getColumns($this->name) as $column) {
if ($column['name'] === $this->primary) {
$this->primarySequence = $column['vendor']['sequence'];
break;
}
}
}
}
return $this->primarySequence;
}
/**
* @param string
* @return Selection provides a fluent interface
*/
public function setPrimarySequence($sequence)
{
$this->primarySequence = $sequence;
return $this;
}
/**
* @return string
*/
public function getSql()
{
return $this->sqlBuilder->buildSelectQuery($this->getPreviousAccessedColumns());
}
/**
* Loads cache of previous accessed columns and returns it.
* @internal
* @return array|false
*/
public function getPreviousAccessedColumns()
{
if ($this->cache && $this->previousAccessedColumns === NULL) {
$this->accessedColumns = $this->previousAccessedColumns = $this->cache->load(array(__CLASS__, $this->name, $this->sqlBuilder->getConditions()));
}
return array_keys(array_filter((array) $this->previousAccessedColumns));
}
/**
* @internal
* @return SqlBuilder
*/
public function getSqlBuilder()
{
return $this->sqlBuilder;
}
/********************* quick access ****************d*g**/
/**
* Returns row specified by primary key.
* @param mixed primary key
* @return ActiveRow or FALSE if there is no such row
*/
public function get($key)
{
$clone = clone $this;
return $clone->wherePrimary($key)->fetch();
}
/**
* Returns next row of result.
* @return ActiveRow or FALSE if there is no row
*/
public function fetch()
{
$this->execute();
$return = current($this->data);
next($this->data);
return $return;
}
/**
* Returns all rows as associative array.
* @param string
* @param string column name used for an array value or NULL for the whole row
* @return array
*/
public function fetchPairs($key, $value = NULL)
{
$return = array();
foreach ($this as $row) {
$return[is_object($row[$key]) ? (string) $row[$key] : $row[$key]] = ($value ? $row[$value] : $row);
}
return $return;
}
/********************* sql selectors ****************d*g**/
/**
* Adds select clause, more calls appends to the end.
* @param string for example "column, MD5(column) AS column_md5"
* @return Selection provides a fluent interface
*/
public function select($columns)
{
$this->emptyResultSet();
$this->sqlBuilder->addSelect($columns);
return $this;
}
/**
* Method is deprecated, use wherePrimary() instead.
* @return Selection provides a fluent interface
*/
public function find($key)
{
return $this->wherePrimary($key);
}
/**
* Adds condition for primary key.
* @param mixed
* @return Selection provides a fluent interface
*/
public function wherePrimary($key)
{
if (is_array($this->primary) && Nette\Utils\Validators::isList($key)) {
foreach ($this->primary as $i => $primary) {
$this->where($primary, $key[$i]);
}
} elseif (is_array($key)) { // key contains column names
$this->where($key);
} else {
$this->where($this->primary, $key);
}
return $this;
}
/**
* Adds where condition, more calls appends with AND.
* @param string condition possibly containing ?
* @param mixed
* @param mixed ...
* @return Selection provides a fluent interface
*/
public function where($condition, $parameters = array())
{
if (is_array($condition)) { // where(array('column1' => 1, 'column2 > ?' => 2))
foreach ($condition as $key => $val) {
if (is_int($key)) {
$this->where($val); // where('full condition')
} else {
$this->where($key, $val); // where('column', 1)
}
}
return $this;
}
$args = func_get_args();
if (call_user_func_array(array($this->sqlBuilder, 'addWhere'), $args)) {
$this->emptyResultSet();
}
return $this;
}
/**
* Adds order clause, more calls appends to the end.
* @param string for example 'column1, column2 DESC'
* @return Selection provides a fluent interface
*/
public function order($columns)
{
$this->emptyResultSet();
$this->sqlBuilder->addOrder($columns);
return $this;
}
/**
* Sets limit clause, more calls rewrite old values.
* @param int
* @param int
* @return Selection provides a fluent interface
*/
public function limit($limit, $offset = NULL)
{
$this->emptyResultSet();
$this->sqlBuilder->setLimit($limit, $offset);
return $this;
}
/**
* Sets offset using page number, more calls rewrite old values.
* @param int
* @param int
* @return Selection provides a fluent interface
*/
public function page($page, $itemsPerPage)
{
return $this->limit($itemsPerPage, ($page - 1) * $itemsPerPage);
}
/**
* Sets group clause, more calls rewrite old values.
* @param string
* @param string
* @return Selection provides a fluent interface
*/
public function group($columns, $having = NULL)
{
$this->emptyResultSet();
$this->sqlBuilder->setGroup($columns, $having);
return $this;
}
/********************* aggregations ****************d*g**/
/**
* Executes aggregation function.
* @param string select call in "FUNCTION(column)" format
* @return string
*/
public function aggregation($function)
{
$selection = $this->createSelectionInstance();
$selection->getSqlBuilder()->importConditions($this->getSqlBuilder());
$selection->select($function);
foreach ($selection->fetch() as $val) {
return $val;
}
}
/**
* Counts number of rows.
* @param string if it is not provided returns count of result rows, otherwise runs new sql counting query
* @return int
*/
public function count($column = NULL)
{
if (!$column) {
$this->execute();
return count($this->data);
}
return $this->aggregation("COUNT($column)");
}
/**
* Returns minimum value from a column.
* @param string
* @return int
*/
public function min($column)
{
return $this->aggregation("MIN($column)");
}
/**
* Returns maximum value from a column.
* @param string
* @return int
*/
public function max($column)
{
return $this->aggregation("MAX($column)");
}
/**
* Returns sum of values in a column.
* @param string
* @return int
*/
public function sum($column)
{
return $this->aggregation("SUM($column)");
}
/********************* internal ****************d*g**/
protected function execute()
{
if ($this->rows !== NULL) {
return;
}
$this->observeCache = TRUE;
try {
$result = $this->query($this->getSql());
} catch (\PDOException $exception) {
if (!$this->sqlBuilder->getSelect() && $this->previousAccessedColumns) {
$this->previousAccessedColumns = FALSE;
$this->accessedColumns = array();
$result = $this->query($this->getSql());
} else {
throw $exception;
}
}
$this->rows = array();
$usedPrimary = TRUE;
$result->setFetchMode(PDO::FETCH_ASSOC);
foreach ($result as $key => $row) {
$row = $this->createRow($result->normalizeRow($row));
$primary = $row->getSignature(FALSE);
$usedPrimary = $usedPrimary && $primary;
$this->rows[$primary ?: $key] = $row;
}
$this->data = $this->rows;
if ($usedPrimary && $this->accessedColumns !== FALSE) {
foreach ((array) $this->primary as $primary) {
$this->accessedColumns[$primary] = TRUE;
}
}
}
protected function createRow(array $row)
{
return new ActiveRow($row, $this);
}
protected function createSelectionInstance($table = NULL)
{
return new Selection($table ?: $this->name, $this->connection);
}
protected function createGroupedSelectionInstance($table, $column)
{
return new GroupedSelection($this, $table, $column);
}
protected function query($query)
{
return $this->connection->queryArgs($query, $this->sqlBuilder->getParameters());
}
protected function emptyResultSet()
{
if ($this->rows === NULL) {
return;
}
$this->rows = NULL;
$this->saveCacheState();
}
protected function saveCacheState()
{
if ($this->observeCache && $this->cache && !$this->sqlBuilder->getSelect() && $this->accessedColumns != $this->previousAccessedColumns) {
$this->cache->save(array(__CLASS__, $this->name, $this->sqlBuilder->getConditions()), $this->accessedColumns);
}
}
/**
* Returns Selection parent for caching.
* @return Selection
*/
protected function getRefTable(& $refPath)
{
return $this;
}
/**
* @internal
* @param string|NULL column name or (NULL to reload all columns & disable columns cache)
* @param bool
*/
public function accessColumn($key, $selectColumn = TRUE)
{
if (!$this->cache) {
return;
}
if ($key === NULL) {
$this->accessedColumns = FALSE;
$currentKey = key($this->data);
} elseif ($this->accessedColumns !== FALSE) {
$this->accessedColumns[$key] = $selectColumn;
}
if ($selectColumn && !$this->sqlBuilder->getSelect() && $this->previousAccessedColumns && ($key === NULL || !isset($this->previousAccessedColumns[$key]))) {
$this->previousAccessedColumns = FALSE;
$this->emptyResultSet();
$this->dataRefreshed = TRUE;
if ($key === NULL) {
// we need to move iterator in resultset
$this->execute();
while (key($this->data) !== $currentKey) {
next($this->data);
}
}
}
}
/**
* @internal
* @param string
*/
public function removeAccessColumn($key)
{
if ($this->cache && is_array($this->accessedColumns)) {
$this->accessedColumns[$key] = FALSE;
}
}
/**
* Returns if selection requeried for more columns.
* @return bool
*/
public function getDataRefreshed()
{
return $this->dataRefreshed;
}
/********************* manipulation ****************d*g**/
/**
* Inserts row in a table.
* @param mixed array($column => $value)|Traversable for single row insert or Selection|string for INSERT ... SELECT
* @return ActiveRow or FALSE in case of an error or number of affected rows for INSERT ... SELECT
*/
public function insert($data)
{
if ($data instanceof Selection) {
$data = $data->getSql();
} elseif ($data instanceof \Traversable) {
$data = iterator_to_array($data);
}
$return = $this->connection->query($this->sqlBuilder->buildInsertQuery(), $data);
$this->checkReferenced = TRUE;
if (!is_array($data)) {
return $return->rowCount();
}
if (!is_array($this->primary) && !isset($data[$this->primary]) && ($id = $this->connection->lastInsertId($this->getPrimarySequence()))) {
$data[$this->primary] = $id;
}
$row = $this->createRow($data);
if ($signature = $row->getSignature(FALSE)) {
$this->rows[$signature] = $row;
}
return $row;
}
/**
* Updates all rows in result set.
* Joins in UPDATE are supported only in MySQL
* @param array|\Traversable ($column => $value)
* @return int number of affected rows or FALSE in case of an error
*/
public function update($data)
{
if ($data instanceof \Traversable) {
$data = iterator_to_array($data);
} elseif (!is_array($data)) {
throw new Nette\InvalidArgumentException;
}
if (!$data) {
return 0;
}
return $this->connection->queryArgs(
$this->sqlBuilder->buildUpdateQuery(),
array_merge(array($data), $this->sqlBuilder->getParameters())
)->rowCount();
}
/**
* Deletes all rows in result set.
* @return int number of affected rows or FALSE in case of an error
*/
public function delete()
{
return $this->query($this->sqlBuilder->buildDeleteQuery())->rowCount();
}
/********************* references ****************d*g**/
/**
* Returns referenced row.
* @param string
* @param string
* @param bool checks if rows contains the same primary value relations
* @return Selection or array() if the row does not exist
*/
public function getReferencedTable($table, $column, $checkReferenced = FALSE)
{
$referenced = & $this->getRefTable($refPath)->referenced[$refPath . "$table.$column"];
if ($referenced === NULL || $checkReferenced || $this->checkReferenced) {
$this->execute();
$this->checkReferenced = FALSE;
$keys = array();
foreach ($this->rows as $row) {
if ($row[$column] === NULL) {
continue;
}
$key = $row[$column] instanceof ActiveRow ? $row[$column]->getPrimary() : $row[$column];
$keys[$key] = TRUE;
}
if ($referenced !== NULL && array_keys($keys) === array_keys($referenced->rows)) {
return $referenced;
}
if ($keys) {
$referenced = $this->createSelectionInstance($table);
$referenced->where($referenced->primary, array_keys($keys));
} else {
$referenced = array();
}
}
return $referenced;
}
/**
* Returns referencing rows.
* @param string
* @param string
* @param int primary key
* @return GroupedSelection
*/
public function getReferencingTable($table, $column, $active = NULL)
{
$prototype = & $this->getRefTable($refPath)->referencingPrototype[$refPath . "$table.$column"];
if (!$prototype) {
$prototype = $this->createGroupedSelectionInstance($table, $column);
$prototype->where("$table.$column", array_keys((array) $this->rows));
}
$clone = clone $prototype;
$clone->setActive($active);
return $clone;
}
/********************* interface Iterator ****************d*g**/
public function rewind()
{
$this->execute();
$this->keys = array_keys($this->data);
reset($this->keys);
}
/** @return ActiveRow */
public function current()
{
if (($key = current($this->keys)) !== FALSE) {
return $this->data[$key];
} else {
return FALSE;
}
}
/**
* @return string row ID
*/
public function key()
{
return current($this->keys);
}
public function next()
{
next($this->keys);
}
public function valid()
{
return current($this->keys) !== FALSE;
}
/********************* interface ArrayAccess ****************d*g**/
/**
* Mimic row.
* @param string row ID
* @param ActiveRow
* @return NULL
*/
public function offsetSet($key, $value)
{
$this->execute();
$this->rows[$key] = $value;
}
/**
* Returns specified row.
* @param string row ID
* @return ActiveRow or NULL if there is no such row
*/
public function offsetGet($key)
{
$this->execute();
return $this->rows[$key];
}
/**
* Tests if row exists.
* @param string row ID
* @return bool
*/
public function offsetExists($key)
{
$this->execute();
return isset($this->rows[$key]);
}
/**
* Removes row from result set.
* @param string row ID
* @return NULL
*/
public function offsetUnset($key)
{
$this->execute();
unset($this->rows[$key], $this->data[$key]);
}
}
Zerion Mini Shell 1.0