Class \Prado\Data\DataGateway\TTableGateway

TTableGateway class provides several find methods to get data from the database and update, insert, and delete methods.

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 \Prado\Data\DataGateway\TDataGatewayEventParameter::getCommand 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 \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.

$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.
}

Class hierarchy

\Prado\Data\DataGateway\TTableGateway

\Prado\TComponent

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

Methods summary
`public`	`__call(mixed $method, mixed $args) : mixed` Dynamic find method using parts of method name as search criteria. 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`	`__construct(string\|TDbTableInfo $table, TDbConnection $connection) : mixed` Creates a new generic table gateway for a given table or view name and a database connection.
`public`	`count([string\|TSqlCriteria $criteria = null ][, mixed $parameters = [] ]) : int` Find the number of records.
`public`	`deleteAll(string $criteria[, array<string\|int, mixed> $parameters = [] ]) : int` Delete records from the table with condition given by $where and binding values specified by $parameter argument. This method uses additional arguments as $parameters. E.g. `$table->delete('age > ? AND location = ?', $age, $location);`
`public`	`deleteAllByPks(mixed $keys) : mixed` Alias for deleteByPk()
`public`	`deleteByPk(mixed $keys) : int` Delete records by primary key. Usage: `$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`	`find(string\|TSqlCriteria $criteria[, mixed $parameters = [] ]) : array<string\|int, mixed>` Find one single record that matches the criteria. 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`	`findAll([string\|TSqlCriteria $criteria = null ][, mixed $parameters = [] ]) : TDbDataReader` Accepts same parameters as find(), but returns TDbDataReader instead.
`public`	`findAllByPks(mixed $keys) : TDbDataReader` Similar to findByPk(), but returns TDbDataReader instead. 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`	`findAllBySql(string $sql[, array<string\|int, mixed> $parameters = [] ]) : TDbDataReader` Execute arbituary sql command with binding parameters.
`public`	`findByPk(mixed $keys) : array<string\|int, mixed>` Find one record using only the primary key or composite primary keys. Usage: `$table->findByPk($primaryKey); $table->findByPk($key1, $key2, ...); $table->findByPk(array($key1,$key2,...));`
`public`	`findBySql(string $sql[, array<string\|int, mixed> $parameters = [] ]) : array<string\|int, mixed>` Execute arbituary sql command with binding parameters.
`public`	`getDbConnection() : TDbConnection`
`public`	`getLastInsertId() : mixed`
`public`	`getTableInfo() : mixed`
`public`	`getTableName() : mixed`
`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 $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.
`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.
`public`	`update(array<string\|int, mixed> $data, string $criteria[, array<string\|int, mixed> $parameters = [] ]) : int` 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. This method uses additional arguments as $parameters. E.g. `$gateway->update($data, 'age > ? AND location = ?', $age, $location);`
`protected`	`getCommand() : TDataGatewayCommand`
`protected`	`getCriteria(string\|TSqlCriteria $criteria, mixed $parameters, array<string\|int, mixed> $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.
`protected`	`initCommandBuilder(TDbCommandBuilder $builder) : mixed`
`protected`	`setTableInfo(TDbTableInfo $tableInfo) : mixed`
`protected`	`setTableName(string $tableName) : mixed` Sets up the command builder for the given table.

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

Class hierarchy