Selection
class Selection implements IteratorAggregate, ArrayAccess, Countable
Represents filtered table result.
Selection is based on the great library NotORM http://www.notorm.com written by Jakub Vrana.
Properties
| protected | $explorer | ||
| protected | $cache | ||
| protected | $sqlBuilder | ||
| protected | $name | table name |
|
| protected string|string[]|null | $primary | ||
| protected | $primarySequence | primary column sequence name, false for autodetection |
|
| protected T[]|null | $rows | ||
| protected T[]|null | $data | ||
| protected | $dataRefreshed | ||
| protected | $globalRefCache | cache array of Selection and GroupedSelection prototypes |
|
| protected | $refCache | ||
| protected | $generalCacheKey | ||
| protected | $specificCacheKey | ||
| protected | $aggregation | of [conditions => [key => ActiveRow]]; used by GroupedSelection |
|
| protected | $accessedColumns | ||
| protected | $previousAccessedColumns | ||
| protected | $observeCache | should instance observe accessed columns caching |
Methods
No description
No description
No description
Returns table primary key.
No description
No description
No description
Loads cache of previous accessed columns and returns it.
No description
Returns row specified by primary key.
Returns the next row or null if there are no more rows.
Returns all rows as associative array, where first argument specifies key column and second value column.
Returns all rows.
No description
Adds condition, more calls appends with AND.
Executes aggregation function.
Counts number of rows. If column is not provided returns count of result rows, otherwise runs new sql counting query.
Returns minimum value from a column.
Returns maximum value from a column.
Returns sum of values in a column.
No description
No description
No description
Returns Selection parent for caching.
Loads refCache references
Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching
Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching
No description
No description
Returns if selection requeried for more columns.
Inserts row in a table. Returns ActiveRow or number of affected rows for Selection or table without primary key.
Updates all rows in result set.
Deletes all rows in result set.
Returns referenced row.
Returns referencing rows.
No description
Returns specified row.
Tests if row exists.
Removes row from result set.
Details
at line 65
__construct(Explorer $explorer, string $tableName)
Creates filtered table representation.
at line 78
__destruct()
No description
at line 84
__clone()
No description
at line 90
string
getName()
No description
at line 100
string|array|null
getPrimary(bool $throw = true)
Returns table primary key.
at line 110
string|null
getPrimarySequence()
No description
at line 121
Selection
setPrimarySequence(string $sequence)
No description
at line 128
string
getSql()
No description
at line 138
array|bool
getPreviousAccessedColumns()
| internal |
Loads cache of previous accessed columns and returns it.
at line 152
SqlBuilder
getSqlBuilder()
| internal |
No description
at line 165
ActiveRow|null
get(mixed $key)
Returns row specified by primary key.
at line 176
ActiveRow|null
fetch()
Returns the next row or null if there are no more rows.
at line 189
mixed
fetchField(string|null $column = null)
deprecated
deprecated
Fetches single field.
at line 210
array
fetchPairs(string|int|Closure|null $keyOrCallback = null, string|int|null $value = null)
Returns all rows as associative array, where first argument specifies key column and second value column.
For duplicate keys, the last value is used. When using null as key, array is indexed from zero. Alternatively accepts callback returning value or key-value pairs.
at line 220
array
fetchAll()
Returns all rows.
at line 230
array
fetchAssoc(string $path)
deprecated
deprecated
Returns all rows as associative tree.
at line 245
Selection
select(string $columns, ...$params)
No description
at line 257
Selection
wherePrimary(mixed $key)
No description
at line 282
Selection
where(string|array $condition, ...$params)
No description
at line 295
Selection
joinWhere(string $tableChain, string $condition, ...$params)
No description
at line 306
protected void
condition(string|array $condition, array $params, string|null $tableChain = null)
Adds condition, more calls appends with AND.
at line 332
Selection
whereOr(array $parameters)
No description
at line 367
Selection
order(string $columns, ...$params)
No description
at line 379
Selection
limit(int|null $limit, int|null $offset = null)
No description
at line 391
Selection
page(int $page, int $itemsPerPage, $numOfPages = null)
No description
at line 409
Selection
group(string $columns, ...$params)
No description
at line 421
Selection
having(string $having, ...$params)
No description
at line 433
Selection
alias(string $tableChain, string $alias)
No description
at line 447
mixed
aggregation(string $function, string|null $groupFunction = null)
Executes aggregation function.
at line 468
int
count(string|null $column = null)
Counts number of rows. If column is not provided returns count of result rows, otherwise runs new sql counting query.
at line 482
mixed
min(string $column)
Returns minimum value from a column.
at line 491
mixed
max(string $column)
Returns maximum value from a column.
at line 500
mixed
sum(string $column)
Returns sum of values in a column.
at line 509
protected void
execute()
No description
at line 554
Selection
createSelectionInstance(string|null $table = null)
deprecated
deprecated
No description
at line 561
protected Result
query(string $query)
No description
at line 567
protected void
emptyResultSet(bool $clearCache = true, bool $deleteReferencedCache = true)
No description
at line 589
protected void
saveCacheState()
No description
at line 617
protected Selection
getRefTable($refPath)
Returns Selection parent for caching.
at line 626
protected void
loadRefCache()
Loads refCache references
at line 635
protected string
getGeneralCacheKey()
Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching
at line 658
protected string
getSpecificCacheKey()
Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching
at line 673
bool
accessColumn(string|null $key, bool $selectColumn = true)
| internal |
No description
at line 739
void
removeAccessColumn(string $key)
| internal |
No description
at line 750
bool
getDataRefreshed()
Returns if selection requeried for more columns.
at line 764
ActiveRow|array|int|bool
insert(iterable $data)
Inserts row in a table. Returns ActiveRow or number of affected rows for Selection or table without primary key.
at line 845
int
update(iterable $data)
Updates all rows in result set.
Joins in UPDATE are supported only in MySQL
at line 866
int
delete()
Deletes all rows in result set.
at line 879
ActiveRow|false|null
getReferencedTable(ActiveRow $row, string|null $table, string|null $column = null)
Returns referenced row.
at line 926
GroupedSelection|null
getReferencingTable(string $table, string|null $column = null, int|string|null $active = null)
Returns referencing rows.
at line 960
Generator
getIterator()
No description
at line 979
void
offsetSet(string $key, ActiveRow $value)
Mimic row.
at line 991
ActiveRow|null
offsetGet(string $key)
Returns specified row.
at line 1002
bool
offsetExists(string $key)
Tests if row exists.
at line 1013
void
offsetUnset(string $key)
Removes row from result set.