PreparableInterface
Joomla Database Query Preparable Interface.
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
bind
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 |
---|
Arguments
- key
array|string|int
The 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
mixed
The 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|string
Constant corresponding to a SQL datatype. It can be an array, in this case it has to be same length of $key- length
int
The length of the variable. Usually required for OUTPUT parameters.- driverOptions
array
Optional driver options to be used.
Response
$this
getBounded
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 |
---|
Arguments
- key
mixed
The bounded variable key to retrieve.
Response
mixed
unbind
Method to unbind a bound variable.
unbind(array|string|int key) : $this
since |
2.0.0 |
---|
Arguments
- key
array|string|int
The key or array of keys to unbind.
Response
$this