Class: iHRIS Scheduled Training Course: Difference between revisions
No edit summary |
No edit summary |
||
| Line 15: | Line 15: | ||
===enrolledStudents()=== | ===enrolledStudents()=== | ||
*Signature: public function enrolledStudents($node,$template,$args) | *Signature: public function enrolledStudents($node,$template,$args) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
*$template | *$template | ||
| Line 21: | Line 21: | ||
===enrolledStudentsExpander()=== | ===enrolledStudentsExpander()=== | ||
*Signature: public function enrolledStudentsExpander($node,$template) | *Signature: public function enrolledStudentsExpander($node,$template) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
*$template | *$template | ||
===enrolledStudentsList()=== | ===enrolledStudentsList()=== | ||
*Signature: public function enrolledStudentsList($node,$template) | *Signature: public function enrolledStudentsList($node,$template) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
*$template | *$template | ||
| Line 34: | Line 34: | ||
Return the list of scheduled course for the given course id. | Return the list of scheduled course for the given course id. | ||
*Signature: static public function getScheduledCourses($course_id,$flat) | *Signature: static public function getScheduledCourses($course_id,$flat) | ||
* | *Parameters: | ||
Parameters: | ** integer $course_id <br/>Defaults to zero meaning we get all courses | ||
* integer $course_id<br/>Defaults to zero meaning we get all courses | ***Default Value: 0 | ||
**Default Value: 0 | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $flat <br/>defaults to false | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $flat<br/>defaults to false | ***Default Value: 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()=== | ===getScheduledStudentIds()=== | ||
*Signature: public function getScheduledStudentIds() | *Signature: public function getScheduledStudentIds() | ||
===numberEnrolledStudents()=== | ===numberEnrolledStudents()=== | ||
*Signature: public function numberEnrolledStudents($node,$template) | *Signature: public function numberEnrolledStudents($node,$template) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
*$template | *$template | ||
| Line 50: | Line 50: | ||
Perform any extra validation for the license. | Perform any extra validation for the license. | ||
*Signature: public function validate($page) | *Signature: public function validate($page) | ||
Parameters: | *Parameters: | ||
* [[Class: I2CE_Template | I2CE_Template]] &$page | ** [[Class: I2CE_Template | I2CE_Template]] &$page | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$cache=== | ===$cache=== | ||
Revision as of 23:43, 16 October 2009
This article desrcibes 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
- Author: Carl Leitner <litlfred@ibiblio.org>
iHRIS_Scheduled_Training_Course
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()
- Signature: public function enrolledStudents($node,$template,$args)
- Parameters:
- $node
- $template
- $args
enrolledStudentsExpander()
- Signature: public function enrolledStudentsExpander($node,$template)
- Parameters:
- $node
- $template
enrolledStudentsList()
- Signature: public function enrolledStudentsList($node,$template)
- Parameters:
- $node
- $template
getEnrolledStudents()
- Signature: public function getEnrolledStudents()
getScheduledCourses()
Return the list of scheduled course for the given course id.
- 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()
- Signature: public function getScheduledStudentIds()
numberEnrolledStudents()
- Signature: public function numberEnrolledStudents($node,$template)
- Parameters:
- $node
- $template
validate()
Perform any extra validation for the license.
- Signature: public function validate($page)
- Parameters:
- I2CE_Template &$page
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()
