◆ __construct()
__construct |
( |
|
$ruleId = '' , |
|
|
|
$courseSetId = '' |
|
) |
| |
Standard constructor
- Parameters
-
◆ delete()
Deletes the admission rule and all associated data.
◆ getDescription()
static getDescription |
( |
| ) |
|
|
static |
Gets some text that describes what this AdmissionRule (or respective subclass) does.
◆ getEndTime()
Gets the end of course admission.
- Returns
- int
◆ getName()
◆ getStartTime()
Gets the start of course admission.
- Returns
- int
◆ getTemplate()
Gets the template that provides a configuration GUI for this rule.
- Returns
- String
◆ 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()
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
-
- Returns
- AdmissionRule This object.
◆ setEndTime()
setEndTime |
( |
|
$newEndTime | ) |
|
Sets a new end timestamp for course admission.
- Parameters
-
- Returns
- TimedAdmission
◆ setStartTime()
setStartTime |
( |
|
$newStartTime | ) |
|
Sets a new start timestamp for course admission.
- Parameters
-
- Returns
- TimedAdmission
◆ store()
Store rule definition to database.
◆ toString()
A textual description of the current rule.
- Returns
- String
◆ validate()
Validates if the given request data is sufficient to configure this rule (e.g. if required values are present).
- Parameters
-
- Returns
- Array Error messages.
◆ $endTime
◆ $startTime
Start of course admission.
The documentation for this class was generated from the following file: