PasswordAdmission Class Reference

Inheritance diagram for PasswordAdmission:

Public Member Functions
	__construct ($ruleId='', $courseSetId= '')
	delete ()
	getInput ()
	getPassword ()
	getTemplate ()
	load ()
	ruleApplies ($userId, $courseId)
	setAllData ($data)
	setPassword ($clearText)
	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
	$hasher = null
	$password = ''
	$new = false
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

String

ruleId

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.

getInput

(

)

Shows an input form where the user can enter a password and try to get past the holy gates.

Returns

String A template-based input form.

static getName ( )

static

Return this rule's name.

getPassword

(

)

Gets the bcrypted hash of the current password.

Returns

String

getTemplate

(

)

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

Returns

String

load

(

)

Internal helper function for loading rule definition from database.

ruleApplies	(		$userId,
			$courseId
	)

Does the current rule allow the given user to register as participant in the given course? Here, a given password (via the getInput method) is compared to the stored encrypted one.

Parameters

String	userId
String	courseId

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.

setPassword

(

$clearText

)

Sets the password by bcrypting the given clear text password.

Parameters

String

$clearText

The clear text password to be set.

Returns

PasswordAdmission

store

(

)

Helper function for storing data to DB.

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

Array

Request data

Returns

Array Error messages.

Field Documentation

$hasher = null

$new = false

$password = ''

---

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

• lib/admissionrules/passwordadmission/PasswordAdmission.class.php