Class \Prado\Data\ActiveRecord\TActiveRecordGateway

TActiveRecordGateway excutes the SQL command queries and returns the data record as arrays (for most finder methods).

Class hierarchy

\Prado\Data\ActiveRecord\TActiveRecordGateway

\Prado\TComponent

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

Methods summary
`public`	`__construct(TActiveRecordManager $manager) : mixed` Record gateway constructor.
`public`	`countRecords(TActiveRecord $record, TActiveRecordCriteria $criteria) : int` Returns the number of records that match the given criteria.
`public`	`delete(TActiveRecord $record) : int` Delete the record.
`public`	`deleteRecordsByCriteria(TActiveRecord $record, TActiveRecordCriteria $criteria) : int` Delete multiple records by criteria.
`public`	`deleteRecordsByPk(TActiveRecord $record, mixed $keys) : int` Delete multiple records using primary keys.
`public`	`findRecordByPK(TActiveRecord $record, array<string\|int, mixed> $keys) : array<string\|int, mixed>` Returns record data matching the given primary key(s). If the table uses composite key, specify the name value pairs as an array.
`public`	`findRecordBySql(TActiveRecord $record, TActiveRecordCriteria $criteria) : array<string\|int, mixed>` Return record data from sql query.
`public`	`findRecordsByCriteria(TActiveRecord $record, TActiveRecordCriteria $criteria[, bool $iterator = false ]) : mixed` Returns record data matching the given critera. If $iterator is true, it will return multiple rows as TDbDataReader otherwise it returns the <b>first</b> row data.
`public`	`findRecordsByIndex(TActiveRecord $record, mixed $criteria, mixed $fields, mixed $values) : mixed`
`public`	`findRecordsByPks(TActiveRecord $record, array<string\|int, mixed> $keys) : array<string\|int, mixed>` Returns records matching the list of given primary keys.
`public`	`findRecordsBySql(TActiveRecord $record, TActiveRecordCriteria $criteria) : TDbDataReader` Return record data from sql query.
`public`	`getCommand(TActiveRecord $record) : TDataGatewayCommand`
`public`	`getDataGatewayClass() : string`
`public`	`getRecordTableInfo(TActiveRecord $record) : TDbTableInfo` Returns table information, trys the application cache first.
`public`	`getTableInfo(TDbConnection $connection, string $tableName) : TDbTableInfo` Returns table information for table in the database connection.
`public`	`insert(TActiveRecord $record) : int` Insert a new record.
`public`	`onCreateCommand(TDataGatewayCommand $sender, TDataGatewayEventParameter $param) : 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. This method also raises the OnCreateCommand event on the ActiveRecord object calling this gateway.
`public`	`onExecuteCommand(TDataGatewayCommand $sender, TDataGatewayResultEventParameter $param) : 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. This method also raises the OnCreateCommand event on the ActiveRecord object calling this gateway.
`public`	`setDataGatewayClass(string $value) : mixed` Set implementation class of DataGatewayCommand
`public`	`update(TActiveRecord $record) : int` Update the record.
`protected`	`getInsertValues(TActiveRecord $record) : array<string\|int, mixed>`
`protected`	`getManager() : TActiveRecordManager`
`protected`	`getPrimaryKeyValues(TActiveRecord $record) : mixed`
`protected`	`getRecordTableName(TActiveRecord $record) : string` Gets the table name from the 'TABLE' constant of the active record class if defined, otherwise use the class name as table name.
`protected`	`getUpdateValues(TActiveRecord $record) : mixed`
`protected`	`updateAssociatedRecords(TActiveRecord $record[, mixed $updateBelongsTo = false ]) : mixed`
`protected`	`updatePostInsert(TActiveRecord $record) : mixed` Sets the last insert ID to the corresponding property of the record if available.

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

Constants summary
`public mixed`	`DEFAULT_DATA_GATEWAY_CLASS`	`\Prado\Data\DataGateway\TDataGatewayCommand::class`
`public mixed`	`TABLE_CONST` Constant name for specifying optional table name in TActiveRecord.	`'TABLE'`
`public mixed`	`TABLE_METHOD` Method name for returning optional table name in in TActiveRecord	`'table'`

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\ActiveRecord\TActiveRecordGateway

Class hierarchy