Class: KuoteObjects_CourseOfferingSet

Source Location: /classes/KuoteObjects/CourseOfferingSet.php

Class KuoteObjects_CourseOfferingSet

Class Overview

Implements interfaces:

KuoteObjects CourseOfferingSet

The KuoteObjects CourseOfferingSet represents a collection of Course Offerings in the Kuote system. It must implement the interfaces KuoteInterfaces_ObjectSet, and KuoteInterfaces_CourseOfferingSet.

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

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Properties

$courseOfferings

Methods

[ Top ]

Property Summary

mixed

$courseOfferings

Array to hold course offering objects

[ Top ]

Method Summary

integer	count()	Returns the number of offerings in this set.
KuoteObjects_CourseOffing	fetch()	Returns the first course offering in the set on the first call.
integer	getAvailableCourseOfferings()	Populates this CourseOfferingSet with courses that the given user may enroll in, but not offerings which the user is already enrolled in.
boolean	reset()	After calling reset(), fetch() will begin from the beginning of the set again.

[ Top ]

Properties

mixed $courseOfferings = array() [line 25]

Array to hold course offering objects

API Tags:

Access:

protected

[ Top ]

Methods

count [line 62]

integer count(
)

Returns the number of offerings in this set.

API Tags:

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

[ Top ]

fetch [line 35]

KuoteObjects_CourseOffing fetch(
)

Returns the first course offering in the set on the first call.

The next offering in the set on each successive call.

API Tags:

Return:	A Course Offering object. OR boolean False if there are no more offerings in the set.
Access:	public

[ Top ]

getAvailableCourseOfferings [line 73]

integer getAvailableCourseOfferings(
KuoteObjects_User
$user 
)

Populates this CourseOfferingSet with courses that the given user may enroll in, but not offerings which the user is already enrolled in.

Parameters:

KuoteObjects_User

$user:

The user for which to get available course offerings.

API Tags:

Return:	Number of available offerings 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:21 -0500 by phpDocumentor 1.3.0

	KuoteObjects CourseOfferingSet

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