|
|
| Line 1: |
Line 1: |
| This article describes the class ''iHRIS_Scheduled_Training_Course''.
| | #REDIRECT [[Class: iHRIS_Scheduled_Training_Course (4.0.3)]] |
| *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]
| |
| *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>
| |
| iHRIS_Scheduled_Training_Course
| |
| ==Form Fields==
| |
| This class is a [[Class: I2CE_Form |form class]] and provides the following [[Class: I2CE_FormField |form fields]]
| |
| ===training_course===
| |
| The form field ''training_course'' is implemented by [[Class: I2CE_FormField_MAP |MAP ]]
| |
| ===name===
| |
| The form field ''name'' is implemented by [[Class: I2CE_FormField_STRING_LINE |STRING_LINE ]]
| |
| ===num_students===
| |
| The form field ''num_students'' is implemented by [[Class: I2CE_FormField_INT |INT ]]
| |
| ===notes===
| |
| The form field ''notes'' is implemented by [[Class: I2CE_FormField_STRING_MLINE |STRING_MLINE ]]
| |
| ===instructors===
| |
| The form field ''instructors'' is implemented by [[Class: I2CE_FormField_STRING_MLINE |STRING_MLINE ]]
| |
| ===start_date===
| |
| The form field ''start_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
| |
| ===end_date===
| |
| The form field ''end_date'' is implemented by [[Class: I2CE_FormField_DATE_YMD |DATE_YMD ]]
| |
| ===location===
| |
| The form field ''location'' is implemented by [[Class: I2CE_FormField_MAP |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 [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)
| |
| *Parameters:
| |
| **$node
| |
| **$template
| |
| **$args
| |
| ===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)
| |
| *Parameters:
| |
| **$node
| |
| **$template
| |
| ===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)
| |
| *Parameters:
| |
| **$node
| |
| **$template
| |
| ===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()
| |
| ===getScheduledCourses()===
| |
| 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)
| |
| *Parameters:
| |
| ** integer $course_id <br/>Defaults to zero meaning we get all courses
| |
| ***Default Value: 0
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $flat <br/>defaults to false
| |
| ***Default Value: false
| |
| *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()===
| |
| *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()
| |
| ===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)
| |
| *Parameters:
| |
| **$node
| |
| **$template
| |
| ===validate()===
| |
| 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()
| |
| ==Inherited Methods==
| |
| ===componentizeQuery()===
| |
| This public method is inherited from [[Class: I2CE_List#componentizeQuery() | I2CE_List->componentizeQuery()]]
| |
| | |
| ===createDataTree()===
| |
| This public method is inherited from [[Class: I2CE_List#createDataTree() | I2CE_List->createDataTree()]]
| |
| | |
| ===flattenDataTree()===
| |
| This public method is inherited from [[Class: I2CE_List#flattenDataTree() | I2CE_List->flattenDataTree()]]
| |
| | |
| ===getDisplayFields()===
| |
| This public method is inherited from [[Class: I2CE_List#getDisplayFields() | I2CE_List->getDisplayFields()]]
| |
| | |
| ===getExtendedDisplay()===
| |
| This public method is inherited from [[Class: I2CE_List#getExtendedDisplay() | I2CE_List->getExtendedDisplay()]]
| |
| | |
| ===getHTMLTemplate()===
| |
| This public method is inherited from [[Class: I2CE_List#getHTMLTemplate() | I2CE_List->getHTMLTemplate()]]
| |
| | |
| ===getListType()===
| |
| This public method is inherited from [[Class: I2CE_List#getListType() | I2CE_List->getListType()]]
| |
| | |
| ===getSortFields()===
| |
| This public method is inherited from [[Class: I2CE_List#getSortFields() | I2CE_List->getSortFields()]]
| |
| | |
| ===listOptions()===
| |
| This public method is inherited from [[Class: I2CE_List#listOptions() | I2CE_List->listOptions()]]
| |
| | |
| ===lookup()===
| |
| This public method is inherited from [[Class: I2CE_List#lookup() | I2CE_List->lookup()]]
| |
| | |
| ===monsterMash()===
| |
| This public method is inherited from [[Class: I2CE_List#monsterMash() | I2CE_List->monsterMash()]]
| |
| | |
| ===name()===
| |
| This public method is inherited from [[Class: I2CE_List#name() | I2CE_List->name()]]
| |
| | |
| ===setDisplayData()===
| |
| This public method is inherited from [[Class: I2CE_List#setDisplayData() | I2CE_List->setDisplayData()]]
| |
| | |
| ===walkupFieldPath()===
| |
| This public method is inherited from [[Class: I2CE_List#walkupFieldPath() | I2CE_List->walkupFieldPath()]]
| |
| | |
| ===_flattenDataTree()===
| |
| This protected method is inherited from [[Class: I2CE_List#_flattenDataTree() | I2CE_List->_flattenDataTree()]]
| |
| | |
| ===_monsterMash()===
| |
| This protected method is inherited from [[Class: I2CE_List#_monsterMash() | I2CE_List->_monsterMash()]]
| |
| | |
| ===addCache()===
| |
| This protected method is inherited from [[Class: I2CE_List#addCache() | I2CE_List->addCache()]]
| |
| | |
| ===getCache()===
| |
| This protected method is inherited from [[Class: I2CE_List#getCache() | I2CE_List->getCache()]]
| |
| | |
| ===isCached()===
| |
| This protected method is inherited from [[Class: I2CE_List#isCached() | I2CE_List->isCached()]]
| |
| | |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_Form#__construct() | I2CE_Form->__construct()]]
| |
| | |
| ===addChildForm()===
| |
| This public method is inherited from [[Class: I2CE_Form#addChildForm() | I2CE_Form->addChildForm()]]
| |
| | |
| ===addField()===
| |
| This public method is inherited from [[Class: I2CE_Form#addField() | I2CE_Form->addField()]]
| |
| | |
| ===cleanup()===
| |
| This public method is inherited from [[Class: I2CE_Form#cleanup() | I2CE_Form->cleanup()]]
| |
| | |
| ===clearFields()===
| |
| This public method is inherited from [[Class: I2CE_Form#clearFields() | I2CE_Form->clearFields()]]
| |
| | |
| ===current()===
| |
| This public method is inherited from [[Class: I2CE_Form#current() | I2CE_Form->current()]]
| |
| | |
| ===displayField()===
| |
| This public method is inherited from [[Class: I2CE_Form#displayField() | I2CE_Form->displayField()]]
| |
| | |
| ===form()===
| |
| This public method is inherited from [[Class: I2CE_Form#form() | I2CE_Form->form()]]
| |
| | |
| ===getAllowedParentForms()===
| |
| This public method is inherited from [[Class: I2CE_Form#getAllowedParentForms() | I2CE_Form->getAllowedParentForms()]]
| |
| | |
| ===getAttribute()===
| |
| This public method is inherited from [[Class: I2CE_Form#getAttribute() | I2CE_Form->getAttribute()]]
| |
| | |
| ===getChildForms()===
| |
| This public method is inherited from [[Class: I2CE_Form#getChildForms() | I2CE_Form->getChildForms()]]
| |
| | |
| ===getChildFormsByForm()===
| |
| This public method is inherited from [[Class: I2CE_Form#getChildFormsByForm() | I2CE_Form->getChildFormsByForm()]]
| |
| | |
| ===getChildren()===
| |
| This public method is inherited from [[Class: I2CE_Form#getChildren() | I2CE_Form->getChildren()]]
| |
| | |
| ===getDisplayName()===
| |
| This public method is inherited from [[Class: I2CE_Form#getDisplayName() | I2CE_Form->getDisplayName()]]
| |
| | |
| ===getField()===
| |
| This public method is inherited from [[Class: I2CE_Form#getField() | I2CE_Form->getField()]]
| |
| | |
| ===getFieldNames()===
| |
| This public method is inherited from [[Class: I2CE_Form#getFieldNames() | I2CE_Form->getFieldNames()]]
| |
| | |
| ===getFormId()===
| |
| This public method is inherited from [[Class: I2CE_Form#getFormId() | I2CE_Form->getFormId()]]
| |
| | |
| ===getHTMLName()===
| |
| This public method is inherited from [[Class: I2CE_Form#getHTMLName() | I2CE_Form->getHTMLName()]]
| |
| | |
| ===getId()===
| |
| This public method is inherited from [[Class: I2CE_Form#getId() | I2CE_Form->getId()]]
| |
| | |
| ===getParent()===
| |
| This public method is inherited from [[Class: I2CE_Form#getParent() | I2CE_Form->getParent()]]
| |
| | |
| ===getParentForm()===
| |
| This public method is inherited from [[Class: I2CE_Form#getParentForm() | I2CE_Form->getParentForm()]]
| |
| | |
| ===getParentID()===
| |
| This public method is inherited from [[Class: I2CE_Form#getParentID() | I2CE_Form->getParentID()]]
| |
| | |
| ===getQueryDisplay()===
| |
| This public method is inherited from [[Class: I2CE_Form#getQueryDisplay() | I2CE_Form->getQueryDisplay()]]
| |
| | |
| ===getQueryFields()===
| |
| This public method is inherited from [[Class: I2CE_Form#getQueryFields() | I2CE_Form->getQueryFields()]]
| |
| | |
| ===getQueryString()===
| |
| This public method is inherited from [[Class: I2CE_Form#getQueryString() | I2CE_Form->getQueryString()]]
| |
| | |
| ===hasAttribute()===
| |
| This public method is inherited from [[Class: I2CE_Form#hasAttribute() | I2CE_Form->hasAttribute()]]
| |
| | |
| ===hasInvalid()===
| |
| This public method is inherited from [[Class: I2CE_Form#hasInvalid() | I2CE_Form->hasInvalid()]]
| |
| | |
| ===key()===
| |
| This public method is inherited from [[Class: I2CE_Form#key() | I2CE_Form->key()]]
| |
| | |
| ===listFields()===
| |
| This public method is inherited from [[Class: I2CE_Form#listFields() | I2CE_Form->listFields()]]
| |
| | |
| ===load()===
| |
| This public method is inherited from [[Class: I2CE_Form#load() | I2CE_Form->load()]]
| |
| | |
| ===next()===
| |
| This public method is inherited from [[Class: I2CE_Form#next() | I2CE_Form->next()]]
| |
| | |
| ===processDOM()===
| |
| This public method is inherited from [[Class: I2CE_Form#processDOM() | I2CE_Form->processDOM()]]
| |
| | |
| ===removeField()===
| |
| This public method is inherited from [[Class: I2CE_Form#removeField() | I2CE_Form->removeField()]]
| |
| | |
| ===reset()===
| |
| This public method is inherited from [[Class: I2CE_Form#reset() | I2CE_Form->reset()]]
| |
| | |
| ===rewind()===
| |
| This public method is inherited from [[Class: I2CE_Form#rewind() | I2CE_Form->rewind()]]
| |
| | |
| ===search()===
| |
| This public method is inherited from [[Class: I2CE_Form#search() | I2CE_Form->search()]]
| |
| | |
| ===setAttribute()===
| |
| This public method is inherited from [[Class: I2CE_Form#setAttribute() | I2CE_Form->setAttribute()]]
| |
| | |
| ===setDisplayName()===
| |
| This public method is inherited from [[Class: I2CE_Form#setDisplayName() | I2CE_Form->setDisplayName()]]
| |
| | |
| ===setForm()===
| |
| This public method is inherited from [[Class: I2CE_Form#setForm() | I2CE_Form->setForm()]]
| |
| | |
| ===setFromPost()===
| |
| This public method is inherited from [[Class: I2CE_Form#setFromPost() | I2CE_Form->setFromPost()]]
| |
| | |
| ===setId()===
| |
| This public method is inherited from [[Class: I2CE_Form#setId() | I2CE_Form->setId()]]
| |
| | |
| ===setParent()===
| |
| This public method is inherited from [[Class: I2CE_Form#setParent() | I2CE_Form->setParent()]]
| |
| | |
| ===valid()===
| |
| This public method is inherited from [[Class: I2CE_Form#valid() | I2CE_Form->valid()]]
| |
| | |
| ===__get()===
| |
| This protected method is inherited from [[Class: I2CE_Form#__get() | I2CE_Form->__get()]]
| |
| | |
| ===__isset()===
| |
| This protected method is inherited from [[Class: I2CE_Form#__isset() | I2CE_Form->__isset()]]
| |
| | |
| ===__set()===
| |
| This protected method is inherited from [[Class: I2CE_Form#__set() | I2CE_Form->__set()]]
| |
| | |
| ===__unset()===
| |
| This protected method is inherited from [[Class: I2CE_Form#__unset() | I2CE_Form->__unset()]]
| |
| | |
| ===addFormFields()===
| |
| This protected method is inherited from [[Class: I2CE_Form#addFormFields() | I2CE_Form->addFormFields()]]
| |
| | |
| ===getFormFieldsData()===
| |
| This protected method is inherited from [[Class: I2CE_Form#getFormFieldsData() | I2CE_Form->getFormFieldsData()]]
| |
| | |
| ===lookupArray()===
| |
| This protected method is inherited from [[Class: I2CE_Form#lookupArray() | I2CE_Form->lookupArray()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Variables==
| |
| ===$cache===
| |
| Theis protected variable is inherited from [[Class: I2CE_List#$cache | I2CE_List->$cache]]
| |
| | |
| ===$children===
| |
| Theis public variable is inherited from [[Class: I2CE_Form#$children | I2CE_Form->$children]]
| |
| | |
| ===$fields===
| |
| Theis protected variable is inherited from [[Class: I2CE_Form#$fields | I2CE_Form->$fields]]
| |
| | |
| ===$parent===
| |
| Theis protected variable is inherited from [[Class: I2CE_Form#$parent | I2CE_Form->$parent]]
| |
| | |
| ===$id===
| |
| Theis protected variable is inherited from [[Class: I2CE_Form#$id | I2CE_Form->$id]]
| |
| | |
| ===$attributes===
| |
| Theis protected variable is inherited from [[Class: I2CE_Form#$attributes | I2CE_Form->$attributes]]
| |
| | |
| ===$parent_forms===
| |
| Theis protected variable is inherited from [[Class: I2CE_Form#$parent_forms | I2CE_Form->$parent_forms]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===isNumeric()===
| |
| This method is inherited from [[Class: I2CE_Form#isNumeric() | I2CE_Form->isNumeric()]]
| |
| | |
| ===getLimitStyles()===
| |
| This method is inherited from [[Class: I2CE_Form#getLimitStyles() | I2CE_Form->getLimitStyles()]]
| |
| | |
| ===checkLimit()===
| |
| This method is inherited from [[Class: I2CE_Form#checkLimit() | I2CE_Form->checkLimit()]]
| |
| | |
| ===checkWhereClause()===
| |
| This method is inherited from [[Class: I2CE_Form#checkWhereClause() | I2CE_Form->checkWhereClause()]]
| |
| | |
| ===createCheckFunction()===
| |
| This method is inherited from [[Class: I2CE_Form#createCheckFunction() | I2CE_Form->createCheckFunction()]]
| |
| | |
| ===createCheckLimitString()===
| |
| This method is inherited from [[Class: I2CE_Form#createCheckLimitString() | I2CE_Form->createCheckLimitString()]]
| |
| | |
| ===generateLimit()===
| |
| This method is inherited from [[Class: I2CE_Form#generateLimit() | I2CE_Form->generateLimit()]]
| |
| | |
| ===generateWhereClause()===
| |
| This method is inherited from [[Class: I2CE_Form#generateWhereClause() | I2CE_Form->generateWhereClause()]]
| |
| | |
| ===processLimit()===
| |
| This method is inherited from [[Class: I2CE_Form#processLimit() | I2CE_Form->processLimit()]]
| |
| | |
| ===getDisplayedExistingLimit()===
| |
| This method is inherited from [[Class: I2CE_Form#getDisplayedExistingLimit() | I2CE_Form->getDisplayedExistingLimit()]]
| |
| | |
| ===isComponentized()===
| |
| This method is inherited from [[Class: I2CE_Form#isComponentized() | I2CE_Form->isComponentized()]]
| |
| | |
| ===addChild()===
| |
| This method is inherited from [[Class: I2CE_Form#addChild() | I2CE_Form->addChild()]]
| |
| | |
| ===getChildIds()===
| |
| This method is inherited from [[Class: I2CE_Form#getChildIds() | I2CE_Form->getChildIds()]]
| |
| | |
| ===getStorage()===
| |
| This method is inherited from [[Class: I2CE_Form#getStorage() | I2CE_Form->getStorage()]]
| |
| | |
| ===isWritable()===
| |
| This method is inherited from [[Class: I2CE_Form#isWritable() | I2CE_Form->isWritable()]]
| |
| | |
| ===populate()===
| |
| This method is inherited from [[Class: I2CE_Form#populate() | I2CE_Form->populate()]]
| |
| | |
| ===populateChild()===
| |
| This method is inherited from [[Class: I2CE_Form#populateChild() | I2CE_Form->populateChild()]]
| |
| | |
| ===populateChildren()===
| |
| This method is inherited from [[Class: I2CE_Form#populateChildren() | I2CE_Form->populateChildren()]]
| |
| | |
| ===populateFirst()===
| |
| This method is inherited from [[Class: I2CE_Form#populateFirst() | I2CE_Form->populateFirst()]]
| |
| | |
| ===populateHistory()===
| |
| This method is inherited from [[Class: I2CE_Form#populateHistory() | I2CE_Form->populateHistory()]]
| |
| | |
| ===populateLast()===
| |
| This method is inherited from [[Class: I2CE_Form#populateLast() | I2CE_Form->populateLast()]]
| |
| | |
| ===delete()===
| |
| This method is inherited from [[Class: I2CE_Form#delete() | I2CE_Form->delete()]]
| |
| | |
| ===save()===
| |
| This method is inherited from [[Class: I2CE_Form#save() | I2CE_Form->save()]]
| |
| | |
| ===setChangeType()===
| |
| This method is inherited from [[Class: I2CE_Form#setChangeType() | I2CE_Form->setChangeType()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
