Documentation

MysqliStatement
in package
implements IteratorAggregate, Statement

Tags
author

Kim Hemsø Rasmussen kimhemsoe@gmail.com

Interfaces, Classes and Traits

IteratorAggregate
Statement
Statement interface.

Table of Contents

$_bindedValues  : array<string|int, mixed>
$_columnNames  : null|bool|array<string|int, mixed>
$_conn  : mysqli
$_defaultFetchMode  : int
$_paramTypeMap  : array<string|int, mixed>
$_rowBindedValues  : null|array<string|int, mixed>
$_stmt  : mysqli_stmt
$_values  : array<string|int, mixed>
Contains ref values for bindValue().
$types  : string
$result  : bool
Indicates whether the statement is in the state when fetching results is possible
__construct()  : mixed
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 PDOStatement->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.
closeCursor()  : mixed
{@inheritdoc}
columnCount()  : mixed
{@inheritdoc}
errorCode()  : string
Fetches the SQLSTATE associated with the last operation on the statement handle.
errorInfo()  : array<string|int, mixed>
Fetches extended error information associated with the last operation on the statement handle.
execute()  : bool
Executes a prepared statement
fetch()  : mixed
{@inheritdoc}
fetchAll()  : mixed
{@inheritdoc}
fetchColumn()  : mixed
{@inheritdoc}
getIterator()  : mixed
{@inheritdoc}
rowCount()  : int
Returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding object.
setFetchMode()  : mixed
{@inheritdoc}
_bindValues()  : bool
Binds a array of values to bound parameters.
_fetch()  : bool|array<string|int, mixed>

Properties

$_columnNames

protected null|bool|array<string|int, mixed> $_columnNames

$_defaultFetchMode

protected int $_defaultFetchMode = PDO::FETCH_BOTH

$_paramTypeMap

protected static array<string|int, mixed> $_paramTypeMap = array(PDO::PARAM_STR => 's', PDO::PARAM_BOOL => 'i', PDO::PARAM_NULL => 's', PDO::PARAM_INT => 'i', PDO::PARAM_LOB => 's')

$_rowBindedValues

protected null|array<string|int, mixed> $_rowBindedValues

$_values

Contains ref values for bindValue().

protected array<string|int, mixed> $_values = array()

$result

Indicates whether the statement is in the state when fetching results is possible

private bool $result = false

Methods

__construct()

public __construct(mysqli $conn, string $prepareString) : mixed
Parameters
$conn : mysqli
$prepareString : string
Tags
throws
MysqliException
Return values
mixed —

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 PDOStatement->bindValue(), the variable is bound as a reference and will only be evaluated at the time that PDOStatement->execute() is called.

public bindParam(mixed $column, mixed &$variable[, mixed $type = null ][, mixed $length = null ]) : bool
Parameters
$column : 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 = null

Explicit data type for the parameter using the PDO::PARAM_* constants. To return an INOUT parameter from a stored procedure, use the bitwise OR operator to set the PDO::PARAM_INPUT_OUTPUT bits for the data_type parameter.

$length : mixed = null

You must specify maxlength when using an OUT bind so that PHP allocates enough memory to hold the returned value.

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 = 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.

$value : mixed

The value to bind to the parameter.

$type : mixed = null

Explicit data type for the parameter using the PDO::PARAM_* constants.

Return values
bool —

TRUE on success or FALSE on failure.

closeCursor()

{@inheritdoc}

public closeCursor() : mixed
Return values
mixed —

columnCount()

{@inheritdoc}

public columnCount() : mixed
Return values
mixed —

errorCode()

Fetches the SQLSTATE associated with the last operation on the statement handle.

public errorCode() : string
Return values
string —

The error code string.

errorInfo()

Fetches extended error information associated with the last operation on the statement handle.

public errorInfo() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The error info array.

execute()

Executes a prepared statement

public execute([mixed $params = null ]) : bool
Parameters
$params : mixed = null

An array of values with as many elements as there are bound parameters in the SQL statement being executed.

Return values
bool —

TRUE on success or FALSE on failure.

fetch()

{@inheritdoc}

public fetch([mixed $fetchMode = null ]) : mixed
Parameters
$fetchMode : mixed = null
Return values
mixed —

fetchAll()

{@inheritdoc}

public fetchAll([mixed $fetchMode = null ]) : mixed
Parameters
$fetchMode : mixed = null
Return values
mixed —

fetchColumn()

{@inheritdoc}

public fetchColumn(mixed $columnIndex) : mixed
Parameters
$columnIndex : mixed
Return values
mixed —

getIterator()

{@inheritdoc}

public getIterator() : mixed
Return values
mixed —

rowCount()

Returns the number of rows affected by the last DELETE, INSERT, or UPDATE statement executed by the corresponding object.

public rowCount() : int
Return values
int —

The number of rows.

setFetchMode()

{@inheritdoc}

public setFetchMode(mixed $fetchMode[, mixed $arg2 = null ][, mixed $arg3 = null ]) : mixed
Parameters
$fetchMode : mixed
$arg2 : mixed = null
$arg3 : mixed = null
Return values
mixed —

_bindValues()

Binds a array of values to bound parameters.

private _bindValues(array<string|int, mixed> $values) : bool
Parameters
$values : array<string|int, mixed>
Return values
bool —

_fetch()

private _fetch() : bool|array<string|int, mixed>
Return values
bool|array<string|int, mixed> —

Search results