Class: KuoteObjects_LearningOfferingSet

Source Location: /classes/KuoteObjects/LearningOfferingSet.php

Class KuoteObjects_LearningOfferingSet

Class Overview

Implements interfaces:

KuoteObjects LearningOfferingSet

The KuoteObjects LearningOfferingSet represents a collection of LearningOfferings in the Kuote system. It must implement the interfaces KuoteInterfaces_ObjectSet, and KuoteInterfaces_LearningOfferingSet.

Located in /classes/KuoteObjects/LearningOfferingSet.php [line 20]

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Properties

$learningOfferings

Methods

[ Top ]

Property Summary

mixed

$learningOfferings

Array to hold LearningOffering objects

[ Top ]

Method Summary

integer	count()	Returns the number of Enrollments in this set.
HTML_Quickform	displayLearningOfferingSelectionForms()	Returns an HTML_QuickForm object to disply a list of learning offerings to take.
KuoteObjects_LearningOffering	fetch()	Returns the first LearningOffering in the set on the first call.
integer	getCurrentByCourseOffering()	Populates this LearningOfferingSet with all the currently offered LearningOfferings for the given Course Offering.
boolean	reset()	After calling reset(), fetch() will begin from the beginning of the set again.

[ Top ]

Properties

mixed $learningOfferings = array() [line 26]

Array to hold LearningOffering objects

API Tags:

Access:

protected

[ Top ]

Methods

count [line 63]

integer count(
)

Returns the number of Enrollments in this set.

API Tags:

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

[ Top ]

displayLearningOfferingSelectionForms [line 104]

HTML_Quickform displayLearningOfferingSelectionForms(
string
$function 
)

Returns an HTML_QuickForm object to disply a list of learning offerings to take.

Parameters:

string

$function:

The Kuote function using the form.

API Tags:

Return:	QuickForm object of the learning offerings selection form.
Access:	public
Deprecated:

[ Top ]

fetch [line 36]

KuoteObjects_LearningOffering fetch(
)

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

The next LearningOffering in the set on each successive call.

API Tags:

Return:	A LearningOffering object. OR boolean False if there are no more LearningOfferings in the set.
Access:	public

[ Top ]

getCurrentByCourseOffering [line 75]

integer getCurrentByCourseOffering(
integer
$courseOffering 
)

Populates this LearningOfferingSet with all the currently offered LearningOfferings for the given Course Offering.

Parameters:

integer

$courseOffering:

KuoteObjects_CourseOffering $courseOffering The CourseOffering whose LearningOfferings to get.

API Tags:

Return:	Number of Enrollments found.
Access:	public

[ Top ]

reset [line 54]

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:18:08 -0500 by phpDocumentor 1.3.0

	KuoteObjects LearningOfferingSet

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