◆ __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.
◆ getInput()
Shows an input form where the user can enter a password and try to get past the holy gates.
- Returns
- String A template-based input form.
◆ getName()
◆ getPassword()
Gets the bcrypted hash of the current password.
- Returns
- String
◆ getTemplate()
Gets the template that provides a configuration GUI for this rule.
- Returns
- String
◆ load()
Internal helper function for loading rule definition from database.
◆ ruleApplies()
ruleApplies |
( |
|
$userId, |
|
|
|
$courseId |
|
) |
| |
Does the current rule allow the given user to register as participant in the given course? Here, a given password (via the getInput method) is compared to the stored encrypted one.
- 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.
◆ setPassword()
setPassword |
( |
|
$clearText | ) |
|
Sets the password by bcrypting the given clear text password.
- Parameters
-
String | $clearText | The clear text password to be set. |
- Returns
- PasswordAdmission
◆ store()
Helper function for storing data to DB.
◆ 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.
◆ $hasher
◆ $new
◆ $password
The documentation for this class was generated from the following file: