Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
TimedAdmission Class Reference
Inheritance diagram for TimedAdmission:
AdmissionRule

Public Member Functions

 __construct ($ruleId='', $courseSetId= '')
 
 delete ()
 
 getEndTime ()
 
 getStartTime ()
 
 getTemplate ()
 
 load ()
 
 ruleApplies ($userId, $courseId)
 
 setAllData ($data)
 
 setEndTime ($newEndTime)
 
 setStartTime ($newStartTime)
 
 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

 $endTime = 0
 
 $startTime = 0
 
- Data Fields inherited from AdmissionRule
 $endTime = 0
 
 $id = ''
 
 $message = ''
 
 $default_message = ''
 
 $startTime = 0
 
 $courseSetId = ''
 
 $siblings = []
 
 $siblings_override = false
 

Constructor & Destructor Documentation

__construct (   $ruleId = '',
  $courseSetId = '' 
)

Standard constructor

Parameters
StringruleId

Member Function Documentation

delete ( )

Deletes the admission rule and all associated data.

static getDescription ( )
static

Gets some text that describes what this AdmissionRule (or respective subclass) does.

getEndTime ( )

Gets the end of course admission.

Returns
int
static getName ( )
static

Return this rule's name.

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 (   $userId,
  $courseId 
)

Is admission allowed according to the defined time frame?

Parameters
StringuserId
StringcourseId
Returns
Array
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.
setEndTime (   $newEndTime)

Sets a new end timestamp for course admission.

Parameters
intnewEndTime
Returns
TimedAdmission
setStartTime (   $newStartTime)

Sets a new start timestamp for course admission.

Parameters
intnewStartTime
Returns
TimedAdmission
store ( )

Store rule definition to database.

toString ( )

A textual description of the current rule.

Returns
String
validate (   $data)

Validates if the given request data is sufficient to configure this rule (e.g. if required values are present).

Parameters
ArrayRequest data
Returns
Array Error messages.

Field Documentation

$endTime = 0

End of course admission.

$startTime = 0

Start of course admission.


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