MediaWiki master
Wikimedia\Rdbms\MysqliResultWrapper Class Reference

Inherits Wikimedia\Rdbms\ResultWrapper.

Collaboration diagram for Wikimedia\Rdbms\MysqliResultWrapper:

Public Member Functions

 __construct (DatabaseMySQL $db, mysqli_result $result)
 
 getInternalFieldInfo ( $fieldName)
 Get information about a field in the result set.
 
- Public Member Functions inherited from Wikimedia\Rdbms\ResultWrapper
 count ()
 Get the number of rows in a result object.
Returns
int

 
 current ()
 
Returns
stdClass|array|false

 
 fetchObject ()
 Fetch the next row from the given result object, in object form.Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.
Returns
stdClass|false
Exceptions
DBUnexpectedErrorThrown if the database returns an error

 
 fetchRow ()
 Fetch the next row from the given result object, in associative array form.Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.
Returns
array|false
Exceptions
DBUnexpectedErrorThrown if the database returns an error

 
 free ()
 Free a result object.This either saves memory in PHP (buffered queries) or on the server (unbuffered queries). In general, queries are not large enough in result sets for this to be worth calling.
 
 getFieldNames ()
 Get the names of the fields in the result.
Since
1.37
Returns
string[]

 
 key ()
 
Returns
int

 
 next ()
 
Returns
void

 
 numRows ()
 Get the number of rows in a result object.
Returns
int

 
 rewind ()
 
 seek ( $pos)
 Change the position of the cursor in a result object.See mysql_data_seek()
Exceptions
OutOfBoundsException
Parameters
int$pos

 
 valid ()
 

Protected Member Functions

 doFetchObject ()
 Get the next row as a stdClass object, or false if iteration has proceeded past the end.The offset within the result set is in $this->currentPos.
Since
1.37
Returns
stdClass|bool

 
 doFetchRow ()
 Get the next row as an array containing the data duplicated, once with string keys and once with numeric keys, per the PDO::FETCH_BOTH convention.Or false if iteration has proceeded past the end.
Returns
array|bool

 
 doFree ()
 Free underlying data.It is not necessary to do anything.
 
 doGetFieldNames ()
 Get the field names in the result set.
Returns
string[]

 
 doNumRows ()
 Get the number of rows in the result set.
Since
1.37
Returns
int

 
 doSeek ( $pos)
 Modify the current cursor position to the row with the specified offset.If $pos is out of bounds, the behaviour is undefined.
Parameters
int$pos

 

Additional Inherited Members

- Protected Attributes inherited from Wikimedia\Rdbms\ResultWrapper
int $currentPos = 0
 The offset of the current row that would be returned by current() and may have been previously returned by fetchObject().
 
stdClass array bool null $currentRow
 The row at $this->currentPos, or null if it has not yet been retrieved, or false if the current row was past the end.
 
int $nextPos = 0
 The offset of the row that would be returned by the next call to fetchObject().
 

Detailed Description

Definition at line 7 of file MysqliResultWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\MysqliResultWrapper::__construct ( DatabaseMySQL $db,
mysqli_result $result )
Access: internal
Parameters
DatabaseMySQL$db
mysqli_result$result

Definition at line 19 of file MysqliResultWrapper.php.

Member Function Documentation

◆ doFetchObject()

Wikimedia\Rdbms\MysqliResultWrapper::doFetchObject ( )
protected

Get the next row as a stdClass object, or false if iteration has proceeded past the end.The offset within the result set is in $this->currentPos.

Since
1.37
Returns
stdClass|bool

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 48 of file MysqliResultWrapper.php.

◆ doFetchRow()

Wikimedia\Rdbms\MysqliResultWrapper::doFetchRow ( )
protected

Get the next row as an array containing the data duplicated, once with string keys and once with numeric keys, per the PDO::FETCH_BOTH convention.Or false if iteration has proceeded past the end.

Returns
array|bool

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 58 of file MysqliResultWrapper.php.

◆ doFree()

Wikimedia\Rdbms\MysqliResultWrapper::doFree ( )
protected

Free underlying data.It is not necessary to do anything.

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 73 of file MysqliResultWrapper.php.

◆ doGetFieldNames()

Wikimedia\Rdbms\MysqliResultWrapper::doGetFieldNames ( )
protected

Get the field names in the result set.

Returns
string[]

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 78 of file MysqliResultWrapper.php.

◆ doNumRows()

Wikimedia\Rdbms\MysqliResultWrapper::doNumRows ( )
protected

Get the number of rows in the result set.

Since
1.37
Returns
int

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 25 of file MysqliResultWrapper.php.

◆ doSeek()

Wikimedia\Rdbms\MysqliResultWrapper::doSeek ( $pos)
protected

Modify the current cursor position to the row with the specified offset.If $pos is out of bounds, the behaviour is undefined.

Parameters
int$pos

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 68 of file MysqliResultWrapper.php.

◆ getInternalFieldInfo()

Wikimedia\Rdbms\MysqliResultWrapper::getInternalFieldInfo ( $fieldName)

Get information about a field in the result set.

Parameters
string$fieldName
Returns
bool|MySQLField
Access: internal
For DatabaseMySQL::fieldInfo() only

Definition at line 93 of file MysqliResultWrapper.php.


The documentation for this class was generated from the following file: