Joomla! API

Joomla Database Query Preparable Interface.

deprecated

Adds bind/unbind methods as well as a getBounded() method to retrieve the stored bounded variables on demand prior to query execution.

since	1.0
deprecated	3.0 Capabilities will be required in Joomla\Database\QueryInterface
package	Joomla Framework

Methods

Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution.

bind(array|string|int key, mixed &value, array|string dataType = ParameterType::STRING, int length, array driverOptions = []) : $this

since	1.0

key: array|string|intThe key that will be used in your SQL query to reference the value. Usually of the form ':key', but can also be an integer.
value: mixedThe value that will be bound. It can be an array, in this case it has to be same length of $key; The value is passed by reference to support output parameters such as those possible with stored procedures.
dataType: array|stringConstant corresponding to a SQL datatype. It can be an array, in this case it has to be same length of $key
length: intThe length of the variable. Usually required for OUTPUT parameters.
driverOptions: arrayOptional driver options to be used.

$this

Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is returned.

getBounded(mixed key = null) : mixed

since	1.0

mixed

Method to unbind a bound variable.

unbind(array|string|int key) : $this

since	2.0.0

$this