BristolSU\Support\Permissions\PermissionStore Class Reference

Inheritance diagram for BristolSU\Support\Permissions\PermissionStore:

Collaboration diagram for BristolSU\Support\Permissions\PermissionStore:

Public Member Functions
	registerSitePermission (string $ability, string $name, string $description)
	registerPermission (Permission $permission)
	registerModulePermission (string $ability, string $name, string $description, string $alias, bool $admin=false)
	register (string $ability, string $name, string $description, string $alias, bool $admin=false)
	get (string $ability)
	all ()

Private Attributes
	$permissions = []

Detailed Description

Store all permissions in an array

Definition at line 11 of file PermissionStore.php.

Member Function Documentation

all()

BristolSU\Support\Permissions\PermissionStore::all

(

)

Get all registered permissions

Returns

Permission[]

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 110 of file PermissionStore.php.

References BristolSU\Support\Permissions\PermissionStore\$permissions.

get()

BristolSU\Support\Permissions\PermissionStore::get

(

string

$ability

)

Get a permission by ability

Parameters

string

$ability

Ability of the permission

Returns

Permission Permission with the given ability

Exceptions

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 97 of file PermissionStore.php.

register()

BristolSU\Support\Permissions\PermissionStore::register	(	string	$ability,
		string	$name,
		string	$description,
		string	$alias,
		bool	$admin = false
	)

Register a permission for a module

Parameters

string	$ability	Ability of the permission
string	$name	Name for the permission
string	$description	Description for the permission
string	$alias	Alias of the module registering the permission
bool	$admin	If the permission is an admin permission $admin is true, or false for a participant permission

Returns

void

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 85 of file PermissionStore.php.

References BristolSU\Support\Permissions\PermissionStore\registerModulePermission().

registerModulePermission()

BristolSU\Support\Permissions\PermissionStore::registerModulePermission	(	string	$ability,
		string	$name,
		string	$description,
		string	$alias,
		bool	$admin = false
	)

Register a permission for a module

Parameters

string	$ability	Ability of the permission
string	$name	Name for the permission
string	$description	Description for the permission
string	$alias	Alias of the module registering the permission
bool	$admin	If the permission is an admin permission $admin is true, or false for a participant permission

Returns

void

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 62 of file PermissionStore.php.

References BristolSU\Support\Permissions\PermissionStore\registerPermission().

Referenced by BristolSU\Support\Permissions\PermissionStore\register().

registerPermission()

BristolSU\Support\Permissions\PermissionStore::registerPermission

(

Permission

$permission

)

Register a permission model

Parameters

Permission

$permission

Permission model to register

Returns

void

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 47 of file PermissionStore.php.

References BristolSU\Support\Permissions\Contracts\Models\Permission\getAbility().

Referenced by BristolSU\Support\Permissions\PermissionStore\registerModulePermission(), and BristolSU\Support\Permissions\PermissionStore\registerSitePermission().

registerSitePermission()

BristolSU\Support\Permissions\PermissionStore::registerSitePermission	(	string	$ability,
		string	$name,
		string	$description
	)

Register a new site permission

Parameters

string	$ability	Ability of the permission
string	$name	Name for the permission
string	$description	Description of the permission

Returns

void

Implements BristolSU\Support\Permissions\Contracts\PermissionStore.

Definition at line 30 of file PermissionStore.php.

References BristolSU\Support\Permissions\PermissionStore\registerPermission().

Member Data Documentation

$permissions

BristolSU\Support\Permissions\PermissionStore::$permissions = []

private

Definition at line 19 of file PermissionStore.php.

Referenced by BristolSU\Support\Permissions\PermissionStore\all().

---

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

• src/Permissions/PermissionStore.php