class MySQLStatement extends Query (View source)

Provides a record-view for mysqli prepared statements

By default streams unbuffered data, but seek(), rewind(), or numRecords() will force the statement to buffer itself and sacrifice any potential performance benefit.

Properties

protected mysqli_stmt $statement

The related mysqli statement object if generated using a prepared query

protected mysqli_result $metadata

Metadata result for this statement

protected bool $bound

Is the statement bound to the current resultset?

protected array $columns

List of column names

protected array $types

Map of column types, keyed by column name

protected array $boundValues

List of bound variables in the current row

Methods

public
array
column(string $column = null)

Return an array containing all the values from a specific column. If no column is set, then the first will be returned

from  Query
public
array
keyedColumn()

Return an array containing all values in the leftmost column, where the keys are the same as the values.

from  Query
public
array
map()

Return a map from the first column to the second column.

from  Query
public
array
record()

Returns the first record in the result

from  Query
public
string
value()

Returns the first column of the first record.

from  Query
public
string
table()

Return an HTML table containing the full result-set

from  Query
public
getIterator()

Return the next record in the query result.

public
int
numRecords()

Return the total number of items in the query result.

public
__construct(mysqli_stmt $statement, mysqli_result $metadata)

Hook the result-set given into a Query class, suitable for use by SilverStripe.

public
__destruct()

No description

protected
bind()

Binds this statement to the variables

public
void
rewind()

Rewind to the first row

Details

array column(string $column = null)

Return an array containing all the values from a specific column. If no column is set, then the first will be returned

Parameters

string $column

Return Value

array

array keyedColumn()

Return an array containing all values in the leftmost column, where the keys are the same as the values.

Return Value

array

array map()

Return a map from the first column to the second column.

Return Value

array

array record()

Returns the first record in the result

Return Value

array

string value()

Returns the first column of the first record.

Return Value

string

string table()

Return an HTML table containing the full result-set

Return Value

string

Traversable getIterator()

Return the next record in the query result.

Return Value

Traversable

int numRecords()

Return the total number of items in the query result.

Return Value

int

__construct(mysqli_stmt $statement, mysqli_result $metadata)

Hook the result-set given into a Query class, suitable for use by SilverStripe.

Parameters

mysqli_stmt $statement

The related statement, if present

mysqli_result $metadata

The metadata for this statement

__destruct()

No description

protected bind()

Binds this statement to the variables

void rewind()

Rewind to the first row

Return Value

void