TimedAdmission Class Reference

Inheritance diagram for TimedAdmission:

Collaboration diagram for TimedAdmission:

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()

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

Standard constructor

Parameters

String

ruleId

Reimplemented from AdmissionRule.

Here is the call graph for this function:

Member Function Documentation

delete()

delete

(

)

Deletes the admission rule and all associated data.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

getDescription()

static getDescription ( )

static

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

Reimplemented from AdmissionRule.

getEndTime()

getEndTime

(

)

Gets the end of course admission.

Returns

int

Reimplemented from AdmissionRule.

getName()

static getName ( )

static

Return this rule's name.

Reimplemented from AdmissionRule.

getStartTime()

getStartTime

(

)

Gets the start of course admission.

Returns

int

Reimplemented from AdmissionRule.

getTemplate()

getTemplate

(

)

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

Returns

String

Reimplemented from AdmissionRule.

load()

load

(

)

Helper function for loading rule definition from database.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

Here is the caller graph for this function:

ruleApplies()

ruleApplies	(		$userId,
			$courseId
	)

Is admission allowed according to the defined time frame?

Parameters

String	userId
String	courseId

Returns

Array

Reimplemented from AdmissionRule.

Here is the call graph for this function:

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.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

setEndTime()

setEndTime

(

$newEndTime

)

Sets a new end timestamp for course admission.

Parameters

int	newEndTime

Returns

TimedAdmission

Reimplemented from AdmissionRule.

Here is the caller graph for this function:

setStartTime()

setStartTime

(

$newStartTime

)

Sets a new start timestamp for course admission.

Parameters

int	newStartTime

Returns

TimedAdmission

Reimplemented from AdmissionRule.

Here is the caller graph for this function:

store()

store

(

)

Store rule definition to database.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

toString()

toString

(

)

A textual description of the current rule.

Returns

String

Reimplemented from AdmissionRule.

validate()

validate

(

$data

)

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

Parameters

Array

Request data

Returns

Array Error messages.

Reimplemented from AdmissionRule.

Field Documentation

$endTime

$endTime = 0

End of course admission.

$startTime

$startTime = 0

Start of course admission.

---

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

• lib/admissionrules/timedadmission/TimedAdmission.class.php