trait PreparableTrait (View source)

Class PreparableTrait

Methods

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

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.

mixed
getBounded(mixed $key = null)

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

Details

at line line 42
PreparableTrait bind(string|integer $key = null, mixed $value = null, integer $dataType = \PDO::PARAM_STR, integer $length, array $driverOptions = array())

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.

Parameters

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 &$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.

Return Value

PreparableTrait Returns this object to allow chaining.

at line line 86
mixed getBounded(mixed $key = null)

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

Parameters

mixed $key The bounded variable key to retrieve.

Return Value

mixed