Public Member Functions | |
| __construct ($ruleId='', $courseSetId='') | |
| isFCFSallowed () | |
| delete () | |
| getDistributionTime () | |
| getTemplate () | |
| load () | |
| setAllData ($data) | |
| setDistributionTime ($newDistributionTime) | |
| store () | |
| toString () | |
| validate ($data) | |
 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 | |
| $distributionTime = null | |
| $first_come_first_served_allowed = false | |
| $minimum_timespan_to_distribution_time = 120 | |
| $prio_exists = false | |
| 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 $courseSetId
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.
◆ getDistributionTime()
| getDistributionTime | ( | ) |
Gets the time for seat distribution algorithm.
- Returns
- int
◆ getName()
|
static |
Return this rule's name.
◆ getTemplate()
| getTemplate | ( | ) |
Gets the template that provides a configuration GUI for this rule.
- Returns
- String
◆ isFCFSallowed()
| isFCFSallowed | ( | ) |
◆ load()
| load | ( | ) |
Helper function for loading rule definition from database.
◆ 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.
◆ setDistributionTime()
| setDistributionTime | ( | $newDistributionTime | ) |
Sets a new timestamp for seat distribution algorithm execution.
- Parameters
-
int $newDistributionTime
◆ 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
◆ $distributionTime
| $distributionTime = null |
Timestamp for execution of seat distribution algorithm
◆ $first_come_first_served_allowed
| $first_come_first_served_allowed = false |
◆ $minimum_timespan_to_distribution_time
| $minimum_timespan_to_distribution_time = 120 |
◆ $prio_exists
| $prio_exists = false |
The documentation for this class was generated from the following file:
- lib/admissionrules/participantrestrictedadmission/ParticipantRestrictedAdmission.class.php
