Class: iHRIS Scheduled Training Course

From IHRIS Wiki
Revision as of 16:06, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'This article desrcibes the class '''iHRIS_Scheduled_Training_Course'''which extends the class I2CE_List It is contained in the module [[iHRIS Module List#t…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article desrcibes the class iHRIS_Scheduled_Training_Coursewhich extends the class I2CE_List It is contained in the module training-course in the package iHRIS Common The class is defined in the file: modules/TrainingCourse/lib/iHRIS_Scheduled_Training_Course.php iHRIS_Scheduled_Training_Course @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org>

@version 2.1 @access public

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)
  • Returns: array the keys are the id of the scheduled course, the values are the string "$start_date -- $end_date"

Parameters:

  • integer $course_id
    Defaults to zero meaning we get all courses
    • Default Value: 0
  • boolean $flat
    defaults to false
    • Default Value: false

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()