PasswordAdmission Class Reference

Inheritance diagram for PasswordAdmission:

Collaboration 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
	afterSeatDistribution (&$courseset)
	checkTimeFrame ()
	generateId ($tableName)
	getAffectedUsers ()
	getEndTime ()
	getId ()
	getMessage ()
	getStartTime ()
	beforeSeatDistribution (&$courseset)
	setEndTime ($newEndTime)
	setMessage ($newMessage)
	setStartTime ($newStartTime)
	__toString ()
	isCombinationAllowed ($admission_rule)

Static Public Member Functions
static	getDescription ()
static	getName ()
Static Public Member Functions inherited from AdmissionRule
static	getAvailableAdmissionRules ($activeOnly=true)
static	getInputFrame ()

Data Fields
	$hasher = null
	$password = ''
	$allowed_combinations = array('ConditionalAdmission','TimedAdmission')
Data Fields inherited from AdmissionRule
	$endTime = 0
	$id = ''
	$message = ''
	$default_message = ''
	$startTime = 0
	$courseSetId = ''
	$allowed_combinations = array()

Constructor & Destructor Documentation

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

Standard constructor.

Parameters

String

ruleId

Reimplemented from AdmissionRule.

Here is the call graph for this function:

Member Function Documentation

delete

(

)

Deletes the admission rule and all associated data.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

static getDescription ( )

static

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

Reimplemented from AdmissionRule.

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.

Reimplemented from AdmissionRule.

static getName ( )

static

Return this rule's name.

Reimplemented from AdmissionRule.

getPassword

(

)

Gets the bcrypted hash of the current password.

Returns

String

Here is the caller graph for this function:

getTemplate

(

)

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

Returns

String

Reimplemented from AdmissionRule.

load

(

)

Internal 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	(		$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

Boolean

Reimplemented from AdmissionRule.

Here is the call graph for this function:

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:

setPassword

(

$clearText

)

Sets the password by bcrypting the given clear text password.

Parameters

String

$clearText

The clear text password to be set.

Returns

PasswordAdmission

Here is the caller graph for this function:

store

(

)

Helper function for storing data to DB.

Reimplemented from AdmissionRule.

Here is the call graph for this function:

toString

(

)

A textual description of the current rule.

Returns

String

Reimplemented from AdmissionRule.

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

$allowed_combinations = array('ConditionalAdmission','TimedAdmission')

$hasher = null

$password = ''

---

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

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