PHP Class Prado\Data\DataGateway\TTableGateway

Each method maps the input parameters into a SQL call and executes the SQL against a database connection. The TTableGateway is stateless (with respect to the data and data objects), as its role is to push data back and forth. Example usage: create a connection $dsn = 'pgsql:host=localhost;dbname=test'; $conn = new TDbConnection($dsn, 'dbuser','dbpass'); create a table gateway for table/view named 'address' $table = new TTableGateway('address', $conn); insert a new row, returns last insert id (if applicable) $id = $table->insert(array('name'=>'wei', 'phone'=>'111111')); $record1 = $table->findByPk($id); //find inserted record finds all records, returns an iterator $records = $table->findAll(); print_r($records->readAll()); update the row $table->updateByPk($record1, $id); All methods that may return more than one row of data will return an TDbDataReader iterator. The OnCreateCommand event is raised when a command is prepared and parameter binding is completed. The parameter object is a TDataGatewayEventParameter of which the {@link TDataGatewayEventParameter::getCommand Command} property can be inspected to obtain the sql query to be executed. The OnExecuteCommand event is raised when a command is executed and the result from the database was returned. The parameter object is a 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. $table->OnCreateCommand[] = 'log_it'; //any valid PHP callback statement $table->OnExecuteCommand[] = array($obj, 'method_name'); // calls 'method_name' on $obj function log_it($sender, $param) { var_dump($param); //TDataGatewayEventParameter object. }
Since: 3.1
Inheritance: extends Prado\TComponent
Mostrar archivo Open project: pradosoft/prado

Public Methods

Method Description
__call ( $method, $args ) : mixed Dynamic find method using parts of method name as search criteria.
__construct ( $table, $connection ) Creates a new generic table gateway for a given table or view name and a database connection.
count ( $criteria = null, $parameters = [] ) : integer Find the number of records.
deleteAll ( $criteria, $parameters = [] ) : integer Delete records from the table with condition given by $where and binding values specified by $parameter argument.
deleteAllByPks ( $keys ) Alias for deleteByPk()
deleteByPk ( $keys ) : integer Delete records by primary key. Usage:
find ( $criteria, $parameters = [] ) : array Find one single record that matches the criteria.
findAll ( $criteria = null, $parameters = [] ) : TDbDataReader Accepts same parameters as find(), but returns TDbDataReader instead.
findAllByPks ( $keys ) : TDbDataReader Similar to findByPk(), but returns TDbDataReader instead.
findAllBySql ( $sql, $parameters = [] ) : TDbDataReader Execute arbituary sql command with binding parameters.
findByPk ( $keys ) : array Find one record using only the primary key or composite primary keys. Usage:
findBySql ( $sql, $parameters = [] ) : array Execute arbituary sql command with binding parameters.
getDbConnection ( ) : TDbConnection
getLastInsertId ( ) : mixed
getTableInfo ( )
getTableName ( )
insert ( $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.
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 ( $data, $criteria, $parameters = [] ) : integer Updates the table with new name-value pair $data. Each array key must correspond to a column name in the table. The update condition is specified by the $where argument and additional binding values can be specified using the $parameter argument.

Protected Methods

Method Description
getCommand ( ) : TDataGatewayCommand
getCriteria ( $criteria, $parameters, $args ) : TSqlCriteria Create a new TSqlCriteria object from a string $criteria. The $args are additional parameters and are used in place of the $parameters if $parameters is not an array and $args is an arrary.
initCommandBuilder ( $builder )
setTableInfo ( $tableInfo )
setTableName ( $tableName ) Sets up the command builder for the given table.

Method Details

__call() public method

Method name starting with "findBy" only returns 1 record. Method name starting with "findAllBy" returns 0 or more records. Method name starting with "deleteBy" deletes records by the trail criteria. The condition is taken as part of the method name after "findBy", "findAllBy" or "deleteBy". The following are equivalent: $table->findByName($name) $table->find('Name = ?', $name); $table->findByUsernameAndPassword($name,$pass); // OR may be used $table->findBy_Username_And_Password($name,$pass); // _OR_ may be used $table->find('Username = ? AND Password = ?', $name, $pass); $table->findAllByAge($age); $table->findAll('Age = ?', $age); $table->deleteAll('Name = ?', $name); $table->deleteByName($name);
public __call ( $method, $args ) : mixed
return mixed single record if method name starts with "findBy", 0 or more records if method name starts with "findAllBy"

__construct() public method

Creates a new generic table gateway for a given table or view name and a database connection.
public __construct ( $table, $connection )

count() public method

Find the number of records.
public count ( $criteria = null, $parameters = [] ) : integer
return integer number of records.

deleteAll() public method

This method uses additional arguments as $parameters. E.g. $table->delete('age > ? AND location = ?', $age, $location);
public deleteAll ( $criteria, $parameters = [] ) : integer
return integer number of records deleted.

deleteAllByPks() public method

Alias for deleteByPk()
public deleteAllByPks ( $keys )

deleteByPk() public method

$table->deleteByPk($primaryKey); //delete 1 record $table->deleteByPk($key1,$key2,...); //delete multiple records $table->deleteByPk(array($key1,$key2,...)); //delete multiple records For composite primary keys (determined from the table definitions): $table->deleteByPk(array($key1,$key2)); //delete 1 record delete multiple records $table->deleteByPk(array($key1,$key2), array($key3,$key4),...); delete multiple records $table->deleteByPk(array( array($key1,$key2), array($key3,$key4), .. ));
public deleteByPk ( $keys ) : integer
return integer number of records deleted.

find() public method

Usage: $table->find('username = :name AND password = :pass', array(':name'=>$name, ':pass'=>$pass)); $table->find('username = ? AND password = ?', array($name, $pass)); $table->find('username = ? AND password = ?', $name, $pass); $criteria is of TSqlCriteria $table->find($criteria); //the 2nd parameter for find() is ignored.
public find ( $criteria, $parameters = [] ) : array
return array matching record object.

findAll() public method

Accepts same parameters as find(), but returns TDbDataReader instead.
public findAll ( $criteria = null, $parameters = [] ) : TDbDataReader
return TDbDataReader matching records.

findAllByPks() public method

For scalar primary keys: $table->findAllByPk($key1, $key2, ...); $table->findAllByPk(array($key1, $key2, ...)); For composite keys: $table->findAllByPk(array($key1, $key2), array($key3, $key4), ...); $table->findAllByPk(array(array($key1, $key2), array($key3, $key4), ...));
public findAllByPks ( $keys ) : TDbDataReader
return TDbDataReader data reader.

findAllBySql() public method

Execute arbituary sql command with binding parameters.
public findAllBySql ( $sql, $parameters = [] ) : TDbDataReader
return TDbDataReader query results.

findByPk() public method

$table->findByPk($primaryKey); $table->findByPk($key1, $key2, ...); $table->findByPk(array($key1,$key2,...));
public findByPk ( $keys ) : array
return array matching record.

findBySql() public method

Execute arbituary sql command with binding parameters.
public findBySql ( $sql, $parameters = [] ) : array
return array query results.

getCommand() protected method

protected getCommand ( ) : TDataGatewayCommand
return TDataGatewayCommand command builder and executor.

getCriteria() protected method

Create a new TSqlCriteria object from a string $criteria. The $args are additional parameters and are used in place of the $parameters if $parameters is not an array and $args is an arrary.
protected getCriteria ( $criteria, $parameters, $args ) : TSqlCriteria
return TSqlCriteria criteria object.

getDbConnection() public method

public getDbConnection ( ) : TDbConnection
return TDbConnection database connection.

getLastInsertId() public method

public getLastInsertId ( ) : mixed
return mixed last insert id, null if none is found.

getTableInfo() public method

public getTableInfo ( )

getTableName() public method

public getTableName ( )

initCommandBuilder() protected method

protected initCommandBuilder ( $builder )

insert() public method

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 insert ( $data ) : mixed
return mixed last insert id if one column contains a serial or sequence, otherwise true if command executes successfully and affected 1 or more rows.

onCreateCommand() public method

The parameter object is TDataGatewayEventParameter of which the {@link TDataGatewayEventParameter::getCommand Command} property can be inspected to obtain the sql query to be executed.
public onCreateCommand ( $sender, $param )

onExecuteCommand() public method

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.
public onExecuteCommand ( $sender, $param )

setTableInfo() protected method

protected setTableInfo ( $tableInfo )

setTableName() protected method

Sets up the command builder for the given table.
protected setTableName ( $tableName )

update() public method

This method uses additional arguments as $parameters. E.g. $gateway->update($data, 'age > ? AND location = ?', $age, $location);
public update ( $data, $criteria, $parameters = [] ) : integer
return integer number of records updated.