Wikimedia\Rdbms\PostgresResultWrapper Class Reference

Result wrapper for PostgreSQL database results. More...

Inherits Wikimedia\Rdbms\ResultWrapper.

Collaboration diagram for Wikimedia\Rdbms\PostgresResultWrapper:

Public Member Functions
	__construct (DatabasePostgres $db, Connection $handle, Result $result)
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 DBUnexpectedError Thrown 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 DBUnexpectedError Thrown 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

Result wrapper for PostgreSQL database results.

Since

1.37

Definition at line 13 of file PostgresResultWrapper.php.

Constructor & Destructor Documentation

__construct()

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

Access: internal

Definition at line 22 of file PostgresResultWrapper.php.

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 34 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 52 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 93 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 98 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 29 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 88 of file PostgresResultWrapper.php.

---

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

• includes/libs/Rdbms/Database/ResultWrapper/PostgresResultWrapper.php