Class \Prado\Data\DataGateway\TDataGatewayCommand

TDataGatewayCommand is command builder and executor class for TTableGateway and TActiveRecordGateway.

TDataGatewayCommand builds the TDbCommand for TTableGateway and TActiveRecordGateway commands such as find(), update(), insert(), etc, using the TDbCommandBuilder classes (database specific TDbCommandBuilder classes are used).

Once the command is built and the query parameters are binded, the OnCreateCommand event is raised. Event handlers for the OnCreateCommand event should not alter the Command property nor the Criteria property of the TDataGatewayEventParameter.

TDataGatewayCommand excutes the TDbCommands and returns the result obtained from the database (returned value depends on the method executed). The OnExecuteCommand event is raised after the command is executed and resulting data is set in the TDataGatewayResultEventParameter object's Result property.

Class hierarchy

\Prado\Data\DataGateway\TDataGatewayCommand

\Prado\TComponent

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

Methods summary
`public`	`__construct(TDbCommandBuilder $builder) : mixed` The common __construct.
`public`	`count(TSqlCriteria $criteria) : int`
`public`	`createCriteriaFromString(string $method, string $condition, array<string\|int, mixed> $args) : TActiveRecordCriteria`
`public`	`delete(TSqlCriteria $criteria) : int` Executes a delete command.
`public`	`deleteByPk(array<string\|int, mixed> $keys) : int`
`public`	`find(TSqlCriteria $criteria) : array<string\|int, mixed>` Find one record matching the critera.
`public`	`findAll(TSqlCriteria $criteria) : TDbDataReader` Find one or more matching records.
`public`	`findAllByIndex(mixed $criteria, mixed $fields, mixed $values) : mixed`
`public`	`findAllByPk(array<string\|int, mixed> $keys) : TDbDataReader`
`public`	`findAllBySql(TSqlCriteria $criteria) : TDbDataReader` Find zero or more matching records for arbituary SQL.
`public`	`findByPk(mixed $keys) : array<string\|int, mixed>`
`public`	`findBySql(TSqlCriteria $criteria) : TDbDataReader` Find one matching records for arbituary SQL.
`public`	`getBuilder() : TDbCommandBuilder`
`public`	`getDbConnection() : TDbConnection`
`public`	`getIndexKeyCondition(mixed $table, mixed $fields, mixed $values) : mixed`
`public`	`getLastInsertID() : mixed` Iterate through all the columns and returns the last insert id of the first column that has a sequence or serial.
`public`	`getTableInfo() : TDbTableInfo`
`public`	`insert(array<string\|int, mixed> $data) : mixed` Inserts a new record into the table. Each array key must correspond to a column name in the table unless a null value is permitted.
`public`	`onCreateCommand(TDataGatewayCommand $command, mixed $criteria) : mixed` Raised when a command is prepared and parameter binding is completed. The parameter object is TDataGatewayEventParameter of which the \Prado\Data\DataGateway\TDataGatewayEventParameter::getCommand property can be inspected to obtain the sql query to be executed.
`public`	`onExecuteCommand(TDataGatewayCommand $command, mixed $result) : mixed` Raised when a command is executed and the result from the database was returned. The parameter object is TDataGatewayResultEventParameter of which the \Prado\Data\DataGateway\TDataGatewayEventParameter::getResult property contains the data return from the database. The data returned can be changed by setting the \Prado\Data\DataGateway\TDataGatewayEventParameter::setResult property.
`public`	`update(array<string\|int, mixed> $data, TSqlCriteria $criteria) : int` Updates the table with new data.
`public`	`updateByPk(array<string\|int, mixed> $data, array<string\|int, mixed> $keys) : int`
`protected`	`extractMatchingConditions(string $method, string $condition) : array<string\|int, mixed>` Calculates the AND/OR condition from dynamic method substrings using table meta data, allows for any AND-OR combinations.
`protected`	`getCompositeKeyCondition(array<string\|int, mixed> $values) : string` Construct a "pk IN ('key1', 'key2', ...)" criteria.
`protected`	`getFindCommand(TSqlCriteria $criteria) : TDbCommand` Build the find command from the criteria. Limit, Offset and Ordering are applied if applicable.
`protected`	`getPrimaryKeyCondition(array<string\|int, mixed> $values) : array<string\|int, mixed>` Create the condition and parameters for find by primary.
`protected`	`getSqlCommand(TSqlCriteria $criteria) : TDbCommand` Build sql command from the criteria. Limit, Offset and Ordering are applied if applicable.
`protected`	`quoteTuple(array<string\|int, mixed> $array) : string`

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\TDataGatewayCommand

Class hierarchy