BristolSU\Support\Authorization\Exception\ModuleInactive Class Reference

Inheritance diagram for BristolSU\Support\Authorization\Exception\ModuleInactive:

Collaboration diagram for BristolSU\Support\Authorization\Exception\ModuleInactive:

Public Member Functions
	__construct ($message="", $code=0, Throwable $previous=null, $moduleInstance=null)
	getModuleInstance ()

Static Public Member Functions
static	createWithModuleInstance (ModuleInstance $moduleInstance, string $message='', int $code=0)

Private Attributes
	$moduleInstance

Detailed Description

Fired if the module is inactive

Definition at line 12 of file ModuleInactive.php.

Constructor & Destructor Documentation

__construct()

BristolSU\Support\Authorization\Exception\ModuleInactive::__construct	(		$message = "",
			$code = 0,
		Throwable	$previous = null,
			$moduleInstance = null
	)

Initialise the exception

Parameters

string	$message	Message for the exception
int	$code	Status code
Throwable | null	$previous	Previous exception
ModuleInstance	$moduleInstance	ModuleInstance that was accessed

Definition at line 29 of file ModuleInactive.php.

References BristolSU\Support\Authorization\Exception\ModuleInactive\$moduleInstance.

Member Function Documentation

createWithModuleInstance()

static BristolSU\Support\Authorization\Exception\ModuleInactive::createWithModuleInstance ( ModuleInstance  $moduleInstance, string  $message = '', int  $code = 0  )

static

Create the exception with a given moduleInstance

Parameters

ModuleInstance	$moduleInstance	ModuleInstance that was accessed
string	$message	Message for the exception
int	$code	Status code

Returns

ModuleInactive

Definition at line 44 of file ModuleInactive.php.

References BristolSU\Support\Authorization\Exception\ModuleInactive\$moduleInstance.

getModuleInstance()

BristolSU\Support\Authorization\Exception\ModuleInactive::getModuleInstance

(

)

Get the module instance

Returns

ModuleInstance

Definition at line 54 of file ModuleInactive.php.

References BristolSU\Support\Authorization\Exception\ModuleInactive\$moduleInstance.

Member Data Documentation

$moduleInstance

BristolSU\Support\Authorization\Exception\ModuleInactive::$moduleInstance

private

Definition at line 19 of file ModuleInactive.php.

Referenced by BristolSU\Support\Authorization\Exception\ModuleInactive\__construct(), BristolSU\Support\Authorization\Exception\ModuleInactive\createWithModuleInstance(), and BristolSU\Support\Authorization\Exception\ModuleInactive\getModuleInstance().

---

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

• src/Authorization/Exception/ModuleInactive.php