Class \Prado\Data\DataGateway\TSqlCriteria

Search criteria for TDbDataGateway.

Criteria object for data gateway finder methods. Usage:

$criteria = new TSqlCriteria();
$criteria->Parameters[':name'] = 'admin';
$criteria->Parameters[':pass'] = 'prado';
$criteria->OrdersBy['level'] = 'desc';
$criteria->OrdersBy['name'] = 'asc';
$criteria->Limit = 10;
$criteria->Offset = 20;

Class hierarchy

\Prado\Data\DataGateway\TSqlCriteria

\Prado\TComponent

Author: Wei Zhuo <weizho[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`__construct([null\|string $condition = null ][, mixed $parameters = [] ]) : mixed` Creates a new criteria with given condition;
`public`	`__toString() : string`
`public`	`getCondition() : string`
`public`	`getIsNamedParameters() : bool`
`public`	`getLimit() : int`
`public`	`getOffset() : int`
`public`	`getOrdersBy() : TAttributeCollection`
`public`	`getParameters() : TAttributeCollection`
`public`	`getSelect() : mixed` Gets the field list to be placed after the SELECT in the SQL. Default to '*'
`public`	`setCondition(string $value) : mixed` Sets the search conditions to be placed after the WHERE clause in the SQL.
`public`	`setLimit(int $value) : mixed`
`public`	`setOffset(int $value) : mixed`
`public`	`setOrdersBy(mixed $value) : mixed`
`public`	`setParameters(array<string\|int, mixed>\|ArrayAccess $value) : mixed`
`public`	`setSelect(mixed $value) : mixed` Sets the field list to be placed after the SELECT in the SQL. Different behavior depends on type of assigned value string usage without modification null will be expanded to full list of quoted table column names (quoting depends on database) array Column names will be quoted if used as key or value of array array('col1', 'col2', 'col2') // SELECT `col1`, `col2`, `col3` FROM... Column aliasing array('mycol1' => 'col1', 'mycol2' => 'COUNT()') // SELECT `col1` AS mycol1, COUNT() AS mycol2 FROM... NULL and scalar values (strings will be quoted depending on database) array('col1' => 'my custom string', 'col2' => 1.0, 'col3' => 'NULL') // SELECT "my custom string" AS `col1`, 1.0 AS `col2`, NULL AS `col3` FROM... If the -wildcard char is used as key or value, add the full list of quoted table column names array('col1' => 'NULL', '') // SELECT `col1`, `col2`, `col3`, NULL AS `col1` FROM...

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\DataGateway\TSqlCriteria

Class hierarchy