1. class
  2. Xpressengine
  3. Permission
  4. PermissionHandler

PermissionHandler

class PermissionHandler

Class PermissionHandler

Properties

protected PermissionRepository $repo Repository instance

Methods

__construct(PermissionRepository $repo)

PermissionHandler constructor.

Permission|null
get(string $name, string $siteKey = 'default')

Get a permission from repository

Permission|null
getOrNew(string $name, string $siteKey = 'default')

Get a permission from repository or generate when not exists

Permission|null
find(string $name, string $siteKey = 'default')

Get a permission from repository

void
setAncestor(Permission $permission)

Set permission's ancestor to permission

Permission|null
findOrNew(string $name, string $siteKey = 'default')

Get a permission from repository or generate when not exists

Permission
newItem()

Returns new permission instance

Permission
register(string $name, Grant $grant, string $siteKey = 'default')

Register permission information

void
destroy(string $name, string $siteKey = 'default')

Remove from repository

void
loadBranch(string $name, string $siteKey = 'default')

특정 대상이 포함된 하위 권한 정보를 가져와 캐싱 함

void
move(Permission $permission, string|null $to = null)

Move entity hierarchy to new parent or root

Details

at line 44
__construct(PermissionRepository $repo)

PermissionHandler constructor.

Parameters

PermissionRepository $repo repository instance

at line 56
Permission|null get(string $name, string $siteKey = 'default')

Get a permission from repository

Parameters

string $name permission name
string $siteKey site key name

Return Value

Permission|null

at line 72
Permission|null getOrNew(string $name, string $siteKey = 'default')

Get a permission from repository or generate when not exists

Parameters

string $name permission name
string $siteKey site key name

Return Value

Permission|null

at line 94
Permission|null find(string $name, string $siteKey = 'default')

Get a permission from repository

Parameters

string $name permission name
string $siteKey site key name

Return Value

Permission|null

at line 105
protected void setAncestor(Permission $permission)

Set permission's ancestor to permission

Parameters

Permission $permission permission instance

Return Value

void

at line 130
Permission|null findOrNew(string $name, string $siteKey = 'default')

Get a permission from repository or generate when not exists

Parameters

string $name permission name
string $siteKey site key name

Return Value

Permission|null

at line 140
Permission newItem()

Returns new permission instance

Return Value

Permission

at line 153
Permission register(string $name, Grant $grant, string $siteKey = 'default')

Register permission information

Parameters

string $name permission name
Grant $grant grant instance
string $siteKey site key name

Return Value

Permission

at line 180
void destroy(string $name, string $siteKey = 'default')

Remove from repository

Parameters

string $name permission name
string $siteKey site key name

Return Value

void

at line 196
void loadBranch(string $name, string $siteKey = 'default')

특정 대상이 포함된 하위 권한 정보를 가져와 캐싱 함

Parameters

string $name permission name
string $siteKey site key name

Return Value

void

at line 210
void move(Permission $permission, string|null $to = null)

Move entity hierarchy to new parent or root

Parameters

Permission $permission permission instance
string|null $to to prefix

Return Value

void

Exceptions

InvalidArgumentException
NoParentException