Class: KuoteObjects_EnrollmentSet

Source Location: /classes/KuoteObjects/EnrollmentSet.php

Class KuoteObjects_EnrollmentSet

Class Overview

Implements interfaces:

KuoteObjects EnrollmentSet

The KuoteObjects EnrollmentSet represents a collection of Enrollments in the Kuote system. It must implement the interfaces KuoteInterfaces_ObjectSet, and KuoteInterfaces_EnrollmentSet.

Located in /classes/KuoteObjects/EnrollmentSet.php [line 19]

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Properties

$enrollments

Methods

[ Top ]

Property Summary

mixed

$enrollments

Array to hold enrollment objects

[ Top ]

Method Summary

integer	count()	Returns the number of Enrollments in this set.
KuoteObjects_Enrollment	fetch()	Returns the first Enrollment in the set on the first call.
integer	getByUser()	Populates this EnrollmentSet with all the enrollments for the given user.
boolean	reset()	After calling reset(), fetch() will begin from the beginning of the set again.

[ Top ]

Properties

mixed $enrollments = array() [line 25]

Array to hold enrollment objects

API Tags:

Access:

protected

[ Top ]

Methods

count [line 62]

integer count(
)

Returns the number of Enrollments in this set.

API Tags:

Return:	Number of Enrollments currently in this set.
Access:	public

[ Top ]

fetch [line 35]

KuoteObjects_Enrollment fetch(
)

Returns the first Enrollment in the set on the first call.

The next Enrollment in the set on each successive call.

API Tags:

Return:	An Enrollment object. OR boolean False if there are no more Enrollments in the set.
Access:	public

[ Top ]

getByUser [line 72]

integer getByUser(
KuoteObjects_User
$user 
)

Populates this EnrollmentSet with all the enrollments for the given user.

Parameters:

KuoteObjects_User

$user:

The user whose Enrollments to get.

API Tags:

Return:	Number of Enrollments found.
Access:	public

[ Top ]

reset [line 53]

boolean reset(
)

After calling reset(), fetch() will begin from the beginning of the set again.

API Tags:

Return:	True on successful reset, false otherwise.
Access:	public

[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:17:31 -0500 by phpDocumentor 1.3.0

	KuoteObjects EnrollmentSet

[ class tree: KuoteObjects ] [ index: KuoteObjects ] [ all elements ]