Stud.IP  5.4
LockedAdmission Class Reference
Inheritance diagram for LockedAdmission:
AdmissionRule

Public Member Functions

 __construct ($ruleId='', $courseSetId='')
 
 delete ()
 
 getTemplate ()
 
 load ()
 
 ruleApplies ($userId, $courseId)
 
 store ()
 
 toString ()
 
- 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 ()
 

Additional Inherited Members

- 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
StringruleId

Member Function Documentation

◆ delete()

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.

◆ getName()

static getName ( )
static

Return this rule's name.

◆ getTemplate()

getTemplate ( )

Gets the template that provides a configuration GUI for this rule.

Returns
String

◆ load()

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? Never happens here as admission is completely locked.

Parameters
StringuserId
StringcourseId
Returns
Array Any errors that occurred on admission.

◆ store()

store ( )

Helper function for storing data to DB.

◆ toString()

toString ( )

A textual description of the current rule.

Returns
String

The documentation for this class was generated from the following file: