Class: iHRIS Scheduled Training Course: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_List | I2CE_List]]. | *Extends the class: [[Class: I2CE_List | I2CE_List]]. | ||
*Location: Part of the module [[iHRIS Common Module List#training-course|training-course]] in the package [https://launchpad.net/ihris-common iHRIS Common] | *Location: Part of the module [[iHRIS Common Module List#training-course|training-course]] in the package [https://launchpad.net/ihris-common iHRIS Common] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L37 modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 37 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
iHRIS_Scheduled_Training_Course | iHRIS_Scheduled_Training_Course | ||
Line 32: | Line 32: | ||
==Methods== | ==Methods== | ||
===enrolledStudents()=== | ===enrolledStudents()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L139 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 139 | |||
*Signature: public function enrolledStudents($node,$template,$args) | *Signature: public function enrolledStudents($node,$template,$args) | ||
*Parameters: | *Parameters: | ||
Line 38: | Line 39: | ||
**$args | **$args | ||
===enrolledStudentsExpander()=== | ===enrolledStudentsExpander()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L64 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 64 | |||
*Signature: public function enrolledStudentsExpander($node,$template) | *Signature: public function enrolledStudentsExpander($node,$template) | ||
*Parameters: | *Parameters: | ||
Line 43: | Line 45: | ||
**$template | **$template | ||
===enrolledStudentsList()=== | ===enrolledStudentsList()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L74 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 74 | |||
*Signature: public function enrolledStudentsList($node,$template) | *Signature: public function enrolledStudentsList($node,$template) | ||
*Parameters: | *Parameters: | ||
Line 48: | Line 51: | ||
**$template | **$template | ||
===getEnrolledStudents()=== | ===getEnrolledStudents()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L95 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 95 | |||
*Signature: public function getEnrolledStudents() | *Signature: public function getEnrolledStudents() | ||
===getScheduledCourses()=== | ===getScheduledCourses()=== | ||
Return the list of scheduled course for the given course id. | Return the list of scheduled course for the given course id. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L152 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 152 | |||
*Signature: static public function getScheduledCourses($course_id,$flat) | *Signature: static public function getScheduledCourses($course_id,$flat) | ||
*Parameters: | *Parameters: | ||
Line 59: | Line 64: | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>the keys are the id of the scheduled course, the values are the string "$start_date -- $end_date" | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>the keys are the id of the scheduled course, the values are the string "$start_date -- $end_date" | ||
===getScheduledStudentIds()=== | ===getScheduledStudentIds()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L124 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 124 | |||
*Signature: public function getScheduledStudentIds() | *Signature: public function getScheduledStudentIds() | ||
===numberEnrolledStudents()=== | ===numberEnrolledStudents()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L89 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 89 | |||
*Signature: public function numberEnrolledStudents($node,$template) | *Signature: public function numberEnrolledStudents($node,$template) | ||
*Parameters: | *Parameters: | ||
Line 67: | Line 74: | ||
===validate()=== | ===validate()=== | ||
Perform any extra validation for the license. | Perform any extra validation for the license. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php#L53 common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php] on line 53 | |||
*Signature: public function validate() | *Signature: public function validate() | ||
==Inherited Methods== | ==Inherited Methods== |
Revision as of 10:22, 10 November 2009
This article describes the class iHRIS_Scheduled_Training_Course.
- Extends the class: I2CE_List.
- Location: Part of the module training-course in the package iHRIS Common
- Source: Defined in the file modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 37
- Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Scheduled_Training_Course
Form Fields
This class is a form class and provides the following form fields
training_course
The form field training_course is implemented by MAP
name
The form field name is implemented by STRING_LINE
num_students
The form field num_students is implemented by INT
notes
The form field notes is implemented by STRING_MLINE
instructors
The form field instructors is implemented by STRING_MLINE
start_date
The form field start_date is implemented by DATE_YMD
end_date
The form field end_date is implemented by DATE_YMD
location
The form field location is implemented by MAP
Constants
iHRIS_Scheduled_Training_Course::MAIN_FIELD
The main field name used for display a description of a record. Defined as: "name"
iHRIS_Scheduled_Training_Course::SEC_FIELD
The main field name used for display a description of a record. Defined as: "start_date"
Methods
enrolledStudents()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 139
- Signature: public function enrolledStudents($node,$template,$args)
- Parameters:
- $node
- $template
- $args
enrolledStudentsExpander()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 64
- Signature: public function enrolledStudentsExpander($node,$template)
- Parameters:
- $node
- $template
enrolledStudentsList()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 74
- Signature: public function enrolledStudentsList($node,$template)
- Parameters:
- $node
- $template
getEnrolledStudents()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 95
- Signature: public function getEnrolledStudents()
getScheduledCourses()
Return the list of scheduled course for the given course id.
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 152
- Signature: static public function getScheduledCourses($course_id,$flat)
- Parameters:
- integer $course_id
Defaults to zero meaning we get all courses- Default Value: 0
- boolean $flat
defaults to false- Default Value: false
- integer $course_id
- Returns: array
the keys are the id of the scheduled course, the values are the string "$start_date -- $end_date"
getScheduledStudentIds()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 124
- Signature: public function getScheduledStudentIds()
numberEnrolledStudents()
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 89
- Signature: public function numberEnrolledStudents($node,$template)
- Parameters:
- $node
- $template
validate()
Perform any extra validation for the license.
- Defined in common/modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php on line 53
- Signature: public function validate()
Inherited Methods
componentizeQuery()
This public method is inherited from I2CE_List->componentizeQuery()
createDataTree()
This public method is inherited from I2CE_List->createDataTree()
flattenDataTree()
This public method is inherited from I2CE_List->flattenDataTree()
getDisplayFields()
This public method is inherited from I2CE_List->getDisplayFields()
getExtendedDisplay()
This public method is inherited from I2CE_List->getExtendedDisplay()
getHTMLTemplate()
This public method is inherited from I2CE_List->getHTMLTemplate()
getListType()
This public method is inherited from I2CE_List->getListType()
getSortFields()
This public method is inherited from I2CE_List->getSortFields()
listOptions()
This public method is inherited from I2CE_List->listOptions()
lookup()
This public method is inherited from I2CE_List->lookup()
monsterMash()
This public method is inherited from I2CE_List->monsterMash()
name()
This public method is inherited from I2CE_List->name()
setDisplayData()
This public method is inherited from I2CE_List->setDisplayData()
walkupFieldPath()
This public method is inherited from I2CE_List->walkupFieldPath()
_flattenDataTree()
This protected method is inherited from I2CE_List->_flattenDataTree()
_monsterMash()
This protected method is inherited from I2CE_List->_monsterMash()
addCache()
This protected method is inherited from I2CE_List->addCache()
getCache()
This protected method is inherited from I2CE_List->getCache()
isCached()
This protected method is inherited from I2CE_List->isCached()
__construct()
This public method is inherited from I2CE_Form->__construct()
addChildForm()
This public method is inherited from I2CE_Form->addChildForm()
addField()
This public method is inherited from I2CE_Form->addField()
cleanup()
This public method is inherited from I2CE_Form->cleanup()
clearFields()
This public method is inherited from I2CE_Form->clearFields()
current()
This public method is inherited from I2CE_Form->current()
displayField()
This public method is inherited from I2CE_Form->displayField()
form()
This public method is inherited from I2CE_Form->form()
getAllowedParentForms()
This public method is inherited from I2CE_Form->getAllowedParentForms()
getAttribute()
This public method is inherited from I2CE_Form->getAttribute()
getChildForms()
This public method is inherited from I2CE_Form->getChildForms()
getChildFormsByForm()
This public method is inherited from I2CE_Form->getChildFormsByForm()
getChildren()
This public method is inherited from I2CE_Form->getChildren()
getDisplayName()
This public method is inherited from I2CE_Form->getDisplayName()
getField()
This public method is inherited from I2CE_Form->getField()
getFieldNames()
This public method is inherited from I2CE_Form->getFieldNames()
getFormId()
This public method is inherited from I2CE_Form->getFormId()
getHTMLName()
This public method is inherited from I2CE_Form->getHTMLName()
getId()
This public method is inherited from I2CE_Form->getId()
getParent()
This public method is inherited from I2CE_Form->getParent()
getParentForm()
This public method is inherited from I2CE_Form->getParentForm()
getParentID()
This public method is inherited from I2CE_Form->getParentID()
getQueryDisplay()
This public method is inherited from I2CE_Form->getQueryDisplay()
getQueryFields()
This public method is inherited from I2CE_Form->getQueryFields()
getQueryString()
This public method is inherited from I2CE_Form->getQueryString()
hasAttribute()
This public method is inherited from I2CE_Form->hasAttribute()
hasInvalid()
This public method is inherited from I2CE_Form->hasInvalid()
key()
This public method is inherited from I2CE_Form->key()
listFields()
This public method is inherited from I2CE_Form->listFields()
load()
This public method is inherited from I2CE_Form->load()
next()
This public method is inherited from I2CE_Form->next()
processDOM()
This public method is inherited from I2CE_Form->processDOM()
removeField()
This public method is inherited from I2CE_Form->removeField()
reset()
This public method is inherited from I2CE_Form->reset()
rewind()
This public method is inherited from I2CE_Form->rewind()
search()
This public method is inherited from I2CE_Form->search()
setAttribute()
This public method is inherited from I2CE_Form->setAttribute()
setDisplayName()
This public method is inherited from I2CE_Form->setDisplayName()
setForm()
This public method is inherited from I2CE_Form->setForm()
setFromPost()
This public method is inherited from I2CE_Form->setFromPost()
setId()
This public method is inherited from I2CE_Form->setId()
setParent()
This public method is inherited from I2CE_Form->setParent()
valid()
This public method is inherited from I2CE_Form->valid()
__get()
This protected method is inherited from I2CE_Form->__get()
__isset()
This protected method is inherited from I2CE_Form->__isset()
__set()
This protected method is inherited from I2CE_Form->__set()
__unset()
This protected method is inherited from I2CE_Form->__unset()
addFormFields()
This protected method is inherited from I2CE_Form->addFormFields()
getFormFieldsData()
This protected method is inherited from I2CE_Form->getFormFieldsData()
lookupArray()
This protected method is inherited from I2CE_Form->lookupArray()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$cache
Theis protected variable is inherited from I2CE_List->$cache
$children
Theis public variable is inherited from I2CE_Form->$children
$fields
Theis protected variable is inherited from I2CE_Form->$fields
$parent
Theis protected variable is inherited from I2CE_Form->$parent
$id
Theis protected variable is inherited from I2CE_Form->$id
$attributes
Theis protected variable is inherited from I2CE_Form->$attributes
$parent_forms
Theis protected variable is inherited from I2CE_Form->$parent_forms
Inherited Fuzzy Methods
isNumeric()
This method is inherited from I2CE_Form->isNumeric()
getLimitStyles()
This method is inherited from I2CE_Form->getLimitStyles()
checkLimit()
This method is inherited from I2CE_Form->checkLimit()
checkWhereClause()
This method is inherited from I2CE_Form->checkWhereClause()
createCheckFunction()
This method is inherited from I2CE_Form->createCheckFunction()
createCheckLimitString()
This method is inherited from I2CE_Form->createCheckLimitString()
generateLimit()
This method is inherited from I2CE_Form->generateLimit()
generateWhereClause()
This method is inherited from I2CE_Form->generateWhereClause()
processLimit()
This method is inherited from I2CE_Form->processLimit()
getDisplayedExistingLimit()
This method is inherited from I2CE_Form->getDisplayedExistingLimit()
isComponentized()
This method is inherited from I2CE_Form->isComponentized()
addChild()
This method is inherited from I2CE_Form->addChild()
getChildIds()
This method is inherited from I2CE_Form->getChildIds()
getStorage()
This method is inherited from I2CE_Form->getStorage()
isWritable()
This method is inherited from I2CE_Form->isWritable()
populate()
This method is inherited from I2CE_Form->populate()
populateChild()
This method is inherited from I2CE_Form->populateChild()
populateChildren()
This method is inherited from I2CE_Form->populateChildren()
populateFirst()
This method is inherited from I2CE_Form->populateFirst()
populateHistory()
This method is inherited from I2CE_Form->populateHistory()
populateLast()
This method is inherited from I2CE_Form->populateLast()
delete()
This method is inherited from I2CE_Form->delete()
save()
This method is inherited from I2CE_Form->save()
setChangeType()
This method is inherited from I2CE_Form->setChangeType()
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()