Class Selection

Filtered table representation. Selection is based on the great library NotORM http://www.notorm.com written by Jakub Vrana.

Nette\Database\Table\Selection implements Iterator, Nette\Database\Table\IRowContainer, ArrayAccess, Countable uses Nette\SmartObject

Direct known subclasses

Nette\Database\Table\GroupedSelection

Namespace: Nette\Database\Table
Located at Database/Table/Selection.php

Methods summary
`public`	# `__construct( Nette\Database\Context $context, Nette\Database\IConventions $conventions, string $tableName, Nette\Caching\IStorage $cacheStorage = null )` Creates filtered table representation. Creates filtered table representation. Parameters `$context` `$conventions` `$tableName` name `$cacheStorage`
`public`	# `__destruct( )`
`public`	# `__clone( )`
`public string`	# `getName( )` Returns `string` string
`public string\|array\|null`	# `getPrimary( boolean $throw = true )` Parameters `$throw` Returns `string\|array\|null` string\|array\|null
`public string\|null`	# `getPrimarySequence( )` Returns `string\|null` string\|null
`public Nette\Database\Table\Selection`	# `setPrimarySequence( string $sequence )` Parameters `$sequence` Returns `Nette\Database\Table\Selection` static
`public string`	# `getSql( )` Returns `string` string
`public array\|false`	# `getPreviousAccessedColumns( )` Loads cache of previous accessed columns and returns it. Loads cache of previous accessed columns and returns it. Returns `array\|false` array\|false Internal
`public Nette\Database\Table\SqlBuilder`	# `getSqlBuilder( )` Returns `Nette\Database\Table\SqlBuilder` SqlBuilder Internal
`public Nette\Database\Table\ActiveRow\|false`	# `get( mixed $key )` Returns row specified by primary key. Returns row specified by primary key. Parameters `$key` key Returns `Nette\Database\Table\ActiveRow\|false` if there is no such row
`public Nette\Database\Table\ActiveRow\|false`	# `fetch( )` Returns `Nette\Database\Table\ActiveRow\|false` if there is no such row InheritDoc Implementation of `Nette\Database\IRowContainer::fetch()`
`public mixed\|false`	# `fetchField( string\|null $column = null )` Fetches single field. Fetches single field. Parameters `$column` Returns `mixed\|false` mixed\|false
`public array`	# `fetchPairs( string\|integer $key = null, string\|integer $value = null )` Parameters `$key` name used for an array key or null for numeric index `$value` name used for an array value or null for the whole row Returns `array` array InheritDoc Implementation of `Nette\Database\IRowContainer::fetchPairs()`
`public Nette\Database\Table\IRow[]`	# `fetchAll( )` Returns `Nette\Database\Table\IRow[]` IRow[] InheritDoc Implementation of `Nette\Database\IRowContainer::fetchAll()`
`public array`	# `fetchAssoc( string $path )` Parameters `$path` descriptor Returns `array` array InheritDoc Implementation of `Nette\Database\IRowContainer::fetchAssoc()`
`public Nette\Database\Table\Selection`	# `select( string\|string[] $columns, ... $params )` Adds select clause, more calls appends to the end. Adds select clause, more calls appends to the end. Parameters `$columns` example "column, MD5(column) AS column_md5" `$params` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `wherePrimary( mixed $key )` Adds condition for primary key. Adds condition for primary key. Parameters `$key` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `where( string\|string[] $condition, ... $params )` Adds where condition, more calls appends with AND. Adds where condition, more calls appends with AND. Parameters `$condition` possibly containing ? `$params` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `joinWhere( string $tableChain, string $condition, ... $params )` Adds ON condition when joining specified table, more calls appends with AND. Adds ON condition when joining specified table, more calls appends with AND. Parameters `$tableChain` chain or table alias for which you need additional left join condition `$condition` possibly containing ? `$params` Returns `Nette\Database\Table\Selection` static
`protected`	# `condition( string\|string[] $condition, array $params, $tableChain = null )` Adds condition, more calls appends with AND. Adds condition, more calls appends with AND. Parameters `$condition` possibly containing ? `$params` `$tableChain`
`public Nette\Database\Table\Selection`	# `whereOr( array $parameters )` Adds where condition using the OR operator between parameters. More calls appends with AND. Adds where condition using the OR operator between parameters. More calls appends with AND. Parameters `$parameters` => 1, 'column2 > ?' => 2, 'full condition'] Returns `Nette\Database\Table\Selection` static Throws `Nette\InvalidArgumentException` \Nette\InvalidArgumentException
`public Nette\Database\Table\Selection`	# `order( string $columns, ... $params )` Adds order clause, more calls appends to the end. Adds order clause, more calls appends to the end. Parameters `$columns` example 'column1, column2 DESC' `$params` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `limit( integer $limit, integer $offset = null )` Sets limit clause, more calls rewrite old values. Sets limit clause, more calls rewrite old values. Parameters `$limit` `$offset` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `page( integer $page, integer $itemsPerPage, & $numOfPages = null )` Sets offset using page number, more calls rewrite old values. Sets offset using page number, more calls rewrite old values. Parameters `$page` `$itemsPerPage` `$numOfPages` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `group( string $columns, ... $params )` Sets group clause, more calls rewrite old value. Sets group clause, more calls rewrite old value. Parameters `$columns` `$params` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `having( string $having, ... $params )` Sets having clause, more calls rewrite old value. Sets having clause, more calls rewrite old value. Parameters `$having` `$params` Returns `Nette\Database\Table\Selection` static
`public Nette\Database\Table\Selection`	# `alias( string $tableChain, string $alias )` Aliases table. Example ':book:book_tag.tag', 'tg' Aliases table. Example ':book:book_tag.tag', 'tg' Parameters `$tableChain` `$alias` Returns `Nette\Database\Table\Selection` static
`public integer`	# `aggregation( string $function )` Executes aggregation function. Executes aggregation function. Parameters `$function` call in "FUNCTION(column)" format Returns `integer` int
`public integer`	# `count( string $column = null )` Counts number of rows. Counts number of rows. Parameters `$column` it is not provided returns count of result rows, otherwise runs new sql counting query Returns `integer` int Implementation of `Countable::count()`
`public integer`	# `min( string $column )` Returns minimum value from a column. Returns minimum value from a column. Parameters `$column` Returns `integer` int
`public integer`	# `max( string $column )` Returns maximum value from a column. Returns maximum value from a column. Parameters `$column` Returns `integer` int
`public integer`	# `sum( string $column )` Returns sum of values in a column. Returns sum of values in a column. Parameters `$column` Returns `integer` int
`protected`	# `execute( )`
`protected Nette\Database\Table\ActiveRow`	# `createRow( array $row )` Returns `Nette\Database\Table\ActiveRow` ActiveRow
`public Nette\Database\Table\Selection`	# `createSelectionInstance( $table = null )` Returns `Nette\Database\Table\Selection` self
`protected Nette\Database\Table\GroupedSelection`	# `createGroupedSelectionInstance( $table, $column )` Returns `Nette\Database\Table\GroupedSelection` GroupedSelection
`protected Nette\Database\ResultSet`	# `query( $query )` Returns `Nette\Database\ResultSet` Nette\Database\ResultSet
`protected`	# `emptyResultSet( $clearCache = true, $deleteRererencedCache = true )`
`protected`	# `saveCacheState( )`
`protected Nette\Database\Table\Selection`	# `getRefTable( & $refPath )` Returns Selection parent for caching. Returns Selection parent for caching. Returns `Nette\Database\Table\Selection` static
`protected`	# `loadRefCache( )` Loads refCache references Loads refCache references
`protected string`	# `getGeneralCacheKey( )` Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching Returns `string` string
`protected string`	# `getSpecificCacheKey( )` Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching Returns `string` string
`public boolean`	# `accessColumn( string\|null $key, boolean $selectColumn = true )` Parameters `$key` name or null to reload all columns `$selectColumn` Returns `boolean` if selection requeried for more columns. Internal
`public`	# `removeAccessColumn( string $key )` Parameters `$key` Internal
`public boolean`	# `getDataRefreshed( )` Returns if selection requeried for more columns. Returns if selection requeried for more columns. Returns `boolean` bool
`public Nette\Database\Table\ActiveRow\|integer\|boolean`	# `insert( array\|Traversable\|Nette\Database\Table\Selection $data )` Inserts row in a table. Inserts row in a table. Parameters `$data` $column => $value)\|\Traversable\|Selection for INSERT ... SELECT Returns `Nette\Database\Table\ActiveRow\|integer\|boolean` Returns IRow or number of affected rows for Selection or table without primary key
`public integer`	# `update( iterable $data )` Updates all rows in result set. Joins in UPDATE are supported only in MySQL Updates all rows in result set. Joins in UPDATE are supported only in MySQL Parameters `$data` $column => $value) Returns `integer` number of affected rows
`public integer`	# `delete( )` Deletes all rows in result set. Deletes all rows in result set. Returns `integer` number of affected rows
`public Nette\Database\Table\ActiveRow\|null\|false`	# `getReferencedTable( Nette\Database\Table\ActiveRow $row, string\|null $table, string\|null $column = null )` Returns referenced row. Returns referenced row. Parameters `$row` `$table` `$column` Returns `Nette\Database\Table\ActiveRow\|null\|false` null if the row does not exist, false if the relationship does not exist
`public Nette\Database\Table\GroupedSelection\|null`	# `getReferencingTable( string $table, string $column, integer $active = null )` Returns referencing rows. Returns referencing rows. Parameters `$table` `$column` `$active` key Returns `Nette\Database\Table\GroupedSelection\|null` GroupedSelection\|null
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public Nette\Database\Table\ActiveRow\|boolean`	# `current( )` Returns `Nette\Database\Table\ActiveRow\|boolean` ActiveRow\|bool Implementation of `Iterator::current()`
`public string\|integer`	# `key( )` Returns `string\|integer` row ID Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public`	# `offsetSet( string $key, Nette\Database\Table\IRow $value )` Mimic row. Mimic row. Parameters `$key` ID `$value` Implementation of `ArrayAccess::offsetSet()`
`public Nette\Database\Table\ActiveRow\|null`	# `offsetGet( string $key )` Returns specified row. Returns specified row. Parameters `$key` ID Returns `Nette\Database\Table\ActiveRow\|null` if there is no such row Implementation of `ArrayAccess::offsetGet()`
`public boolean`	# `offsetExists( string $key )` Tests if row exists. Tests if row exists. Parameters `$key` ID Returns `boolean` bool Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetUnset( string $key )` Removes row from result set. Removes row from result set. Parameters `$key` ID Implementation of `ArrayAccess::offsetUnset()`

Methods used from Nette\SmartObject
`__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod(), getReflection()`

Magic methods inherited from Nette\Database\Table\IRowContainer
`fetch()`

Properties summary
`protected Nette\Database\Context`	`$context`	#
`protected Nette\Database\IConventions`	`$conventions`	#
`protected Nette\Caching\Cache`	`$cache`	#
`protected Nette\Database\Table\SqlBuilder`	`$sqlBuilder`	#
`protected string`	`$name` table name table name	#
`protected string\|array\|null`	`$primary` primary key field name primary key field name	#
`protected string\|boolean`	`$primarySequence` primary column sequence name, false for autodetection primary column sequence name, false for autodetection	#`false`
`protected Nette\Database\Table\IRow[]`	`$rows` data read from database in [primary key => IRow] format data read from database in [primary key => IRow] format	#
`protected Nette\Database\Table\IRow[]`	`$data` modifiable data in [primary key => IRow] format modifiable data in [primary key => IRow] format	#
`protected boolean`	`$dataRefreshed`	#`false`
`protected mixed`	`$globalRefCache` cache array of Selection and GroupedSelection prototypes cache array of Selection and GroupedSelection prototypes	#
`protected mixed`	`$refCache`	#
`protected string`	`$generalCacheKey`	#
`protected string`	`$specificCacheKey`	#
`protected array`	`$aggregation` of [conditions => [key => IRow]]; used by GroupedSelection of [conditions => [key => IRow]]; used by GroupedSelection	#`[]`
`protected array`	`$accessedColumns` of touched columns of touched columns	#
`protected array`	`$previousAccessedColumns` of earlier touched columns of earlier touched columns	#
`protected boolean`	`$observeCache` should instance observe accessed columns caching should instance observe accessed columns caching	#`false`
`protected array`	`$keys` of primary key values of primary key values	#`[]`

Namespaces

Classes

Interfaces

Class Selection

Direct known subclasses

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Internal

Returns

Internal

Parameters

Returns

Returns

InheritDoc

Implementation of

Parameters

Returns

Parameters

Returns

InheritDoc

Implementation of

Returns

InheritDoc

Implementation of

Parameters

Returns

InheritDoc

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Internal