Docs For Class atkSelector

Child Class	Description
atkCompatSelector	Backwards-compatiblity selector for nodes which have selectDb and/or countDb overrides. Makes sure we use the overrides. Due to this we can't support bind parameters neither can we support row-by-row fetching.
atkMLSelector	Special selector for multi-language nodes. Due to the way multi-language nodes work we need to fetch all rows at once, might need to set some extra conditions etc.

[ Top ]

Property Summary

array	$m_attrsByLoadType	Current attributes by load type (if iterator is used).
mixed	$m_conditions	Selector parameters.
mixed	$m_distinct
mixed	$m_excludes
mixed	$m_ignoreDefaultFilters
mixed	$m_ignoreForceLoad
mixed	$m_ignorePostvars
mixed	$m_ignorePrimaryKey
mixed	$m_includes
array	$m_indices	Indices cache.
atkSelectorIterator	$m_iterator	Current iterator instance (if iterator is used).
mixed	$m_limit
mixed	$m_mode
atkNode	$m_node	This selector's node.
mixed	$m_offset
mixed	$m_order
atkQuery	$m_query	Current query object (if iterator is used).
int	$m_rowCount	Row count cache.
array	$m_rows	Rows cache.
atkStatement	$m_stmt	Current statement object (if iterator is used).

[ Top ]

Method Summary

atkSelector	__construct()	Constructor.
void	allRows()	Deprecated alias for atkSelector::getAllRows().
void	close()	Closes the current statement used for this selector.
int	count()	Returns the row count (used when calling count on an atkSelector object, don't use this if you want to efficiently retrieve the row count using a count() select statement, use rowCount instead!
atkSelector	distinct()	Distinct selection?
atkSelector	excludes()	Exclude the following list of attributes.
void	firstRow()	Deprecated alias for atkSelector::getFirstRow().
array	getAllRows()	Return all rows.
array	getFirstRow()	Returns the first found row.
array	getIndices()	Returns the available indices for the index field based on the criteria.
void	getIterator()	Returns this selector's iterator.
int	getRowCount()	Return row count.
atkSelector	ignoreDefaultFilters()	Ignore default node filters.
atkSelector	ignoreForceLoad()	Ignore force load flags.
atkSelector	ignorePostvars()	Ignore criteria set in the postvars, like search criteria etc.
atkSelector	ignorePrimaryKey()	Don't forcefully load the primary key. The result records also won't contain the special "atkprimkey" entry.
atkSelector	includes()	Include only the following list of attributes.
atkSelector	limit()	Limit the results bij the given limit (and from the optional offset).
atkSelector	mode()	Set the select mode.
boolean	offsetExists()	Does the given offset exist?
mixed	offsetGet()	Returns the given offset.
void	offsetSet()	Sets the value for the given offset.
void	offsetUnset()	Unset the given element.
atkSelector	orderBy()	Order by the given order by string.
void	rowCount()	Deprecated alias for atkSelector::getRowCount().
array	transformRow()	Transform raw database row to node compatible row for the current iterator.
atkSelector	where()	Adds a condition..
void	_applyAttributesToQuery()	Apply attributes to query, e.g. add columns etc.
void	_applyConditionsToQuery()	Apply set conditions to query.
void	_applyFiltersToQuery()	Apply node filters to query.
void	_applyPostedFilterToQuery()	Apply posted filter to query.
void	_applyPostedIndexValueToQuery()	Apply posted index value to query.
void	_applyPostedSearchCriteriaToQuery()	Apply posted (normal) search criteria to query
void	_applyPostedSearchMethodToQuery()	Set search method for query.
void	_applyPostedSmartSearchCriteriaToQuery()	Apply posted smart search criteria to query.
void	_applyPostvarsToQuery()	Apply criteria that are part of the postvars (e.g. filter, index, search criteria)
atkQuery	_buildCountQuery()	Build count query object.
atkQuery	_buildQuery()	Build base query object.
atkQuery	_buildSelectQuery()	Build select query object.
array	_getAttributesByLoadType()	Returns the attributes for each load type (PRELOAD, ADDTOQUERY, POSTLOAD)
array	_getBindParameters()	Returns all bind parameters for all conditions.
atkDb	_getDb()	Returns the node's database.
atkNode	_getNode()	Returns the node for this selector.
boolean	_isAttributeLoadRequired()	Is attribute load required?
void	_isSearching()	Are we searching?
array	_transformRow()	Transform raw database row to node compatible row.
array	_transformRows()	Transform raw database rows to node compatible rows.

[ Top ]

Properties

array $m_attrsByLoadType = null [line 97]

Current attributes by load type (if iterator is used).

API Tags:

Access:

private

[ Top ]

mixed $m_conditions = array() [line 37]

Selector parameters.

API Tags:

Access:

protected

[ Top ]

mixed $m_distinct = false [line 38]

API Tags:

Access:

protected

[ Top ]

mixed $m_excludes = null [line 43]

API Tags:

Access:

protected

[ Top ]

mixed $m_ignoreDefaultFilters = false [line 45]

API Tags:

Access:

protected

[ Top ]

mixed $m_ignoreForceLoad = false [line 47]

API Tags:

Access:

protected

[ Top ]

mixed $m_ignorePostvars = false [line 46]

API Tags:

Access:

protected

[ Top ]

mixed $m_ignorePrimaryKey = false [line 48]

API Tags:

Access:

protected

[ Top ]

mixed $m_includes = null [line 44]

API Tags:

Access:

protected

[ Top ]

array $m_indices = null [line 69]

Indices cache.

API Tags:

Access:

protected

[ Top ]

atkSelectorIterator $m_iterator = null [line 76]

Current iterator instance (if iterator is used).

API Tags:

Access:

private

[ Top ]

mixed $m_limit = -1 [line 41]

API Tags:

Access:

protected

[ Top ]

mixed $m_mode = '' [line 39]

API Tags:

Access:

protected

[ Top ]

atkNode $m_node [line 32]

This selector's node.

API Tags:

Access:

protected

[ Top ]

mixed $m_offset = 0 [line 42]

API Tags:

Access:

protected

[ Top ]

mixed $m_order = '' [line 40]

API Tags:

Access:

protected

[ Top ]

atkQuery $m_query = null [line 90]

Current query object (if iterator is used).

API Tags:

Access:

private

[ Top ]

int $m_rowCount = null [line 62]

Row count cache.

API Tags:

Access:

protected

[ Top ]

array $m_rows = null [line 55]

Rows cache.

API Tags:

Access:

protected

[ Top ]

atkStatement $m_stmt = null [line 83]

Current statement object (if iterator is used).

API Tags:

Access:

private

[ Top ]

Methods

Constructor __construct [line 104]

atkSelector __construct(
atkNode
$node 
)

Constructor.

Parameters:

atkNode

$node:

this selector's node

API Tags:

Access:

public

[ Top ]

allRows [line 826]

void allRows(
)

Deprecated alias for atkSelector::getAllRows().

API Tags:

See:	atkSelector::getAllRows
Deprecated:
Access:	public

[ Top ]

close [line 919]

void close(
)

Closes the current statement used for this selector.

Also clears the row and row count cache.

API Tags:

Access:

public

[ Top ]

count [line 942]

int count(
)

Returns the row count (used when calling count on an atkSelector object, don't use this if you want to efficiently retrieve the row count using a count() select statement, use rowCount instead!

API Tags:

Return:	row count
Access:	public

Implementation of:

Countable::count

[ Top ]

distinct [line 202]

atkSelector distinct(
boolean
$distinct 
)

Distinct selection?

Parameters:

boolean

$distinct:

distinct selection?

API Tags:

Access:

public

[ Top ]

excludes [line 274]

atkSelector excludes(
array
$excludes 
)

Exclude the following list of attributes.

Parameters:

array

$excludes:

list of excludes

API Tags:

Access:

public

[ Top ]

firstRow [line 815]

void firstRow(
)

Deprecated alias for atkSelector::getFirstRow().

API Tags:

See:	atkSelector::getFirstRow
Deprecated:
Access:	public

[ Top ]

getAllRows [line 732]

array getAllRows(
)

Return all rows.

API Tags:

Return:	all rows
Access:	public

Redefined in descendants as:

atkCompatSelector::getAllRows() : Return all rows.

[ Top ]

getFirstRow [line 720]

array getFirstRow(
)

Returns the first found row.

API Tags:

Return:	first row
Access:	public

[ Top ]

getIndices [line 774]

array getIndices(
)

Returns the available indices for the index field based on the criteria.

API Tags:

Return:	available indices
Access:	public

[ Top ]

getIterator [line 895]

void getIterator(
)

Returns this selector's iterator.

NOTE: if you call this method multiple times, the same iterator will be returned, unless you have closed the selector first

API Tags:

Access:

public

Implementation of:

IteratorAggregate::getIterator

Redefined in descendants as:

atkCompatSelector::getIterator() : Returns an iterator for this selector.
atkMLSelector::getIterator() : Returns an iterator for this selector.

[ Top ]

getRowCount [line 753]

int getRowCount(
)

Return row count.

API Tags:

Return:	row count
Access:	public

Redefined in descendants as:

atkCompatSelector::getRowCount() : Return row count.

[ Top ]

ignoreDefaultFilters [line 153]

atkSelector ignoreDefaultFilters(
[boolean
$ignore = true] 
)

Ignore default node filters.

Parameters:

boolean

$ignore:

ignore default node filters?

API Tags:

Access:

public

[ Top ]

ignoreForceLoad [line 177]

atkSelector ignoreForceLoad(
[boolean
$ignore = true] 
)

Ignore force load flags.

Parameters:

boolean

$ignore:

ignore force load flags

API Tags:

Access:

public

[ Top ]

ignorePostvars [line 165]

atkSelector ignorePostvars(
[boolean
$ignore = true] 
)

Ignore criteria set in the postvars, like search criteria etc.

Parameters:

boolean

$ignore:

ignore postvars?

API Tags:

Access:

public

[ Top ]

ignorePrimaryKey [line 190]

atkSelector ignorePrimaryKey(
[boolean
$ignore = true] 
)

Don't forcefully load the primary key. The result records also won't contain the special "atkprimkey" entry.

Parameters:

boolean

$ignore:

ignore primary key

API Tags:

Access:

public

[ Top ]

includes [line 252]

atkSelector includes(
array
$includes 
)

Include only the following list of attributes.

Parameters:

array

$includes:

list of includes

API Tags:

Access:

public

[ Top ]

limit [line 239]

atkSelector limit(
int
$limit, [int
$offset = 0] 
)

Limit the results bij the given limit (and from the optional offset).

Parameters:

int	$limit:	limit
int	$offset:	offset

API Tags:

Access:

public

[ Top ]

mode [line 214]

atkSelector mode(
string
$mode 
)

Set the select mode.

Parameters:

string

$mode:

select mode

API Tags:

Access:

public

[ Top ]

offsetExists [line 848]

boolean offsetExists(
string|int
$key 
)

Does the given offset exist?

Parameters:

string|int

$key:

key

API Tags:

Return:	offset exists?
Access:	public

Implementation of:

ArrayAccess::offsetExists

[ Top ]

offsetGet [line 860]

mixed offsetGet(
string|int
$key 
)

Returns the given offset.

Parameters:

string|int

$key:

key

API Tags:

Access:

public

Implementation of:

ArrayAccess::offsetGet

[ Top ]

offsetSet [line 872]

void offsetSet(
string|int
$key, mixed
$value 
)

Sets the value for the given offset.

Parameters:

string\|int	$key:
mixed	$value:

API Tags:

Access:

public

Implementation of:

ArrayAccess::offsetSet

[ Top ]

offsetUnset [line 883]

void offsetUnset(
string|int
$key 
)

Unset the given element.

Parameters:

string|int

$key:

API Tags:

Access:

public

Implementation of:

ArrayAccess::offsetUnset

[ Top ]

orderBy [line 226]

atkSelector orderBy(
string
$order 
)

Order by the given order by string.

Parameters:

string

$order:

order by string

API Tags:

Access:

public

[ Top ]

rowCount [line 837]

void rowCount(
)

Deprecated alias for atkSelector::getRowCount().

API Tags:

See:	atkSelector::getRowCount
Deprecated:
Access:	public

[ Top ]

transformRow [line 705]

array transformRow(
array
$row 
)

Transform raw database row to node compatible row for the current iterator.

Parameters:

array

$row:

raw database row

API Tags:

Return:	node compatible row
Access:	public

[ Top ]

where [line 137]

atkSelector where(
string
$condition, [array
$params = array()] 
)

Adds a condition..

Parameters:

string	$condition:	where clause
array	$params:	bind parameters

API Tags:

Access:

public

[ Top ]

_applyAttributesToQuery [line 558]

void _applyAttributesToQuery(
atkQuery
$query, 
$attrsByLoadType 
)

Apply attributes to query, e.g. add columns etc.

Parameters:

atkQuery	$query:	query object
array	$attrsByLoadType:	attributes by load type

API Tags:

Access:

protected

[ Top ]

_applyConditionsToQuery [line 313]

void _applyConditionsToQuery(
atkQuery
$query 
)

Apply set conditions to query.

Parameters:

atkQuery

$query:

query object

API Tags:

Access:

protected

[ Top ]

_applyFiltersToQuery [line 473]

void _applyFiltersToQuery(
atkQuery
$query 
)

Apply node filters to query.

Parameters:

atkQuery

$query:

query

API Tags:

Access:

protected

[ Top ]

_applyPostedFilterToQuery [line 326]

void _applyPostedFilterToQuery(
atkQuery
$query 
)

Apply posted filter to query.

Parameters:

atkQuery

$query:

query object

API Tags:

Access:

protected

[ Top ]

_applyPostedIndexValueToQuery [line 343]

void _applyPostedIndexValueToQuery(
atkQuery
$query 
)

Apply posted index value to query.

Parameters:

atkQuery

$query:

query object

API Tags:

Access:

protected

[ Top ]

_applyPostedSearchCriteriaToQuery [line 375]

void _applyPostedSearchCriteriaToQuery(
atkQuery
$query, 
$attrsByLoadType 
)

Apply posted (normal) search criteria to query

Parameters:

atkQuery	$query:	query object
array	$attrsByLoadType:	attributes by load type

API Tags:

Access:

protected

[ Top ]

_applyPostedSearchMethodToQuery [line 361]

void _applyPostedSearchMethodToQuery(
atkQuery
$query 
)

Set search method for query.

Parameters:

atkQuery

$query:

query object

API Tags:

Access:

protected

[ Top ]

_applyPostedSmartSearchCriteriaToQuery [line 426]

void _applyPostedSmartSearchCriteriaToQuery(
atkQuery
$query 
)

Apply posted smart search criteria to query.

Parameters:

atkQuery

$query:

query object

API Tags:

Access:

protected

[ Top ]

_applyPostvarsToQuery [line 456]

void _applyPostvarsToQuery(
atkQuery
$query, 
$attrsByLoadType 
)

Apply criteria that are part of the postvars (e.g. filter, index, search criteria)

Parameters:

atkQuery	$query:	query
array	$attrsByLoadType:	attributes by load type

API Tags:

Access:

protected

[ Top ]

_buildCountQuery [line 624]

atkQuery _buildCountQuery(

$attrsByLoadType 
)

Build count query object.

Parameters:

array

$attrsByLoadType:

attributes by load type

API Tags:

Return:	query object
Access:	protected

[ Top ]

_buildQuery [line 579]

atkQuery _buildQuery(

$attrsByLoadType 
)

Build base query object.

Parameters:

array

$attrsByLoadType:

attributes by load type

API Tags:

Return:	query object
Access:	protected

Redefined in descendants as:

atkMLSelector::_buildQuery() : Override build query so we can add the multi language conditions.

[ Top ]

_buildSelectQuery [line 600]

atkQuery _buildSelectQuery(

$attrsByLoadType 
)

Build select query object.

Parameters:

array

$attrsByLoadType:

attributes by load type

API Tags:

Return:	query object
Access:	protected

[ Top ]

_getAttributesByLoadType [line 519]

array _getAttributesByLoadType(
)

Returns the attributes for each load type (PRELOAD, ADDTOQUERY, POSTLOAD)

API Tags:

Return:	attributes by load type
Access:	protected

[ Top ]

_getBindParameters [line 634]

array _getBindParameters(
)

Returns all bind parameters for all conditions.

API Tags:

Return:	bind parameters
Access:	protected

[ Top ]

_getDb [line 124]

atkDb _getDb(
)

Returns the node's database.

API Tags:

Access:

protected

[ Top ]

_getNode [line 114]

atkNode _getNode(
)

Returns the node for this selector.

API Tags:

Access:

protected

[ Top ]

_isAttributeLoadRequired [line 503]

boolean _isAttributeLoadRequired(
atkAttribute
$attr 
)

Is attribute load required?

Parameters:

atkAttribute

$attr:

attribute

API Tags:

Return:	load required?
Access:	protected

[ Top ]

_isSearching [line 292]

void _isSearching(
)

Are we searching?

API Tags:

Access:

protected

[ Top ]

_transformRow [line 655]

array _transformRow(
array
$row, atkQuery
$query, 
$attrsByLoadType 
)

Transform raw database row to node compatible row.

Parameters:

array	$row:	raw database row
atkQuery	$query:	query object
array	$attrsByLoadType:	attributes by load type

API Tags:

Return:	node compatible row
Access:	protected

[ Top ]

_transformRows [line 688]

array _transformRows(
array
$rows, atkQuery
$query, 
$attrsByLoadType 
)

Transform raw database rows to node compatible rows.

Parameters:

array	$rows:	raw database rows
atkQuery	$query:	query object
array	$attrsByLoadType:	attributes by load type

API Tags:

Return:	node compatible rows
Access:	protected

Redefined in descendants as:

atkMLSelector::_transformRows() : Transform raw database rows to node compatible rows.

[ Top ]