Wikimedia\Rdbms\PostgresResultWrapper Class Reference

Inheritance diagram for Wikimedia\Rdbms\PostgresResultWrapper:

Collaboration diagram for Wikimedia\Rdbms\PostgresResultWrapper:

Public Member Functions
	__construct (DatabasePostgres $db, $handle, $result)
	getInternalResult ()
	Get the underlying result object or array.
Public Member Functions inherited from Wikimedia\Rdbms\ResultWrapper
	count ()
	Get the number of rows in a result object.
	current ()
	fetchObject ()
	Fetch the next row from the given result object, in object form.
	fetchRow ()
	Fetch the next row from the given result object, in associative array form.
	free ()
	Free a result object.
	getFieldNames ()
	Get the names of the fields in the result.
	key ()
	next ()
	numRows ()
	Get the number of rows in a result object.
	rewind ()
	seek ( $pos)
	Change the position of the cursor in a result object.
	valid ()

Protected Member Functions
	doFetchObject ()
	Get the next row as a stdClass object, or false if iteration has proceeded past the end.
	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.
	doFree ()
	Free underlying data.
	doGetFieldNames ()
	Get the field names in the result set.
	doNumRows ()
	Get the number of rows in the result set.
	doSeek ( $pos)
	Modify the current cursor position to the row with the specified offset.

Private Attributes
DatabasePostgres	$db
resource	$handle
resource	$result

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\ResultWrapper
static	unwrap ( $res)
	Get the underlying RDBMS driver-specific result resource.
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 PostgresResultWrapper.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Rdbms\PostgresResultWrapper::__construct	(	DatabasePostgres	$db,
			$handle,
			$result
	)

Access: internal

Parameters

DatabasePostgres	$db
resource	$handle
resource	$result

Definition at line 21 of file PostgresResultWrapper.php.

References Wikimedia\Rdbms\PostgresResultWrapper\$db, Wikimedia\Rdbms\PostgresResultWrapper\$handle, and Wikimedia\Rdbms\PostgresResultWrapper\$result.

Member Function Documentation

doFetchObject()

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

doFetchRow()

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

doFree()

Wikimedia\Rdbms\PostgresResultWrapper::doFree ( )

protected

Free underlying data.

It is not necessary to do anything.

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 60 of file PostgresResultWrapper.php.

doGetFieldNames()

Wikimedia\Rdbms\PostgresResultWrapper::doGetFieldNames ( )

protected

Get the field names in the result set.

Returns

string[]

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 64 of file PostgresResultWrapper.php.

doNumRows()

Wikimedia\Rdbms\PostgresResultWrapper::doNumRows ( )

protected

Get the number of rows in the result set.

Since

1.37

Returns

int

Reimplemented from Wikimedia\Rdbms\ResultWrapper.

Definition at line 38 of file PostgresResultWrapper.php.

doSeek()

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

getInternalResult()

Wikimedia\Rdbms\PostgresResultWrapper::getInternalResult

(

)

Get the underlying result object or array.

Since

1.37

Deprecated:

since 1.37 Only exists to support deprecated methods

Returns

resource

Definition at line 34 of file PostgresResultWrapper.php.

References Wikimedia\Rdbms\PostgresResultWrapper\$result.

Member Data Documentation

$db

DatabasePostgres Wikimedia\Rdbms\PostgresResultWrapper::$db

private

Definition at line 9 of file PostgresResultWrapper.php.

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

$handle

resource Wikimedia\Rdbms\PostgresResultWrapper::$handle

private

Definition at line 11 of file PostgresResultWrapper.php.

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

$result

resource Wikimedia\Rdbms\PostgresResultWrapper::$result

private

Definition at line 13 of file PostgresResultWrapper.php.

Referenced by Wikimedia\Rdbms\PostgresResultWrapper\__construct(), and Wikimedia\Rdbms\PostgresResultWrapper\getInternalResult().

---

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

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