MediaWiki  master
Wikimedia\Rdbms\ResultWrapper Class Reference

Result wrapper for grabbing data queried from an IDatabase object. More...

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

Public Member Functions

 __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 ()
 

Public Attributes

resource array null $result
 Optional underlying result handle for subclass usage. More...
 

Protected Attributes

stdClass null $currentRow = null
 
IDatabase null $db
 
int $pos = 0
 

Private Member Functions

 getDB ()
 

Detailed Description

Result wrapper for grabbing data queried from an IDatabase object.

Note that using the Iterator methods in combination with the non-Iterator DB result iteration functions may cause rows to be skipped or repeated.

By default, this will use the iteration methods of the IDatabase handle if provided. Subclasses can override methods to make it solely work on the result resource instead. If no database is provided, and the subclass does not override the DB iteration methods, then a RuntimeException will be thrown when iteration is attempted.

The result resource field should not be accessed from non-Database related classes. It is database class specific and is stored here to associate iterators with queries.

Definition at line 24 of file ResultWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\ResultWrapper::__construct ( IDatabase  $db = null,
  $result 
)

Create a row iterator from a result resource and an optional Database object.

Only Database-related classes should construct ResultWrapper. Other code may use the FakeResultWrapper subclass for convenience or compatibility shims, however.

Parameters
IDatabase | null$dbOptional database handle
ResultWrapper | array | resource$resultOptional underlying result handle

Definition at line 45 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$db, and Wikimedia\Rdbms\ResultWrapper\$result.

Member Function Documentation

◆ current()

Wikimedia\Rdbms\ResultWrapper::current ( )

◆ fetchObject()

Wikimedia\Rdbms\ResultWrapper::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 58 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

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

◆ fetchRow()

Wikimedia\Rdbms\ResultWrapper::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 62 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

◆ free()

Wikimedia\Rdbms\ResultWrapper::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 70 of file ResultWrapper.php.

References null.

◆ getDB()

◆ key()

Wikimedia\Rdbms\ResultWrapper::key ( )
Returns
int

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 105 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$pos.

◆ next()

Wikimedia\Rdbms\ResultWrapper::next ( )

◆ numRows()

Wikimedia\Rdbms\ResultWrapper::numRows ( )

Get the number of rows in a result object.

Returns
int

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 54 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

Referenced by Wikimedia\Rdbms\ResultWrapper\rewind().

◆ rewind()

Wikimedia\Rdbms\ResultWrapper::rewind ( )

◆ seek()

Wikimedia\Rdbms\ResultWrapper::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 66 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

◆ valid()

Wikimedia\Rdbms\ResultWrapper::valid ( )

Definition at line 116 of file ResultWrapper.php.

References class, and Wikimedia\Rdbms\ResultWrapper\current().

Member Data Documentation

◆ $currentRow

◆ $db

IDatabase null Wikimedia\Rdbms\ResultWrapper::$db
protected

◆ $pos

int Wikimedia\Rdbms\ResultWrapper::$pos = 0
protected

◆ $result

resource array null Wikimedia\Rdbms\ResultWrapper::$result

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