JDatabaseQueryPreparable

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

12.1

package

Joomla.Platform

Methods

bind

Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also removes a variable that has been bounded from the internal bounded array when the passed in value is null.

bind(string|integer $key = null,  &$value = null, integer $dataType = \PDO::PARAM_STR, integer $length, array $driverOptions = array()) : \JDatabaseQuery
since

12.1

Arguments

$key

string|integerThe 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

$dataType

integerConstant corresponding to a SQL datatype.

$length

integerThe length of the variable. Usually required for OUTPUT parameters.

$driverOptions

arrayOptional driver options to be used.

Response

\JDatabaseQuery

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

12.1

Arguments

$key

mixedThe bounded variable key to retrieve.

Response

mixed