class Selection implements Iterator, IRowContainer, ArrayAccess, Countable

Filtered table representation.

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

Traits

Strict class for better experience.

Properties

protected Context $context
protected IConventions $conventions
protected Cache $cache
protected SqlBuilder $sqlBuilder
protected string $name
protected string|string[]|null $primary
protected string|bool $primarySequence
protected IRow[] $rows
protected IRow[] $data
protected bool $dataRefreshed
protected mixed $globalRefCache
protected mixed $refCache
protected string|null $generalCacheKey
protected string|null $specificCacheKey
protected array $aggregation
protected array|false|null $accessedColumns
protected array|false|null $previousAccessedColumns
protected Selection|null $observeCache
protected array $keys

Methods

__construct(Context $context, IConventions $conventions, string $tableName, IStorage $cacheStorage = null)

Creates filtered table representation.

__destruct()

No description

__clone()

No description

string
getName()

No description

string|string[]|null
getPrimary(bool $throw = true)

No description

string|null
getPrimarySequence()

No description

setPrimarySequence(string $sequence)

No description

string
getSql()

No description

array|bool
getPreviousAccessedColumns()

Loads cache of previous accessed columns and returns it.

getSqlBuilder()

No description

ActiveRow|null
get(mixed $key)

Returns row specified by primary key.

IRow|null
fetch()

Fetches single row object.

mixed
fetchField(string $column = null) deprecated

Fetches single field.

array
fetchPairs(string|int $key = null, string|int $value = null)

Fetches all rows as associative array.

array
fetchAll()

Fetches all rows.

array
fetchAssoc(string $path)

Fetches all rows and returns associative tree.

select($columns, ...$params)

Adds select clause, more calls appends to the end.

wherePrimary(mixed $key)

Adds condition for primary key.

where($condition, ...$params)

Adds where condition, more calls appends with AND.

joinWhere(string $tableChain, string $condition, ...$params)

Adds ON condition when joining specified table, more calls appends with AND.

void
condition($condition, array $params, $tableChain = null)

Adds condition, more calls appends with AND.

whereOr(array $parameters)

Adds where condition using the OR operator between parameters.

order(string $columns, ...$params)

Adds order clause, more calls appends to the end.

limit(int|null $limit, int $offset = null)

Sets limit clause, more calls rewrite old values.

page(int $page, int $itemsPerPage, $numOfPages = null)

Sets offset using page number, more calls rewrite old values.

group(string $columns, ...$params)

Sets group clause, more calls rewrite old value.

having(string $having, ...$params)

Sets having clause, more calls rewrite old value.

alias(string $tableChain, string $alias)

Aliases table. Example ':book:book_tag.tag', 'tg'

mixed
aggregation(string $function)

Executes aggregation function.

int
count(string $column = null)

Counts number of rows.

mixed
min(string $column)

Returns minimum value from a column.

mixed
max(string $column)

Returns maximum value from a column.

mixed
sum(string $column)

Returns sum of values in a column.

void
execute()

No description

createRow(array $row)

No description

createSelectionInstance(string $table = null)

No description

createGroupedSelectionInstance(string $table, string $column)

No description

query(string $query)

No description

void
emptyResultSet(bool $clearCache = true, bool $deleteRererencedCache = true)

No description

void
saveCacheState()

No description

getRefTable($refPath)

Returns Selection parent for caching.

void
loadRefCache()

Loads refCache references

string
getGeneralCacheKey()

Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching

string
getSpecificCacheKey()

Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching

bool
accessColumn(string|null $key, bool $selectColumn = true)

No description

void
removeAccessColumn(string $key)

No description

bool
getDataRefreshed()

Returns if selection requeried for more columns.

ActiveRow|int|bool
insert(iterable $data)

Inserts row in a table.

int
update(iterable $data)

Updates all rows in result set.

int
delete()

Deletes all rows in result set.

ActiveRow|null|false
getReferencedTable(ActiveRow $row, string|null $table, string $column = null)

Returns referenced row.

GroupedSelection|null
getReferencingTable(string $table, string $column = null, $active = null)

Returns referencing rows.

void
rewind()

No description

ActiveRow|false
current()

No description

string|int
key()

No description

void
next()

No description

bool
valid()

No description

void
offsetSet(string $key, IRow $value)

Mimic row.

ActiveRow|null
offsetGet(string $key)

Returns specified row.

bool
offsetExists(string $key)

Tests if row exists.

void
offsetUnset(string $key)

Removes row from result set.

Details

at line 86
__construct(Context $context, IConventions $conventions, string $tableName, IStorage $cacheStorage = null)

Creates filtered table representation.

Parameters

Context $context
IConventions $conventions
string $tableName
IStorage $cacheStorage

at line 99
__destruct()

at line 105
__clone()

at line 111
string getName()

Return Value

string

at line 120
string|string[]|null getPrimary(bool $throw = true)

Parameters

bool $throw

Return Value

string|string[]|null

at line 129
string|null getPrimarySequence()

Return Value

string|null

at line 142
Selection setPrimarySequence(string $sequence)

Parameters

string $sequence

Return Value

Selection

at line 149
string getSql()

Return Value

string

at line 160
array|bool getPreviousAccessedColumns()

Loads cache of previous accessed columns and returns it.

Return Value

array|bool

at line 176
SqlBuilder getSqlBuilder()

Return Value

SqlBuilder

at line 189
ActiveRow|null get(mixed $key)

Returns row specified by primary key.

Parameters

mixed $key primary key

Return Value

ActiveRow|null

at line 200
IRow|null fetch()

Fetches single row object.

Return Value

IRow|null

at line 214
mixed fetchField(string $column = null) deprecated

deprecated

Fetches single field.

Parameters

string $column

Return Value

mixed

at line 232
array fetchPairs(string|int $key = null, string|int $value = null)

Fetches all rows as associative array.

Parameters

string|int $key column name used for an array key or null for numeric index
string|int $value column name used for an array value or null for the whole row

Return Value

array

at line 241
array fetchAll()

Fetches all rows.

Return Value

array

at line 250
array fetchAssoc(string $path)

Fetches all rows and returns associative tree.

Parameters

string $path associative descriptor

Return Value

array

at line 265
Selection select($columns, ...$params)

Adds select clause, more calls appends to the end.

Parameters

$columns
...$params

Return Value

Selection

at line 278
Selection wherePrimary(mixed $key)

Adds condition for primary key.

Parameters

mixed $key

Return Value

Selection

at line 303
Selection where($condition, ...$params)

Adds where condition, more calls appends with AND.

Parameters

$condition
...$params

Return Value

Selection

at line 316
Selection joinWhere(string $tableChain, string $condition, ...$params)

Adds ON condition when joining specified table, more calls appends with AND.

Parameters

string $tableChain
string $condition
...$params

Return Value

Selection

at line 327
protected void condition($condition, array $params, $tableChain = null)

Adds condition, more calls appends with AND.

Parameters

$condition
array $params
$tableChain

Return Value

void

at line 353
Selection whereOr(array $parameters)

Adds where condition using the OR operator between parameters.

More calls appends with AND.

Parameters

array $parameters ['column1' => 1, 'column2 > ?' => 2, 'full condition']

Return Value

Selection

Exceptions

InvalidArgumentException

at line 385
Selection order(string $columns, ...$params)

Adds order clause, more calls appends to the end.

Parameters

string $columns
...$params

Return Value

Selection

at line 397
Selection limit(int|null $limit, int $offset = null)

Sets limit clause, more calls rewrite old values.

Parameters

int|null $limit
int $offset

Return Value

Selection

at line 409
Selection page(int $page, int $itemsPerPage, $numOfPages = null)

Sets offset using page number, more calls rewrite old values.

Parameters

int $page
int $itemsPerPage
$numOfPages

Return Value

Selection

at line 425
Selection group(string $columns, ...$params)

Sets group clause, more calls rewrite old value.

Parameters

string $columns
...$params

Return Value

Selection

at line 437
Selection having(string $having, ...$params)

Sets having clause, more calls rewrite old value.

Parameters

string $having
...$params

Return Value

Selection

at line 449
Selection alias(string $tableChain, string $alias)

Aliases table. Example ':book:book_tag.tag', 'tg'

Parameters

string $tableChain
string $alias

Return Value

Selection

at line 464
mixed aggregation(string $function)

Executes aggregation function.

Parameters

string $function select call in "FUNCTION(column)" format

Return Value

mixed

at line 479
int count(string $column = null)

Counts number of rows.

Parameters

string $column if it is not provided returns count of result rows, otherwise runs new sql counting query

Return Value

int

at line 493
mixed min(string $column)

Returns minimum value from a column.

Parameters

string $column

Return Value

mixed

at line 503
mixed max(string $column)

Returns maximum value from a column.

Parameters

string $column

Return Value

mixed

at line 513
mixed sum(string $column)

Returns sum of values in a column.

Parameters

string $column

Return Value

mixed

at line 522
protected void execute()

Return Value

void

at line 565
protected ActiveRow createRow(array $row)

Parameters

array $row

Return Value

ActiveRow

at line 571
Selection createSelectionInstance(string $table = null)

Parameters

string $table

Return Value

Selection

at line 577
protected GroupedSelection createGroupedSelectionInstance(string $table, string $column)

Parameters

string $table
string $column

Return Value

GroupedSelection

at line 583
protected ResultSet query(string $query)

Parameters

string $query

Return Value

ResultSet

at line 589
protected void emptyResultSet(bool $clearCache = true, bool $deleteRererencedCache = true)

Parameters

bool $clearCache
bool $deleteRererencedCache

Return Value

void

at line 611
protected void saveCacheState()

Return Value

void

at line 633
protected Selection getRefTable($refPath)

Returns Selection parent for caching.

Parameters

$refPath

Return Value

Selection

at line 642
protected void loadRefCache()

Loads refCache references

Return Value

void

at line 651
protected string getGeneralCacheKey()

Returns general cache key independent on query parameters or sql limit Used e.g. for previously accessed columns caching

Return Value

string

at line 672
protected string getSpecificCacheKey()

Returns object specific cache key dependent on query parameters Used e.g. for reference memory caching

Return Value

string

at line 687
bool accessColumn(string|null $key, bool $selectColumn = true)

Parameters

string|null $key
bool $selectColumn

Return Value

bool if selection requeried for more columns.

at line 742
void removeAccessColumn(string $key)

Parameters

string $key

Return Value

void

at line 753
bool getDataRefreshed()

Returns if selection requeried for more columns.

Return Value

bool

at line 767
ActiveRow|int|bool insert(iterable $data)

Inserts row in a table.

Parameters

iterable $data [$column => $value]|\Traversable|Selection for INSERT ... SELECT

Return Value

ActiveRow|int|bool Returns IRow or number of affected rows for Selection or table without primary key

at line 847
int update(iterable $data)

Updates all rows in result set.

Joins in UPDATE are supported only in MySQL

Parameters

iterable $data

Return Value

int number of affected rows

at line 871
int delete()

Deletes all rows in result set.

Return Value

int number of affected rows

at line 884
ActiveRow|null|false getReferencedTable(ActiveRow $row, string|null $table, string $column = null)

Returns referenced row.

Parameters

ActiveRow $row
string|null $table
string $column

Return Value

ActiveRow|null|false null if the row does not exist, false if the relationship does not exist

at line 930
GroupedSelection|null getReferencingTable(string $table, string $column = null, $active = null)

Returns referencing rows.

Parameters

string $table
string $column
$active

Return Value

GroupedSelection|null

at line 957
void rewind()

Return Value

void

at line 966
ActiveRow|false current()

Return Value

ActiveRow|false

at line 979
string|int key()

Return Value

string|int row ID

at line 985
void next()

Return Value

void

at line 993
bool valid()

Return Value

bool

at line 1007
void offsetSet(string $key, IRow $value)

Mimic row.

Parameters

string $key
IRow $value

Return Value

void

at line 1018
ActiveRow|null offsetGet(string $key)

Returns specified row.

Parameters

string $key

Return Value

ActiveRow|null

at line 1029
bool offsetExists(string $key)

Tests if row exists.

Parameters

string $key

Return Value

bool

at line 1040
void offsetUnset(string $key)

Removes row from result set.

Parameters

string $key

Return Value

void