PHP Класс Prado\Data\ActiveRecord\TActiveRecordGateway

С версии: 3.1
Наследование: extends Prado\TComponent
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( TActiveRecordManager $manager ) Record gateway constructor.
countRecords ( TActiveRecord $record, $criteria ) : integer Returns the number of records that match the given criteria.
delete ( TActiveRecord $record ) : integer Delete the record.
deleteRecordsByCriteria ( TActiveRecord $record, $criteria ) : integer Delete multiple records by criteria.
deleteRecordsByPk ( TActiveRecord $record, $keys ) : integer Delete multiple records using primary keys.
findRecordByPK ( TActiveRecord $record, $keys ) : array Returns record data matching the given primary key(s). If the table uses composite key, specify the name value pairs as an array.
findRecordBySql ( TActiveRecord $record, $criteria ) : array Return record data from sql query.
findRecordsByCriteria ( TActiveRecord $record, $criteria, $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 first row data.
findRecordsByIndex ( TActiveRecord $record, $criteria, $fields, $values )
findRecordsByPks ( TActiveRecord $record, $keys ) : array Returns records matching the list of given primary keys.
findRecordsBySql ( TActiveRecord $record, $criteria ) : TDbDataReader Return record data from sql query.
getCommand ( TActiveRecord $record ) : TDataGatewayCommand
getRecordTableInfo ( TActiveRecord $record ) : TDbTableInfo Returns table information, trys the application cache first.
getTableInfo ( TDbConnection $connection, $tableName ) : TDbTableInfo Returns table information for table in the database connection.
insert ( TActiveRecord $record ) : integer Insert a new record.
onCreateCommand ( $sender, $param ) Raised when a command is prepared and parameter binding is completed.
onExecuteCommand ( $sender, $param ) Raised when a command is executed and the result from the database was returned.
update ( TActiveRecord $record ) : integer Update the record.

Защищенные методы

Метод Описание
getInsertValues ( TActiveRecord $record ) : array
getManager ( ) : TActiveRecordManager
getPrimaryKeyValues ( TActiveRecord $record )
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.
getUpdateValues ( TActiveRecord $record )
raiseCommandEvent ( $event, $command, $record, $criteria ) Raise the corresponding command event, insert, update, delete or select.
updateAssociatedRecords ( TActiveRecord $record, $updateBelongsTo = false )
updatePostInsert ( $record ) Sets the last insert ID to the corresponding property of the record if available.

Описание методов

__construct() публичный Метод

Record gateway constructor.
public __construct ( TActiveRecordManager $manager )
$manager TActiveRecordManager

countRecords() публичный Метод

Returns the number of records that match the given criteria.
public countRecords ( TActiveRecord $record, $criteria ) : integer
$record TActiveRecord
Результат integer number of records.

delete() публичный Метод

Delete the record.
public delete ( TActiveRecord $record ) : integer
$record TActiveRecord
Результат integer number of rows affected.

deleteRecordsByCriteria() публичный Метод

Delete multiple records by criteria.
public deleteRecordsByCriteria ( TActiveRecord $record, $criteria ) : integer
$record TActiveRecord
Результат integer number of records.

deleteRecordsByPk() публичный Метод

Delete multiple records using primary keys.
public deleteRecordsByPk ( TActiveRecord $record, $keys ) : integer
$record TActiveRecord
Результат integer number of rows deleted.

findRecordByPK() публичный Метод

Returns record data matching the given primary key(s). If the table uses composite key, specify the name value pairs as an array.
public findRecordByPK ( TActiveRecord $record, $keys ) : array
$record TActiveRecord
Результат array record data

findRecordBySql() публичный Метод

Return record data from sql query.
public findRecordBySql ( TActiveRecord $record, $criteria ) : array
$record TActiveRecord
Результат array result.

findRecordsByCriteria() публичный Метод

Returns record data matching the given critera. If $iterator is true, it will return multiple rows as TDbDataReader otherwise it returns the first row data.
public findRecordsByCriteria ( TActiveRecord $record, $criteria, $iterator = false ) : mixed
$record TActiveRecord
Результат mixed matching data.

findRecordsByIndex() публичный Метод

public findRecordsByIndex ( TActiveRecord $record, $criteria, $fields, $values )
$record TActiveRecord

findRecordsByPks() публичный Метод

Returns records matching the list of given primary keys.
public findRecordsByPks ( TActiveRecord $record, $keys ) : array
$record TActiveRecord
Результат array matching data.

findRecordsBySql() публичный Метод

Return record data from sql query.
public findRecordsBySql ( TActiveRecord $record, $criteria ) : TDbDataReader
$record TActiveRecord
Результат TDbDataReader result iterator.

getCommand() публичный Метод

public getCommand ( TActiveRecord $record ) : TDataGatewayCommand
$record TActiveRecord
Результат Prado\Data\DataGateway\TDataGatewayCommand

getInsertValues() защищенный Метод

protected getInsertValues ( TActiveRecord $record ) : array
$record TActiveRecord
Результат array insert values.

getManager() защищенный Метод

protected getManager ( ) : TActiveRecordManager
Результат TActiveRecordManager record manager.

getPrimaryKeyValues() защищенный Метод

protected getPrimaryKeyValues ( TActiveRecord $record )
$record TActiveRecord

getRecordTableInfo() публичный Метод

Returns table information, trys the application cache first.
public getRecordTableInfo ( TActiveRecord $record ) : TDbTableInfo
$record TActiveRecord
Результат TDbTableInfo table information.

getRecordTableName() защищенный Метод

Gets the table name from the 'TABLE' constant of the active record class if defined, otherwise use the class name as table name.
protected getRecordTableName ( TActiveRecord $record ) : string
$record TActiveRecord
Результат string table name for the given record class.

getTableInfo() публичный Метод

Returns table information for table in the database connection.
public getTableInfo ( TDbConnection $connection, $tableName ) : TDbTableInfo
$connection Prado\Data\TDbConnection
Результат TDbTableInfo table details.

getUpdateValues() защищенный Метод

protected getUpdateValues ( TActiveRecord $record )
$record TActiveRecord

insert() публичный Метод

Insert a new record.
public insert ( TActiveRecord $record ) : integer
$record TActiveRecord
Результат integer number of rows affected.

onCreateCommand() публичный Метод

The parameter object is TDataGatewayEventParameter of which the {@link TDataGatewayEventParameter::getCommand Command} 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 onCreateCommand ( $sender, $param )

onExecuteCommand() публичный Метод

The parameter object is TDataGatewayResultEventParameter of which the {@link TDataGatewayEventParameter::getResult Result} property contains the data return from the database. The data returned can be changed by setting the {@link TDataGatewayEventParameter::setResult Result} property. This method also raises the OnCreateCommand event on the ActiveRecord object calling this gateway.
public onExecuteCommand ( $sender, $param )

raiseCommandEvent() защищенный Метод

Raise the corresponding command event, insert, update, delete or select.
protected raiseCommandEvent ( $event, $command, $record, $criteria )

update() публичный Метод

Update the record.
public update ( TActiveRecord $record ) : integer
$record TActiveRecord
Результат integer number of rows affected.

updateAssociatedRecords() защищенный Метод

protected updateAssociatedRecords ( TActiveRecord $record, $updateBelongsTo = false )
$record TActiveRecord

updatePostInsert() защищенный Метод

Sets the last insert ID to the corresponding property of the record if available.
protected updatePostInsert ( $record )