MysqliStatement
Implements StatementInterfaceMySQLi Database Statement.
This class is modeled on \Doctrine\DBAL\Driver\Mysqli\MysqliStatement
since |
2.0.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\mysqli connection, string query) : mixed
since |
2.0.0 |
---|---|
throws |
|
Arguments
- connection
\mysqli
The database connection resource- query
string
The query this statement will process
Response
mixed
bindParam
Binds a parameter to the specified variable name.
bindParam(string|int parameter, mixed &variable, int dataType = ParameterType::STRING, int length = null, array driverOptions = null) : bool
since |
2.0.0 |
---|
Arguments
- parameter
string|int
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.- dataType
int
Constant corresponding to a SQL datatype, this should be the processed type from the QueryInterface.- length
int
The length of the variable. Usually required for OUTPUT parameters.- driverOptions
array
Optional driver options to be used.
Response
bool
bindValues
Binds a array of values to bound parameters.
bindValues(array values) : bool
since |
2.0.0 |
---|
Arguments
- values
array
The values to bind to the statement
Response
bool
closeCursor
Closes the cursor, enabling the statement to be executed again.
closeCursor() : void
since |
2.0.0 |
---|
errorCode
Fetches the SQLSTATE associated with the last operation on the statement handle.
errorCode() : string
since |
2.0.0 |
---|
Response
string
errorInfo
Fetches extended error information associated with the last operation on the statement handle.
errorInfo() : array
since |
2.0.0 |
---|
Response
array
execute
Executes a prepared statement
execute(array|null parameters = null) : bool
since |
2.0.0 |
---|
Arguments
- parameters
array|null
An array of values with as many elements as there are bound parameters in the SQL statement being executed.
Response
bool
fetch
Fetches the next row from a result set
fetch(int|null fetchStyle = null, int cursorOrientation = FetchOrientation::NEXT, int cursorOffset) : mixed
since |
2.0.0 |
---|
Arguments
- fetchStyle
int|null
Controls how the next row will be returned to the caller. This value must be one of the FetchMode constants, defaulting to value of FetchMode::MIXED.- cursorOrientation
int
For a StatementInterface object representing a scrollable cursor, this value determines which row will be returned to the caller. This value must be one of the FetchOrientation constants, defaulting to FetchOrientation::NEXT.- cursorOffset
int
For a StatementInterface object representing a scrollable cursor for which the cursorOrientation parameter is set to FetchOrientation::ABS, this value specifies the absolute number of the row in the result set that shall be fetched. For a StatementInterface object representing a scrollable cursor for which the cursorOrientation parameter is set to FetchOrientation::REL, this value specifies the row to fetch relative to the cursor position beforefetch()
was called.
Response
mixed
The return value of this function on success depends on the fetch type. In all cases, boolean false is returned on failure.
fetchColumn
Returns a single column from the next row of a result set
fetchColumn(int columnIndex) : mixed
since |
2.0.0 |
---|
Arguments
- columnIndex
int
0-indexed number of the column you wish to retrieve from the row. If no value is supplied, the first column is retrieved.
Response
mixed
Returns a single column from the next row of a result set or boolean false if there are no more rows.
fetchData
Fetch the data from the statement.
fetchData() : array|bool
since |
2.0.0 |
---|
Response
array|bool
prepareParameterKeyMapping
Replace named parameters with numbered parameters
prepareParameterKeyMapping(string sql) : string
since |
2.0.0 |
---|
Arguments
- sql
string
The SQL statement to prepare.
Response
string
The processed SQL statement.
rowCount
Returns the number of rows affected by the last SQL statement.
rowCount() : int
since |
2.0.0 |
---|
Response
int
setFetchMode
Sets the fetch mode to use while iterating this statement.
setFetchMode(int fetchMode, mixed args) : void
since |
2.0.0 |
---|
Arguments
- fetchMode
int
The fetch mode, must be one of the FetchMode constants.- args
mixed
Optional mode-specific arguments.
Properties
bindedValues
Values which have been bound to the statement.
since |
2.0.0 |
---|
Type(s)
array
parameterKeyMapping
Mapping between named parameters and position in query.
since |
2.0.0 |
---|
Type(s)
array
parameterTypeMapping
Mapping array for parameter types.
since |
2.0.0 |
---|
Type(s)
array
columnNames
Column names from the executed statement.
since |
2.0.0 |
---|
Type(s)
array|bool|null
connection
The database connection resource.
since |
2.0.0 |
---|
Type(s)
\mysqli
defaultFetchStyle
The default fetch mode for the statement.
since |
2.0.0 |
---|
Type(s)
int
query
The query string being prepared.
since |
2.0.0 |
---|
Type(s)
string
result
Internal tracking flag to set whether there is a result set available for processing
since |
2.0.0 |
---|
Type(s)
bool
rowBindedValues
Values which have been bound to the rows of each result set.
since |
2.0.0 |
---|
Type(s)
array
statement
The prepared statement.
since |
2.0.0 |
---|
Type(s)
\mysqli_stmt
typesKeyMapping
Bound parameter types.
since |
2.0.0 |
---|
Type(s)
array