DAOResultFactory Class Reference

Inheritance diagram for DAOResultFactory:

Public Member Functions
	__construct ($records, $dao, $functionName, $idFields=array(), $functionParams=array())
	atFirstPage ()
	atLastPage ()
	close ()
	eof ()
	getCount ()
	getPage ()
	getPageCount ()
	move ($to)
	next ()
	nextWithKey ($idField=null)
	toArray ()
	toAssociativeArray ($idField='id')
	toIterator ()
	wasEmpty ()
Public Member Functions inherited from ItemIterator
	__construct ()
	nextWithKey ()

Data Fields
	$count
	$dao
	$functionName
	$functionParams
	$idFields
	$isFirst
	$isLast
	$page
	$pageCount
	$records
	$wasEmpty

Detailed Description

Wrapper around ADORecordSet providing "factory" features for generating objects from DAOs.

Definition at line 21 of file DAOResultFactory.inc.php.

Constructor & Destructor Documentation

__construct()

DAOResultFactory::__construct	(		$records,
			$dao,
			$functionName,
			$idFields = array(),
			$functionParams = array()
	)

Constructor. Initialize the DAOResultFactory

Parameters

$records	object ADO record set
$dao	object DAO class for factory
$functionName	The function to call on $dao to create an object
$idFields	array an array of primary key field names that uniquely identify a result row in the record set. Should be data object _data array key, not database column name

Definition at line 73 of file DAOResultFactory.inc.php.

References $dao, $functionName, $functionParams, $idFields, $records, and wasEmpty().

Member Function Documentation

atFirstPage()

DAOResultFactory::atFirstPage

(

)

Determine whether this iterator represents the first page of a set.

Returns

boolean

Reimplemented from ItemIterator.

Definition at line 160 of file DAOResultFactory.inc.php.

References $isFirst.

atLastPage()

DAOResultFactory::atLastPage

(

)

Determine whether this iterator represents the last page of a set.

Returns

boolean

Reimplemented from ItemIterator.

Definition at line 168 of file DAOResultFactory.inc.php.

References $isLast.

close()

DAOResultFactory::close

(

)

Clean up the record set. This is called aggressively because it can free resources.

Definition at line 221 of file DAOResultFactory.inc.php.

Referenced by eof(), and next().

eof()

DAOResultFactory::eof

(

)

Return a boolean indicating whether or not we've reached the end of results

Returns

boolean

Reimplemented from ItemIterator.

Definition at line 200 of file DAOResultFactory.inc.php.

References close().

Referenced by toArray(), and toAssociativeArray().

getCount()

DAOResultFactory::getCount

(

)

Get the total number of items in the set.

Returns

int

Reimplemented from ItemIterator.

Definition at line 184 of file DAOResultFactory.inc.php.

References $count.

getPage()

DAOResultFactory::getPage

(

)

Get the page number of a set that this iterator represents.

Returns

int

Reimplemented from ItemIterator.

Definition at line 176 of file DAOResultFactory.inc.php.

References $page.

getPageCount()

DAOResultFactory::getPageCount

(

)

Get the total number of pages in the set.

Returns

int

Reimplemented from ItemIterator.

Definition at line 192 of file DAOResultFactory.inc.php.

References $pageCount.

move()

DAOResultFactory::move

(

$to

)

Advances the internal cursor to a specific row.

Parameters

int

$to

Returns

boolean

Definition at line 105 of file DAOResultFactory.inc.php.

next()

DAOResultFactory::next

(

)

Return the object representing the next row.

Returns

object?

Reimplemented from ItemIterator.

Definition at line 117 of file DAOResultFactory.inc.php.

References $dao, $functionName, $records, and close().

Referenced by nextWithKey(), toArray(), and toAssociativeArray().

nextWithKey()

DAOResultFactory::nextWithKey

(

$idField = null

)

Return the next row, with key.

Returns

array? ($key, $value)

Definition at line 137 of file DAOResultFactory.inc.php.

References next().

toArray()

DAOResultFactory::toArray

(

)

Convert this iterator to an array.

Returns

array

Reimplemented from ItemIterator.

Definition at line 233 of file DAOResultFactory.inc.php.

References eof(), and next().

toAssociativeArray()

DAOResultFactory::toAssociativeArray

(

$idField = 'id'

)

Convert this iterator to an associative array by database ID.

Returns

array

Definition at line 253 of file DAOResultFactory.inc.php.

References eof(), and next().

toIterator()

DAOResultFactory::toIterator

(

)

Return an Iterator for this DAOResultFactory.

Returns

Iterator

Definition at line 245 of file DAOResultFactory.inc.php.

wasEmpty()

DAOResultFactory::wasEmpty

(

)

Return a boolean indicating whether or not this resultset was empty from the beginning

Returns

boolean

Reimplemented from ItemIterator.

Definition at line 213 of file DAOResultFactory.inc.php.

References $wasEmpty.

Referenced by __construct().

Field Documentation

$count

DAOResultFactory::$count

Definition at line 60 of file DAOResultFactory.inc.php.

Referenced by getCount().

$dao

DAO DAOResultFactory::$dao

The DAO used to create objects

Definition at line 26 of file DAOResultFactory.inc.php.

Referenced by __construct(), and next().

$functionName

string DAOResultFactory::$functionName

The name of the DAO's factory function (to be called with an associative array of values)

Definition at line 32 of file DAOResultFactory.inc.php.

Referenced by __construct(), and next().

$functionParams

DAOResultFactory::$functionParams

Definition at line 34 of file DAOResultFactory.inc.php.

Referenced by __construct().

$idFields

array DAOResultFactory::$idFields

an array of primary key field names that uniquely identify a result row in the record set.

Definition at line 43 of file DAOResultFactory.inc.php.

Referenced by __construct().

$isFirst

DAOResultFactory::$isFirst

Definition at line 57 of file DAOResultFactory.inc.php.

Referenced by atFirstPage().

$isLast

DAOResultFactory::$isLast

Definition at line 58 of file DAOResultFactory.inc.php.

Referenced by atLastPage().

$page

DAOResultFactory::$page

Definition at line 59 of file DAOResultFactory.inc.php.

Referenced by getPage().

$pageCount

DAOResultFactory::$pageCount

Definition at line 61 of file DAOResultFactory.inc.php.

Referenced by getPageCount().

$records

ADORecordSet DAOResultFactory::$records

The ADORecordSet to be wrapped around

Definition at line 49 of file DAOResultFactory.inc.php.

Referenced by __construct(), and next().

$wasEmpty

boolean DAOResultFactory::$wasEmpty

True iff the resultset was always empty

Definition at line 55 of file DAOResultFactory.inc.php.

Referenced by wasEmpty().

---

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

• DAOResultFactory.inc.php