MediaWiki  master
Wikimedia\Rdbms\FakeResultWrapper Class Reference

Overloads the relevant methods of the real ResultsWrapper so it doesn't go anywhere near an actual database. More...

Inheritance diagram for Wikimedia\Rdbms\FakeResultWrapper:
Collaboration diagram for Wikimedia\Rdbms\FakeResultWrapper:

Public Member Functions

 __construct (array $rows)
 
 fetchObject ()
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow ()
 Fetch the next row from the given result object, in associative array form. More...
 
 free ()
 Free a result object. More...
 
 next ()
 
 numRows ()
 Get the number of rows in a result object. More...
 
 rewind ()
 
 seek ( $row)
 Change the position of the cursor in a result object. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\ResultWrapper
 __construct (IDatabase $db=null, $result)
 Create a row iterator from a result resource and an optional Database object. More...
 
 current ()
 
 fetchObject ()
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow ()
 Fetch the next row from the given result object, in associative array form. More...
 
 free ()
 Free a result object. More...
 
 key ()
 
 next ()
 
 numRows ()
 Get the number of rows in a result object. More...
 
 rewind ()
 
 seek ( $row)
 Change the position of the cursor in a result object. More...
 
 valid ()
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Rdbms\ResultWrapper
resource array null $result
 Optional underlying result handle for subclass usage. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\ResultWrapper
stdClass null $currentRow = null
 
IDatabase null $db
 
int $pos = 0
 

Detailed Description

Overloads the relevant methods of the real ResultsWrapper so it doesn't go anywhere near an actual database.

Definition at line 11 of file FakeResultWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\FakeResultWrapper::__construct ( array  $rows)
Parameters
stdClass[]$rows

Definition at line 17 of file FakeResultWrapper.php.

References null.

Member Function Documentation

◆ fetchObject()

Wikimedia\Rdbms\FakeResultWrapper::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|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 46 of file FakeResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$currentRow, and Wikimedia\Rdbms\FakeResultWrapper\fetchRow().

Referenced by Wikimedia\Rdbms\FakeResultWrapper\next().

◆ fetchRow()

Wikimedia\Rdbms\FakeResultWrapper::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|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 25 of file FakeResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$currentRow, and Wikimedia\Rdbms\ResultWrapper\$pos.

Referenced by Wikimedia\Rdbms\FakeResultWrapper\fetchObject().

◆ free()

Wikimedia\Rdbms\FakeResultWrapper::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.

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 43 of file FakeResultWrapper.php.

◆ next()

Wikimedia\Rdbms\FakeResultWrapper::next ( )
Returns
stdClass

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 60 of file FakeResultWrapper.php.

References class, and Wikimedia\Rdbms\FakeResultWrapper\fetchObject().

◆ numRows()

Wikimedia\Rdbms\FakeResultWrapper::numRows ( )

Get the number of rows in a result object.

Returns
int

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 21 of file FakeResultWrapper.php.

◆ rewind()

Wikimedia\Rdbms\FakeResultWrapper::rewind ( )

Definition at line 55 of file FakeResultWrapper.php.

References null.

◆ seek()

Wikimedia\Rdbms\FakeResultWrapper::seek (   $row)

Change the position of the cursor in a result object.

See mysql_data_seek()

Parameters
int$row

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 39 of file FakeResultWrapper.php.


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