BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin Class Reference

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

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

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

Static Public Member Functions
static	createWithActivity (Activity $activity, string $message='', int $code=0)

Private Attributes
	$activity

Detailed Description

Exception to indicate an activity could not be accessed with the current credentials

Definition at line 12 of file ActivityRequiresAdmin.php.

Constructor & Destructor Documentation

__construct()

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

Initialise the exception

Parameters

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

Definition at line 29 of file ActivityRequiresAdmin.php.

References BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\$activity.

Member Function Documentation

createWithActivity()

static BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin::createWithActivity ( Activity  $activity, string  $message = '', int  $code = 0  )

static

Create the exception with a given activity

Parameters

Activity	$activity	Activity that was accessed
string	$message	Message for the exception
int	$code	Status code

Returns

ActivityRequiresAdmin

Definition at line 44 of file ActivityRequiresAdmin.php.

References BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\$activity.

Referenced by BristolSU\Support\Authorization\Middleware\CheckAdminActivityFor\handle().

getActivity()

BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin::getActivity

(

)

Get the activity

Returns

Activity

Definition at line 54 of file ActivityRequiresAdmin.php.

References BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\$activity.

Member Data Documentation

$activity

BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin::$activity

private

Definition at line 19 of file ActivityRequiresAdmin.php.

Referenced by BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\__construct(), BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\createWithActivity(), and BristolSU\Support\Authorization\Exception\ActivityRequiresAdmin\getActivity().

---

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

• src/Authorization/Exception/ActivityRequiresAdmin.php