BristolSU\Support\Permissions\Contracts\PermissionStore Interface Reference

Inheritance diagram for BristolSU\Support\Permissions\Contracts\PermissionStore:

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

Detailed Description

Register and retrieve permissions

Definition at line 12 of file PermissionStore.php.

Member Function Documentation

all()

BristolSU\Support\Permissions\Contracts\PermissionStore::all

(

)

Get all registered permissions

Returns

Permission[]

Implemented in BristolSU\Support\Permissions\PermissionStore.

get()

BristolSU\Support\Permissions\Contracts\PermissionStore::get

(

string

$ability

)

Get a permission by its ability string

Parameters

string

$ability

Ability string of the permission

Returns

Permission Permission with the given ability string

Implemented in BristolSU\Support\Permissions\PermissionStore.

register()

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

Register a module permission.

Alias of the registerModulePermission function

Parameters

string	$ability	Ability of the permission
string	$name	Name of the permission
string	$description	Description of the permission
string	$alias	Alias of the module registering the permission
bool	$admin	Is the permission an admin permission? Defaults to false

Implemented in BristolSU\Support\Permissions\PermissionStore.

registerModulePermission()

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

Register a module permission.

Parameters

string	$ability	Ability of the permission
string	$name	Name of the permission
string	$description	Description of the permission
string	$alias	Alias of the module registering the permission
bool	$admin	Is the permission an admin permission? Defaults to false

Implemented in BristolSU\Support\Permissions\PermissionStore.

registerPermission()

BristolSU\Support\Permissions\Contracts\PermissionStore::registerPermission

(

Permission

$permission

)

Register a permission class

Parameters

Permission

$permission

Permission to register

Implemented in BristolSU\Support\Permissions\PermissionStore.

registerSitePermission()

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

Register a global site permission

Parameters

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

Implemented in BristolSU\Support\Permissions\PermissionStore.

---

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

• src/Permissions/Contracts/PermissionStore.php