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, $result)
	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 ( $pos)
	Change the position of the cursor in a result object. More...
	valid ()

Static Public Member Functions
static &	unwrap (&$res)
	Get the underlying RDBMS driver-specific result resource. More...

Protected Attributes
stdClass bool null	$currentRow
IDatabase	$db
int	$pos = 0
mixed null	$result
	RDBMS driver-specific result resource. More...

Private Member Functions
	getDB ()

Detailed Description

Result wrapper for grabbing data queried from an IDatabase object.

Only IDatabase-related classes should construct these. Other code may use the FakeResultWrapper class for convenience or compatibility shims.

Note that using the Iterator methods in combination with the non-Iterator IDatabase 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.

Definition at line 23 of file ResultWrapper.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

IDatabase	$db	Database handle that the result comes from
self | mixed	$result	RDBMS driver-specific result resource

Definition at line 38 of file ResultWrapper.php.

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

Member Function Documentation

current()

Wikimedia\Rdbms\ResultWrapper::current

(

)

Returns

stdClass|array|bool

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 101 of file ResultWrapper.php.

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

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

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

DBUnexpectedError

Thrown if the database returns an error

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 75 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

Referenced by Wikimedia\Rdbms\ResultWrapper\current(), and 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

DBUnexpectedError

Thrown if the database returns an error

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 79 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 88 of file ResultWrapper.php.

getDB()

Wikimedia\Rdbms\ResultWrapper::getDB ( )

private

Returns

IDatabase

Exceptions

RuntimeException

Definition at line 128 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$db.

Referenced by Wikimedia\Rdbms\ResultWrapper\fetchObject(), Wikimedia\Rdbms\ResultWrapper\fetchRow(), Wikimedia\Rdbms\ResultWrapper\numRows(), Wikimedia\Rdbms\ResultWrapper\rewind(), and Wikimedia\Rdbms\ResultWrapper\seek().

key()

Wikimedia\Rdbms\ResultWrapper::key

(

)

Returns

int

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 109 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$pos.

next()

Wikimedia\Rdbms\ResultWrapper::next

(

)

Returns

stdClass PhanParamSignatureMismatchInternal

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 113 of file ResultWrapper.php.

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

numRows()

Wikimedia\Rdbms\ResultWrapper::numRows

(

)

Get the number of rows in a result object.

Returns

int

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 71 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB().

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

rewind()

Wikimedia\Rdbms\ResultWrapper::rewind

(

)

Definition at line 93 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\getDB(), and Wikimedia\Rdbms\ResultWrapper\numRows().

seek()

Wikimedia\Rdbms\ResultWrapper::seek

(

$pos

)

Change the position of the cursor in a result object.

See mysql_data_seek()

Parameters

int

$pos

Implements Wikimedia\Rdbms\IResultWrapper.

Definition at line 83 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\$pos, and Wikimedia\Rdbms\ResultWrapper\getDB().

unwrap()

static& Wikimedia\Rdbms\ResultWrapper::unwrap ( &  $res )

static

Get the underlying RDBMS driver-specific result resource.

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.

Parameters

self | mixed

&$res

Returns

mixed

Since

1.34

Definition at line 59 of file ResultWrapper.php.

References $res.

Referenced by Wikimedia\Rdbms\DatabasePostgres\dataSeek(), Wikimedia\Rdbms\DatabaseMysqlBase\dataSeek(), Wikimedia\Rdbms\DatabaseSqlite\dataSeek(), Wikimedia\Rdbms\DatabaseSqlite\doQuery(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabaseSqlite\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\DatabaseSqlite\fetchRow(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabasePostgres\fieldName(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldName(), Wikimedia\Rdbms\DatabaseSqlite\fieldName(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldType(), Wikimedia\Rdbms\DatabasePostgres\fieldType(), Wikimedia\Rdbms\DatabaseMysqlBase\freeResult(), Wikimedia\Rdbms\DatabasePostgres\freeResult(), Wikimedia\Rdbms\DatabasePostgres\numFields(), Wikimedia\Rdbms\DatabaseMysqlBase\numFields(), Wikimedia\Rdbms\DatabaseSqlite\numFields(), Wikimedia\Rdbms\DatabasePostgres\numRows(), Wikimedia\Rdbms\DatabaseMysqlBase\numRows(), and Wikimedia\Rdbms\DatabaseSqlite\numRows().

valid()

Wikimedia\Rdbms\ResultWrapper::valid

(

)

Definition at line 120 of file ResultWrapper.php.

References Wikimedia\Rdbms\ResultWrapper\current().

Member Data Documentation

$currentRow

stdClass bool null Wikimedia\Rdbms\ResultWrapper::$currentRow

protected

Definition at line 32 of file ResultWrapper.php.

Referenced by Wikimedia\Rdbms\ResultWrapper\current(), and Wikimedia\Rdbms\ResultWrapper\next().

$db

IDatabase Wikimedia\Rdbms\ResultWrapper::$db

protected

Definition at line 25 of file ResultWrapper.php.

Referenced by Wikimedia\Rdbms\ResultWrapper\__construct(), and Wikimedia\Rdbms\ResultWrapper\getDB().

$pos

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

protected

Definition at line 30 of file ResultWrapper.php.

Referenced by Wikimedia\Rdbms\ResultWrapper\key(), and Wikimedia\Rdbms\ResultWrapper\seek().

$result

mixed null Wikimedia\Rdbms\ResultWrapper::$result

protected

RDBMS driver-specific result resource.

Definition at line 27 of file ResultWrapper.php.

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

---

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

• includes/libs/rdbms/database/resultwrapper/ResultWrapper.php