Manager
Class Manager
Table of Contents
Methods
- canUse() : bool
- Return true if can use role access.
- clearMenuCache() : void
- Clean menu cache.
- deleteRole() : void
- Deletes role and all dependent records.
- getAccessList() : Result
- Get access list.
- getRoleList() : Result
- Get role list.
- getRolePermissions() : array<string|int, mixed>
- Get role permissions.
- getTrialText() : bool
- Return true if can use role access.
- installRoles() : void
- Install roles.
- installRolesAgent() : string
- Install roles.
- setAccessCodes() : AddResult
- Set access codes.
- setRolePermissions() : AddResult|UpdateResult
- Set role permissions. Add or update role
Methods
canUse()
Return true if can use role access.
public
static canUse() : bool
Return values
boolclearMenuCache()
Clean menu cache.
public
static clearMenuCache() : void
deleteRole()
Deletes role and all dependent records.
public
static deleteRole(int $roleId) : void
Parameters
- $roleId : int
-
Id of the role.
getAccessList()
Get access list.
public
static getAccessList([array<string|int, mixed> $parameters = [] ]) : Result
Parameters
- $parameters : array<string|int, mixed> = []
-
Parameters.
Return values
ResultgetRoleList()
Get role list.
public
static getRoleList([array<string|int, mixed> $parameters = [] ]) : Result
Parameters
- $parameters : array<string|int, mixed> = []
-
Parameters.
Return values
ResultgetRolePermissions()
Get role permissions.
public
static getRolePermissions(int $roleId) : array<string|int, mixed>
Parameters
- $roleId : int
-
Role ID.
Return values
array<string|int, mixed>getTrialText()
Return true if can use role access.
public
static getTrialText() : bool
Return values
boolinstallRoles()
Install roles.
public
static installRoles() : void
installRolesAgent()
Install roles.
public
static installRolesAgent() : string
Return values
stringsetAccessCodes()
Set access codes.
public
static setAccessCodes([array<string|int, mixed> $list = [] ]) : AddResult
Parameters
- $list : array<string|int, mixed> = []
-
List.
Return values
AddResultsetRolePermissions()
Set role permissions. Add or update role
public
static setRolePermissions([int|null $roleId = null ][, array<string|int, mixed> $roleFields = [] ], array<string|int, mixed> $permissions) : AddResult|UpdateResult
Parameters
- $roleId : int|null = null
-
Role ID.
- $roleFields : array<string|int, mixed> = []
-
Role fields.
- $permissions : array<string|int, mixed>
-
Permissions.