Class: iHRIS Scheduled Training Course

From IHRIS Wiki
Revision as of 12:41, 19 October 2009 by Litlfred (talk | contribs)

This article describes the class iHRIS_Scheduled_Training_Course.

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

  • 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
  • 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: