1. trait
  2. Xpressengine
  3. Permission
  4. PermissionSupport

PermissionSupport

trait PermissionSupport

Methods

array
getPermArguments(string $key, array|string $abilities, string $siteKey = 'default')

Get permission argument

void
permissionRegister(Request $request, string $key, array|string $abilities, string $siteKey = 'default')

Register permission

void
permissionRegisterGrant(string $key, Grant $grant = null, string $siteKey = 'default')

Register grant to permission

void
permissionUnregister(string $key, string $siteKey = 'default')

Unregister permission

void
permissionMove(string $from, string $to, string $siteKey = 'default')

Move

array|null
makeGrantData(Request $request, string $ability)

Make data for grant

Details

at line 36
array getPermArguments(string $key, array|string $abilities, string $siteKey = 'default')

Get permission argument

Parameters

string $key permission key
array|string $abilities abilities
string $siteKey site key

Return Value

array

at line 73
void permissionRegister(Request $request, string $key, array|string $abilities, string $siteKey = 'default')

Register permission

Parameters

Request $request request instance
string $key permission key
array|string $abilities abilities
string $siteKey site key

Return Value

void

at line 95
void permissionRegisterGrant(string $key, Grant $grant = null, string $siteKey = 'default')

Register grant to permission

Parameters

string $key permission key
Grant $grant grant object
string $siteKey site key

Return Value

void

at line 109
void permissionUnregister(string $key, string $siteKey = 'default')

Unregister permission

Parameters

string $key permission key
string $siteKey site key

Return Value

void

at line 122
void permissionMove(string $from, string $to, string $siteKey = 'default')

Move

Parameters

string $from previous key
string $to parent key
string $siteKey site key

Return Value

void

at line 135
protected array|null makeGrantData(Request $request, string $ability)

Make data for grant

Parameters

Request $request request instance
string $ability ability

Return Value

array|null