TermsAdmission Class Reference

Inheritance diagram for TermsAdmission:

Public Member Functions
	__construct ($ruleId='', $courseSetId='')
	delete ()
	getInput ()
	ruleApplies ($userId, $courseId)
	setAllData ($data)
	load ()
	store ()
	toString ()
	getPayload ()
Public Member Functions inherited from AdmissionRule
	__construct ($ruleId='', $courseSetId='')
	afterSeatDistribution ($courseset)
	checkTimeFrame ()
	delete ()
	generateId ($tableName)
	getAffectedUsers ()
	getEndTime ()
	getInput ()
	getId ()
	getMessage ()
	getStartTime ()
	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)
	getPayload ()
	__clone ()

Static Public Member Functions
static	getDescription ()
static	getName ()
Static Public Member Functions inherited from AdmissionRule
static	getRule (string $name, ?string $id=null)
static	getInputFrame ()
static	getDescription ()
static	getName ()

Data Fields
	$terms
Data Fields inherited from AdmissionRule
	$endTime = 0
	$id = ''
	$message = ''
	$default_message = ''
	$startTime = 0
	$courseSetId = ''
	$siblings = []
	$siblings_override = false
string	$type = 'php'
string	$component = null

Constructor & Destructor Documentation

__construct()

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

Standard constructor.

Parameters

String

ruleId

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.

getInput()

getInput

(

)

Shows an input form

Returns

string A template-based input form.

Exceptions

Flexi

getName()

static getName ( )

static

Return this rule's name.

getPayload()

getPayload

(

)

Get fields and settings defining this admission rule as array.

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?

Parameters

String	userId
String	courseId

Returns

Array

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.

store()

store

(

)

Store rule definition to database.

toString()

toString

(

)

A textual description of the current rule.

Returns

String

Exceptions

Flexi

Field Documentation

$terms

$terms

---

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

• lib/admissionrules/termsadmission/TermsAdmission.php