Class \Prado\Data\Common\TDbCommandBuilder

TDbCommandBuilder provides basic methods to create query commands for tables giving by {@see setTableInfo TableInfo} the property.

Class hierarchy

\Prado\Data\Common\TDbCommandBuilder

\Prado\TComponent

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

Methods summary
`public`	`__construct([null\|TDbConnection $connection = null ][, null\|TDbTableInfo $tableInfo = null ]) : mixed` The common __construct.
`public`	`applyCriterias(mixed $sql[, mixed $parameters = [] ][, mixed $ordering = [] ][, mixed $limit = -1 ][, mixed $offset = -1 ]) : mixed`
`public`	`applyLimitOffset(string $sql[, int $limit = -1 ][, int $offset = -1 ]) : string` Alters the sql to apply $limit and $offset. Default implementation is applicable for PostgreSQL, MySQL and SQLite.
`public`	`applyOrdering(string $sql, array<string\|int, mixed> $ordering) : string`
`public`	`bindArrayValues(TDbCommand $command, array<string\|int, mixed> $values) : mixed`
`public`	`bindColumnValues(TDbCommand $command, array<string\|int, mixed> $values) : mixed` Bind the name-value pairs of $values where the array keys correspond to column names.
`public`	`createCommand(string $sql) : TDbCommand`
`public`	`createCountCommand([string $where = '1=1' ][, array<string\|int, mixed> $parameters = [] ][, array<string\|int, mixed> $ordering = [] ][, int $limit = -1 ][, int $offset = -1 ]) : TDbCommand` Creates a count(*) command for the table described in {@see setTableInfo TableInfo}.
`public`	`createDeleteCommand(string $where[, array<string\|int, mixed> $parameters = [] ]) : TDbCommand` Creates a delete command for the table described in {@see setTableInfo TableInfo}. The conditions for delete is given by the $where argument and the parameters for the condition is given by $parameters.
`public`	`createFindCommand([string $where = '1=1' ][, array<string\|int, mixed> $parameters = [] ][, array<string\|int, mixed> $ordering = [] ][, int $limit = -1 ][, int $offset = -1 ][, string $select = '' ]) : TDbCommand` Appends the $where condition to the string "SELECT FROM tableName WHERE ". The tableName is obtained from the \Prado\Data\Common\setTableInfo property.
`public`	`createInsertCommand(array<string\|int, mixed> $data) : TDbCommand` Creates an insert command for the table described in {@see setTableInfo TableInfo} for the given data. Each array key in the $data array must correspond to the column name of the table (if a column allows to be null, it may be omitted) to be inserted with the corresponding array value.
`public`	`createUpdateCommand(array<string\|int, mixed> $data, string $where[, array<string\|int, mixed> $parameters = [] ]) : TDbCommand` Creates an update command for the table described in {@see setTableInfo TableInfo} for the given data. Each array key in the $data array must correspond to the column name to be updated with the corresponding array value.
`public`	`getDbConnection() : TDbConnection`
`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 static`	`getPdoType(mixed $value) : null\|int`
`public`	`getSearchExpression(array<string\|int, mixed> $fields, string $keywords) : string` Computes the SQL condition for search a set of column using regular expression (or LIKE, depending on database implementation) to match a string of keywords (default matches all keywords).
`public`	`getSelectFieldList([mixed $data = '' ]) : array<string\|int, mixed>` Different behavior depends on type of passed data string usage without modification null will be expanded to full list of quoted table column names (quoting depends on database) array Column names will be quoted if used as key or value of array array('col1', 'col2', 'col2') // SELECT `col1`, `col2`, `col3` FROM... Column aliasing array('mycol1' => 'col1', 'mycol2' => 'COUNT()') // SELECT `col1` AS mycol1, COUNT() AS mycol2 FROM... NULL and scalar values (strings will be quoted depending on database) array('col1' => 'my custom string', 'col2' => 1.0, 'col3' => 'NULL') // SELECT "my custom string" AS `col1`, 1.0 AS `col2`, NULL AS `col3` FROM... If the -wildcard char is used as key or value, add the full list of quoted table column names array('col1' => 'NULL', '*') // SELECT `col1`, `col2`, `col3`, NULL AS `col1` FROM...
`public`	`getTableInfo() : TDbTableInfo`
`public`	`setDbConnection(TDbConnection $value) : mixed`
`public`	`setTableInfo(TDbTableInfo $value) : mixed`
`protected`	`getColumnBindings(array<string\|int, mixed> $values[, bool $position = false ]) : string` Create a name-value or position-value if $position=true binding strings.
`protected`	`getInsertFieldBindings(object $values) : array<string\|int, mixed>` Returns a list of insert field name and a list of binding names.
`protected`	`getSearchCondition(string $column, array<string\|int, mixed> $words) : string`
`protected`	`hasIntegerKey(array<string\|int, mixed> $array) : bool`

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\Common\TDbCommandBuilder

Class hierarchy