Class SearchEntryIterator

Description

EntryIterator provides access to these objects sequentially, one at a time.

The purpose of all Iterators is to to offer a way for OSID methods to return multiple values of a common type and not use an array. Returning an array may not be appropriate if the number of values returned is large or is fetched remotely. Iterators do not allow access to values by index, rather you must access values in sequence. Similarly, there is no way to go backwards through the sequence unless you place the values in a data structure, such as an array, that allows for access by index.

  • version: $Id: SearchEntryIterator.class.php,v 1.4 2007/09/04 20:25:43 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College
  • since: 3/1/06

Located in /harmoni/core/oki2/logging/SearchEntryIterator.class.php (line 33)

EntryIterator
   |
   --HarmoniEntryIterator
      |
      --SearchEntryIterator
Method Summary
object SearchEntryIterator (string $logName, array $searchCriteria, object Type $formatType, object Type $priorityType, mixed $dbIndex)
Methods
Constructor SearchEntryIterator (line 48)

Constructor

  • since: 3/1/06
  • access: public
object SearchEntryIterator (string $logName, array $searchCriteria, object Type $formatType, object Type $priorityType, mixed $dbIndex)
  • string $logName
  • array $searchCriteria
  • object Type $formatType
  • object Type $priorityType
addWhereClauses (line 78)

Add where clauses to the query

  • since: 3/9/06
  • access: public
void addWhereClauses (object SelectQuery $query)

Redefinition of:
HarmoniEntryIterator::addWhereClauses()
Add where clauses to the query

Inherited Methods

Inherited From HarmoniEntryIterator

HarmoniEntryIterator::HarmoniEntryIterator()
HarmoniEntryIterator::addColumnsAndOrder()
HarmoniEntryIterator::addWhereClauses()
HarmoniEntryIterator::count()
HarmoniEntryIterator::getBaseQuery()
HarmoniEntryIterator::hasNext()
HarmoniEntryIterator::hasNextEntry()
HarmoniEntryIterator::loadCount()
HarmoniEntryIterator::loadNext()
HarmoniEntryIterator::next()
HarmoniEntryIterator::nextEntry()
HarmoniEntryIterator::skipNext()

Inherited From EntryIterator

EntryIterator::hasNextEntry()
EntryIterator::nextEntry()

Documentation generated on Wed, 19 Sep 2007 10:26:20 -0400 by phpDocumentor 1.3.0RC3