CourseMemberAdmission Class Reference

Inheritance diagram for CourseMemberAdmission:

Collaboration diagram for CourseMemberAdmission:

Public Member Functions
	__construct ($ruleId='', $courseSetId='')
	delete ()
	getTemplate ()
	load ()
	ruleApplies ($userId, $courseId)
	setAllData ($data)
	store ()
	toString ()
	validate ($data)
	getMessage ($course=null)
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
	$mandatory_course_id = ''
	$modus = ''
	$default_message1 = ''
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

Here is the call graph for this function:

Member Function Documentation

delete()

delete

(

)

Deletes the admission rule and all associated data.

Here is the call graph for this function:

getDescription()

static getDescription ( )

static

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

getMessage()

getMessage

(

$course = null

)

getName()

static getName ( )

static

Return this rule's name.

getTemplate()

getTemplate

(

)

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

Returns

String

Here is the call graph for this function:

load()

load

(

)

Helper function for loading rule definition from database.

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

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.

store()

store

(

)

Store rule definition to database.

Here is the call graph for this function:

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

Request data

Returns

Array Error messages.

Field Documentation

$default_message1

$default_message1 = ''

$mandatory_course_id

$mandatory_course_id = ''

End of course admission.

$modus

$modus = ''

---

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

• lib/admissionrules/coursememberadmission/CourseMemberAdmission.class.php