MySQLStatement
class MySQLStatement extends SS_Query (View source)
Provides a record-view for mysqli 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 | array | $currentRecord | The current record in the interator. |
from SS_Query |
| protected | int | $rowNum | The number of the current row in the interator. |
from SS_Query |
| protected | bool | $queryHasBegun | Flag to keep track of whether iteration has begun, to prevent unnecessary seeks |
from SS_Query |
| 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 | $boundValues | List of bound variables in the current row |
Methods
Return an array containing all the values from a specific column. If no column is set, then the first will be returned
Return an array containing all values in the leftmost column, where the keys are the same as the values.
Iterator function implementation. Rewind the iterator to the first item and return it.
Iterator function implementation. Return the current item of the iterator.
Iterator function implementation. Return the first item of this iterator.
Iterator function implementation. Return the row number of the current item.
Iterator function implementation. Return the next record in the iterator.
Iterator function implementation. Check if the iterator is pointing to a valid item.
Hook the result-set given into a Query class, suitable for use by SilverStripe.
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
array
keyedColumn()
Return an array containing all values in the leftmost column, where the keys are the same as the values.
array
map()
Return a map from the first column to the second column.
array
record()
Returns the next record in the iterator.
string
value()
Returns the first column of the first record.
string
table()
Return an HTML table containing the full result-set
array
rewind()
Iterator function implementation. Rewind the iterator to the first item and return it.
Makes use of seek()} and {@link numRecords(), takes care of the plumbing.
array
current()
Iterator function implementation. Return the current item of the iterator.
array
first()
Iterator function implementation. Return the first item of this iterator.
int
key()
Iterator function implementation. Return the row number of the current item.
array
next()
Iterator function implementation. Return the next record in the iterator.
Makes use of nextRecord(), takes care of the plumbing.
bool
valid()
Iterator function implementation. Check if the iterator is pointing to a valid item.
array
nextRecord()
Return the next record in the query result.
int
numRecords()
Return the total number of items in the query result.
array
seek($row)
Go to a specific row number in the query result and return the record.
protected
bind()
Binds this statement to the variables
__construct(mysqli_stmt $statement, mysqli_result $metadata)
Hook the result-set given into a Query class, suitable for use by SilverStripe.
__destruct()
No description