Docs For Class HarmoniIterator

Description

A class for passing an arbitrary input array as an iterator.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: HarmoniIterator.class.php,v 1.12 2007/09/04 20:25:48 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/shared/HarmoniIterator.class.php (line 15)

SObject
   |
   --HarmoniIterator

Direct descendents

Class	Description
HarmoniAgentIterator	AgentIterator provides access to these objects sequentially, one at a time.
HarmoniAuthorizationIterator	AuthorizationIterator is the iterator for a collection of Authorizations.
HarmoniFunctionIterator	FunctionIterator is the iterator for a collection of Functions.
HarmoniQualifierIterator	QualifierIterator is the iterator for a collection of Qualifiers.
HarmoniCanonicalCourseIterator	CanonicalCourseIterator provides access to CanonicalCourses.
HarmoniCourseGradeRecordIterator	CourseGradeRecordIterator provides access to CourseGradeRecords.
HarmoniCourseGroupIterator	CourseGroupIterator provides access to CourseGroups. CourseGroup provides
HarmoniCourseOfferingIterator	CourseOfferingIterator provides access to CourseOfferings. CourseOffering
HarmoniCourseSectionIterator	CourseSectionIterator provides access to CourseSections. CourseSection
HarmoniEnrollmentRecordIterator	EnrollmentRecordIterator provides access to EnrollmentRecords.
HarmoniTermIterator	TermIterator provides access to Terms. Term provides access to these
HarmoniGradableObjectIterator	GradableObjectIterator provides access to these objects sequentially, one at
HarmoniGradeRecordIterator	GradeRecordIterator provides access to these objects sequentially, one at a
HarmoniHierarchyIterator	HierarchyIterator provides access to these objects sequentially, one at a
HarmoniNodeIterator	NodeIterator provides access to these objects sequentially, one at a time.
HarmoniTraversalInfoIterator	TraversalInfoIterator provides access to these objects sequentially, one at
HarmoniAssetIterator	AssetIterator provides access to these objects sequentially, one at a time.
HarmoniPartIterator	PartIterator provides access to these objects sequentially, one at a time.
HarmoniPartStructureIterator	PartStructureIterator provides access to these objects sequentially, one at
HarmoniRecordIterator	RecordIterator provides access to these objects sequentially, one at a time.
HarmoniRecordStructureIterator	RecordStructureIterator 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.
HarmoniRepositoryIterator	RepositoryIterator provides access to these objects sequentially, one at a
HarmoniAgentCommitmentIterator	AgentCommitmentIterator 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.
HarmoniScheduleItemIterator	ScheduleItemIterator provides access to these objects sequentially, one at a
HarmoniTimespanIterator	TimespanIterator provides access to these objects sequentially, one at a
HarmoniByteValueIterator	ByteValueIterator provides access to these objects sequentially, one at a
HarmoniCharValueIterator	CharValueIterator provides access to these objects sequentially, one at a
HarmoniIdIterator	IdIterator provides access to these objects sequentially, one at a time.
HarmoniIntValueIterator	IntValueIterator provides access to these objects sequentially, one at a
HarmoniLongValueIterator	LongValueIterator provides access to these objects sequentially, one at a
HarmoniObjectIterator	ObjectIterator provides access to these objects sequentially, one at a time.
HarmoniPropertiesIterator	PropertiesIterator provides access to these objects sequentially, one at a
HarmoniStringIterator	Stringiterator provides access to these objects sequentially, one at a time.
HarmoniTypeIterator	TypeIterator provides access to these objects sequentially, one at a time.
MultiIteratorIterator	A class for passing an arbitrary input array as an iterator.
TagFilterIterator	<##>
TaggedItemIterator	<##>
ExifAssetIterator	<##>
TabAssetIterator	<##>
XMLAssetIterator	<##>

Variable Summary

array $_elements

int $_i

Method Summary

HarmoniIterator HarmoniIterator (mixed $elementArray)

void add (ref $element)

int count ()

void hasNext ()

void next ()

void skipNext ()

Variables

array $_elements = array() (line 23)

var: The stored elements.
access: private

int $_i = -1 (line 29)

var: The current posititon.
access: private

Methods

Constructor HarmoniIterator (line 34)

Constructor

HarmoniIterator HarmoniIterator (mixed $elementArray)

add (line 54)

Add an item to the iterator.

WARNING: NOT IN OSID

since: 7/3/07
access: public

void add (ref $element)

ref $element: mixed $element

count (line 79)

Gives the number of items in the iterator

public:

int count ()

Redefined in descendants as:

AgentFilteringFromTraversalIterator::count() : Gives the number of items in the iterator
GroupsFromNodesIterator::count() : Gives the number of items in the iterator
LDAPAgentIterator::count() : Gives the number of items in the iterator
MultiIteratorIterator::count() : Gives the number of items in the iterator
TagFilterIterator::count() : Gives the number of items in the iterator
TaggedItemIterator::count() : Gives the number of items in the iterator

hasNext (line 59)

void hasNext ()

Redefined in descendants as:

AgentFilteringFromTraversalIterator::hasNext() : Return true if there is an additional Agent ; false otherwise.
GroupsFromNodesIterator::hasNext() : Return true if there is an additional Agent ; false otherwise.
UsersGroupIterator::hasNext()
LDAPAgentIterator::hasNext() : Return true if there is an additional Agent ; false otherwise.
FromNodesAssetIterator::hasNext() : Return true if there is an additional Asset ; false otherwise.
MultiIteratorIterator::hasNext()
TagFilterIterator::hasNext() : Answer true if there are more elements
TaggedItemIterator::hasNext() : Answer true if there are more items in the iterator
ExifAssetIterator::hasNext() : checks for existence of next element
TabAssetIterator::hasNext() : checks for existence of next element
XMLAssetIterator::hasNext() : checks if the next element exists

next (line 64)

void next ()

Redefined in descendants as:

AgentFilteringFromTraversalIterator::next() : Return the next Agent.
GroupsFromNodesIterator::next() : Return the next Agent.
UsersGroupIterator::next()
LDAPAgentIterator::next() : Return the next Agent.
HarmoniQualifierIterator::next() : Return the next Qualifier.
HarmoniAssetIterator::next() : Return the next Asset.
FromNodesAssetIterator::next() : Return the next Asset.
HarmoniRepositoryIterator::next() : Return the next Repository.
MultiIteratorIterator::next()
TagFilterIterator::next() : Answer the next Tag
TaggedItemIterator::next() : Answer the next Item
ExifAssetIterator::next() : returns the next element
TabAssetIterator::next() : returns the next element
XMLAssetIterator::next() : returns the next element

skipNext (line 89)

Skips the next item in the iterator

public:

void skipNext ()

Redefined in descendants as:

MultiIteratorIterator::skipNext() : Skips the next item in the iterator
TagFilterIterator::skipNext() : Skips the next item in the iterator
TaggedItemIterator::skipNext() : Skip the next Item

Inherited Methods

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()