Statement
in package
implements
Statement
Table of Contents
Interfaces
- Statement
- Driver-level statement
Properties
- $lobs : array<int, string|resource|null>
- Map of LOB parameter positions to the tuples containing reference to the variable bound to the driver statement and the temporary file handle bound to the underlying statement
- $parameters : array<string|int, mixed>
- $stmt : resource
Methods
- bindParam() : bool
- Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question mark placeholder in the SQL statement that was use to prepare the statement. Unlike {@see bindValue()}, the variable is bound as a reference and will only be evaluated at the time that PDOStatement->execute() is called.
- bindValue() : bool
- Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional placeholder in the SQL statement that was used to prepare the statement.
- execute() : Result
- Executes a prepared statement
- bind() : void
- bindLobs() : array<int, resource>
- copyStreamToStream() : void
- createTemporaryFile() : resource
Properties
$lobs
Map of LOB parameter positions to the tuples containing reference to the variable bound to the driver statement and the temporary file handle bound to the underlying statement
private
array<int, string|resource|null>
$lobs
= []
$parameters
private
array<string|int, mixed>
$parameters
= []
$stmt
private
resource
$stmt
Methods
bindParam()
Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question mark placeholder in the SQL statement that was use to prepare the statement. Unlike {@see bindValue()}, the variable is bound as a reference and will only be evaluated at the time that PDOStatement->execute() is called.
public
bindParam(mixed $param, mixed &$variable[, mixed $type = ParameterType::STRING ][, mixed $length = null ]) : bool
Parameters
- $param : mixed
-
Parameter identifier. For a prepared statement using named placeholders, this will be a parameter name of the form :name. For a prepared statement using question mark placeholders, this will be the 1-indexed position of the parameter.
- $variable : mixed
-
Name of the PHP variable to bind to the SQL statement parameter.
- $type : mixed = ParameterType::STRING
-
Explicit data type for the parameter using the ParameterType constants.
- $length : mixed = null
-
You must specify maxlength when using an OUT bind so that PHP allocates enough memory to hold the returned value.
Tags
Return values
bool —TRUE on success or FALSE on failure.
bindValue()
Binds a value to a corresponding named (not supported by mysqli driver, see comment below) or positional placeholder in the SQL statement that was used to prepare the statement.
public
bindValue(mixed $param, mixed $value[, mixed $type = ParameterType::STRING ]) : bool
Parameters
- $param : mixed
-
Parameter identifier. For a prepared statement using named placeholders, this will be a parameter name of the form :name. For a prepared statement using question mark placeholders, this will be the 1-indexed position of the parameter.
- $value : mixed
-
The value to bind to the parameter.
- $type : mixed = ParameterType::STRING
-
Explicit data type for the parameter using the ParameterType constants.
Return values
bool —TRUE on success or FALSE on failure.
execute()
Executes a prepared statement
public
execute([mixed $params = null ]) : Result
Parameters
- $params : mixed = null
-
A numeric array of values with as many elements as there are bound parameters in the SQL statement being executed.
Return values
Resultbind()
private
bind(int $position, mixed &$variable, int $parameterType, int $dataType) : void
Parameters
- $position : int
-
Parameter position
- $variable : mixed
- $parameterType : int
- $dataType : int
Tags
bindLobs()
private
bindLobs() : array<int, resource>
Tags
Return values
array<int, resource>copyStreamToStream()
private
copyStreamToStream(resource $source, resource $target) : void
Parameters
- $source : resource
- $target : resource
Tags
createTemporaryFile()
private
createTemporaryFile() : resource