Interface JDatabaseQueryPreparable
Description
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.
Located in /libraries/joomla/database/query/preparable.php (line 22)
Method Summary
JDatabaseQuery
bind
([string|integer $key = null], [mixed &$value = null], [integer $dataType = PDO::PARAM_STR], [integer $length = 0], [array $driverOptions = array()])
Methods
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.
JDatabaseQuery
bind
([string|integer $key = null], [mixed &$value = null], [integer $dataType = PDO::PARAM_STR], [integer $length = 0], [array $driverOptions = array()])
- string|integer $key: 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.
- mixed &$value: The value that will be bound. The value is passed by reference to support output parameters such as those possible with stored procedures.
- integer $dataType: Constant corresponding to a SQL datatype.
- integer $length: The length of the variable. Usually required for OUTPUT parameters.
- array $driverOptions: Optional driver options to be used.
Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is returned.
mixed
&getBounded
([mixed $key = null])
- mixed $key: The bounded variable key to retrieve.
Documentation generated on Tue, 19 Nov 2013 15:11:12 +0100 by phpDocumentor 1.4.3