Role
Table of Contents
Methods
- enable() : PublicActionResult
- Switch on/off role model.
- getList() : PublicActionResult
- Gets available roles.
- getRights() : PublicActionResult
- Gets rights for each site in this role.
- init() : PublicActionResult
- Check feature enabled and if current user is admin.
- isEnabled() : PublicActionResult
- Return true if role model is switch on.
- setAccessCodes() : PublicActionResult
- Set new access codes for role and refresh all rights.
- setRights() : PublicActionResult
- Set rights for role.
Methods
enable()
Switch on/off role model.
public
static enable(bool $mode) : PublicActionResult
Parameters
- $mode : bool
-
Mode: on/off.
Return values
PublicActionResultgetList()
Gets available roles.
public
static getList() : PublicActionResult
Return values
PublicActionResultgetRights()
Gets rights for each site in this role.
public
static getRights(int $id) : PublicActionResult
Parameters
- $id : int
-
Role id.
Return values
PublicActionResultinit()
Check feature enabled and if current user is admin.
public
static init() : PublicActionResult
Return values
PublicActionResultisEnabled()
Return true if role model is switch on.
public
static isEnabled() : PublicActionResult
Return values
PublicActionResultsetAccessCodes()
Set new access codes for role and refresh all rights.
public
static setAccessCodes(int $id[, array<string|int, mixed> $codes = array() ]) : PublicActionResult
Parameters
- $id : int
-
Role id.
- $codes : array<string|int, mixed> = array()
-
Codes array.
Return values
PublicActionResultsetRights()
Set rights for role.
public
static setRights(int $id, array<string|int, mixed> $rights[, array<string|int, mixed> $additional = null ]) : PublicActionResult
Parameters
- $id : int
-
Role id.
- $rights : array<string|int, mixed>
-
Rights array ([[site_id] => [right1, right2]].
- $additional : array<string|int, mixed> = null
-
Addition rights array ([Rights::ADDITIONAL_RIGHTS]].