CourseMemberAdmission Class Reference
Inheritance diagram for CourseMemberAdmission:
Public Member Functions | |
| __construct ($ruleId='', $courseSetId='') | |
| delete () | |
| getTemplate () | |
| load () | |
| ruleApplies ($userId, $courseId) | |
| setAllData ($data) | |
| store () | |
| toString () | |
| validate ($data) | |
| getMessage ($course=null) | |
| getValidityPeriod () | |
 Public Member Functions inherited from AdmissionRule | |
| __construct ($ruleId='', $courseSetId='') | |
| afterSeatDistribution ($courseset) | |
| checkTimeFrame () | |
| delete () | |
| generateId ($tableName) | |
| getAffectedUsers () | |
| getEndTime () | |
| getInput () | |
| getId () | |
| getMessage () | |
| getStartTime () | |
| getTemplate () | |
| load () | |
| beforeSeatDistribution ($courseset) | |
| ruleApplies ($userId, $courseId) | |
| setAllData ($data) | |
| setEndTime ($newEndTime) | |
| setMessage ($newMessage) | |
| setStartTime ($newStartTime) | |
| store () | |
| toString () | |
| validate ($data) | |
| __toString () | |
| loadSiblings () | |
| getSiblings () | |
| setSiblings ($siblings=[]) | |
| isCombinationAllowed ($admission_rule) | |
| __clone () | |
Static Public Member Functions | |
| static | getDescription () |
| static | getName () |
| Static Public Member Functions inherited from AdmissionRule | |
| static | getAvailableAdmissionRules ($activeOnly=true) |
| static | getInputFrame () |
| static | getDescription () |
| static | getName () |
Data Fields | |
| const | MODE_MUST_BE_IN_COURSES = 0 |
| const | MODE_MAY_NOT_BE_IN_COURSES = 1 |
| $courses_to_add = '[]' | |
| $modus = '' | |
| Data Fields inherited from AdmissionRule | |
| $endTime = 0 | |
| $id = '' | |
| $message = '' | |
| $default_message = '' | |
| $startTime = 0 | |
| $courseSetId = '' | |
| $siblings = [] | |
| $siblings_override = false | |
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $ruleId = '', |
|
$courseSetId = '' |
|||
| ) |
Standard constructor
- Parameters
-
String $ruleId String e
Member Function Documentation
◆ delete()
| delete | ( | ) |
Deletes the admission rule and all associated data.
◆ getDescription()
|
static |
Gets some text that describes what this AdmissionRule (or respective subclass) does.
◆ getMessage()
| getMessage | ( | $course = null | ) |
◆ getName()
|
static |
Return this rule's name.
◆ getTemplate()
| getTemplate | ( | ) |
Gets the template that provides a configuration GUI for this rule.
- Returns
- String
◆ getValidityPeriod()
| getValidityPeriod | ( | ) |
◆ load()
| load | ( | ) |
Helper function for loading rule definition from database.
◆ ruleApplies()
| ruleApplies | ( | $userId, | |
| $courseId | |||
| ) |
Is admission allowed according to the defined time frame?
- Parameters
-
String $userId String $courseId
- Returns
- Array
◆ setAllData()
| setAllData | ( | $data | ) |
Uses the given data to fill the object values. This can be used as a generic function for storing data if the concrete rule type isn't known in advance.
- Parameters
-
Array $data
- Returns
- AdmissionRule This object.
◆ store()
| store | ( | ) |
Store rule definition to database.
◆ toString()
| toString | ( | ) |
A textual description of the current rule.
- Returns
- String
◆ validate()
| validate | ( | $data | ) |
Validates if the given request data is sufficient to configure this rule (e.g. if required values are present).
- Parameters
-
Array $data Request data
- Returns
- Array Error messages.
Field Documentation
◆ $courses_to_add
| $courses_to_add = '[]' |
End of course admission.
◆ $modus
| $modus = '' |
◆ MODE_MAY_NOT_BE_IN_COURSES
| const MODE_MAY_NOT_BE_IN_COURSES = 1 |
◆ MODE_MUST_BE_IN_COURSES
| const MODE_MUST_BE_IN_COURSES = 0 |
The documentation for this class was generated from the following file:
- lib/admissionrules/coursememberadmission/CourseMemberAdmission.php
