EnrolmentInformation Class Reference

Inheritance diagram for EnrolmentInformation:

Public Member Functions
	__construct (string $message, int $type=Information::INFO, string $codeword='', bool $enrolment_allowed=false)
	setEnrolmentAllowed (bool $enrolment_allowed)
	isEnrolmentAllowed ()
Public Member Functions inherited from Information
	__construct (string $message='', int $type=Information::INFO, string $codeword='', ?\Range $range=null)
	getMessage ()
	setMessage (string $message)
	getType ()
	setType (int $type)
	getCodeword ()
	setCodeword (string $codeword)
	getRange ()
	setRange (\Range $range)
	__toString ()
	toMessageBox (bool $verbose=false)

Protected Attributes
bool	$enrolment_allowed = false
Protected Attributes inherited from Information
int	$type = Information::INFO
string	$codeword
string	$message
Range	$range = null

Additional Inherited Members
Data Fields inherited from Information
const	INFO = 0
const	WARNING = 1
const	ERROR = 2

Detailed Description

The EnrolmentInformation class holds information regarding the ability of a user to enrol into a specific course.

Constructor & Destructor Documentation

__construct()

__construct	(	string	$message,
		int	$type = Information::INFO,
		string	$codeword = '',
		bool	$enrolment_allowed = false
	)

Member Function Documentation

isEnrolmentAllowed()

isEnrolmentAllowed

(

)

The getter for the enrolment_allowed attribute.

Returns

bool The status of the enrolment_allowed attribute.

setEnrolmentAllowed()

setEnrolmentAllowed

(

bool

$enrolment_allowed

)

The setter for the enrolment_allowed attribute.

Parameters

bool

$enrolment_allowed

The new status for the enrolment_allowed attribute.

Returns

void

Field Documentation

$enrolment_allowed

bool $enrolment_allowed = false

protected

---

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

• lib/classes/EnrolmentInformation.php