ResultWrapper Class Reference

Result wrapper for grabbing data queried by someone else. More...

Inheritance diagram for ResultWrapper:

Collaboration diagram for ResultWrapper:

List of all members.

Public Member Functions
	__construct ($database, $result)
	Create a new result object from a result resource and a Database 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.
	key ()
	next ()
	numRows ()
	Get the number of rows in a result object.
	rewind ()
	seek ($row)
	Change the position of the cursor in a result object.
	valid ()
Public Attributes
resource	$result
	*
Protected Attributes
	$currentRow = null
DatabaseBase	$db
	*
int	$pos = 0
	*

---

Detailed Description

Result wrapper for grabbing data queried by someone else.

Definition at line 99 of file DatabaseUtility.php.

---

Constructor & Destructor Documentation

ResultWrapper::__construct	(	$	database,
		$	result
	)

Create a new result object from a result resource and a Database object.

Parameters:

DatabaseBase	$database
resource | ResultWrapper	$result

Definition at line 115 of file DatabaseUtility.php.

---

Member Function Documentation

ResultWrapper::current

(

)

Returns:

int

Definition at line 193 of file DatabaseUtility.php.

References next().

Referenced by valid().

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.

Returns:

object

Exceptions:

DBUnexpectedError

Thrown if the database returns an error

Reimplemented in MssqlResultWrapper, and FakeResultWrapper.

Definition at line 142 of file DatabaseUtility.php.

Referenced by next().

ResultWrapper::fetchRow

(

)

Fetch the next row from the given result object, in associative array form.

Fields are retrieved with $row['fieldname'].

Returns:

array

Exceptions:

DBUnexpectedError

Thrown if the database returns an error

Reimplemented in MssqlResultWrapper, and FakeResultWrapper.

Definition at line 153 of file DatabaseUtility.php.

ResultWrapper::free

(

)

Free a result object.

Reimplemented in FakeResultWrapper.

Definition at line 160 of file DatabaseUtility.php.

References result.

ResultWrapper::key

(

)

Returns:

int

Definition at line 204 of file DatabaseUtility.php.

ResultWrapper::next

(

)

Returns:

int

Reimplemented in FakeResultWrapper.

Definition at line 211 of file DatabaseUtility.php.

References fetchObject().

Referenced by current().

ResultWrapper::numRows

(

)

Get the number of rows in a result object.

Returns:

int

Reimplemented in FakeResultWrapper.

Definition at line 130 of file DatabaseUtility.php.

Referenced by rewind().

ResultWrapper::rewind

(

)

Reimplemented in FakeResultWrapper.

Definition at line 182 of file DatabaseUtility.php.

References numRows().

ResultWrapper::seek

(

$

row

)

Change the position of the cursor in a result object.

See mysql_data_seek()

Parameters:

int

$row

Reimplemented in MssqlResultWrapper, and FakeResultWrapper.

Definition at line 172 of file DatabaseUtility.php.

ResultWrapper::valid

(

)

Returns:

bool

Definition at line 221 of file DatabaseUtility.php.

References current().

---

Member Data Documentation

ResultWrapper::$currentRow = null [protected]

Reimplemented in FakeResultWrapper.

Definition at line 107 of file DatabaseUtility.php.

DatabaseBase ResultWrapper::$db [protected]

*

Reimplemented in FakeResultWrapper.

Definition at line 102 of file DatabaseUtility.php.

int ResultWrapper::$pos = 0 [protected]

*

Reimplemented in FakeResultWrapper.

Definition at line 104 of file DatabaseUtility.php.

resource ResultWrapper::$result

*

Reimplemented in FakeResultWrapper.

Definition at line 100 of file DatabaseUtility.php.

Referenced by MssqlResultWrapper\fetchObject(), and MssqlResultWrapper\fetchRow().

---

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

• includes/db/DatabaseUtility.php