Properties
Methods
Parameters
Name |
Type |
Default value |
Description |
$innerService
|
RoleService
|
-
|
-
|
Adds a new policy to the RoleDraft.
Parameters
Return values
RoleDraft
Assigns a role to the given user.
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
$user
|
User
|
-
|
-
|
$roleLimitation
|
RoleLimitation
|
null
|
an optional role limitation (which is either a subtree limitation or section limitation)
|
Assigns a role to the given user group.
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
$userGroup
|
UserGroup
|
-
|
-
|
$roleLimitation
|
RoleLimitation
|
null
|
an optional role limitation (which is either a subtree limitation or section limitation)
|
Copies an existing Role.
Parameters
Return values
Role
Returns the number of users and user groups assigned to this role.
|
public countRoleAssignments(Role $role) : int
|
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
Return values
int
Creates a new RoleDraft.
Parameters
Return values
RoleDraft
Creates a new RoleDraft for existing Role.
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
Return values
RoleDraft
Deletes the given role.
|
public deleteRole(Role $role) : void
|
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
Deletes the given RoleDraft.
|
public deleteRoleDraft(RoleDraft $roleDraft) : void
|
Parameters
Name |
Type |
Default value |
Description |
$roleDraft
|
RoleDraft
|
-
|
-
|
Returns the LimitationType registered with the given identifier.
|
public getLimitationType(string $identifier) : Type
|
Parameters
Name |
Type |
Default value |
Description |
$identifier
|
string
|
-
|
-
|
Return values
Type
Returns the LimitationType's assigned to a given module/function.
|
public getLimitationTypesByModuleFunction(string $module, string $function) : array<string|int, Type>
|
Typically used for:
- Internal validation limitation value use on Policies
- Role admin gui for editing policy limitations incl list limitation options via valueSchema()
Parameters
Name |
Type |
Default value |
Description |
$module
|
string
|
-
|
Legacy name of "controller", it's a unique identifier like "content"
|
$function
|
string
|
-
|
Legacy name of a controller "action", it's a unique within the controller like "read"
|
Return values
array<string|int, Type>
Returns the assigned user and user groups to this role.
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
Return values
array<string|int, RoleAssignment>
Returns UserRoleAssignments assigned to the given User, excluding the ones the current user is not allowed to read.
If second parameter $inherited is true then UserGroupRoleAssignment is also returned for UserGroups User is
placed in as well as those inherited from parent UserGroups.
Parameters
Name |
Type |
Default value |
Description |
$user
|
User
|
-
|
-
|
$inherited
|
bool
|
false
|
Also return all inherited Roles from UserGroups User belongs to, and it's parents.
|
Return values
array<string|int, UserRoleAssignment>|array<string|int, UserGroupRoleAssignment>
Returns the UserGroupRoleAssignments assigned to the given UserGroup, excluding the ones the current user is not allowed to read.
Parameters
Name |
Type |
Default value |
Description |
$userGroup
|
UserGroup
|
-
|
-
|
Return values
array<string|int, UserGroupRoleAssignment>
Loads a role for the given id.
|
public loadRole(int $id) : Role
|
Parameters
Name |
Type |
Default value |
Description |
$id
|
int
|
-
|
-
|
Return values
Role
Loads a role assignment for the given id.
Parameters
Name |
Type |
Default value |
Description |
$roleAssignmentId
|
int
|
-
|
-
|
Return values
RoleAssignment
Returns the assigned users and user groups to this role with $offset and $limit arguments.
|
public loadRoleAssignments(Role $role[, int $offset = 0 ][, int|null $limit = null ]) : array<string|int, RoleAssignment>
|
Parameters
Name |
Type |
Default value |
Description |
$role
|
Role
|
-
|
-
|
$offset
|
int
|
0
|
-
|
$limit
|
int|null
|
null
|
-
|
Return values
array<string|int, RoleAssignment>
Loads a role for the given identifier.
|
public loadRoleByIdentifier(string $identifier) : Role
|
Parameters
Name |
Type |
Default value |
Description |
$identifier
|
string
|
-
|
-
|
Return values
Role
Loads a RoleDraft for the given id.
Parameters
Name |
Type |
Default value |
Description |
$id
|
int
|
-
|
-
|
Return values
RoleDraft
Loads a RoleDraft by the ID of the role it was created from.
|
public loadRoleDraftByRoleId(int $roleId) : RoleDraft
|
Parameters
Name |
Type |
Default value |
Description |
$roleId
|
int
|
-
|
ID of the role the draft was created from.
|
Return values
RoleDraft
Loads all roles, excluding the ones the current user is not allowed to read.
|
public loadRoles() : array<string|int, Role>
|
Return values
array<string|int, Role>
Instantiates a policy create class.
Parameters
Name |
Type |
Default value |
Description |
$module
|
string
|
-
|
-
|
$function
|
string
|
-
|
-
|
Return values
PolicyCreateStruct
Instantiates a policy update class.
Return values
PolicyUpdateStruct
Instantiates a role copy struct.
Parameters
Name |
Type |
Default value |
Description |
$name
|
string
|
-
|
-
|
Return values
RoleCopyStruct
Instantiates a role create class.
Parameters
Name |
Type |
Default value |
Description |
$name
|
string
|
-
|
-
|
Return values
RoleCreateStruct
Instantiates a policy update class.
Return values
RoleUpdateStruct
Publishes the given RoleDraft.
|
public publishRoleDraft(RoleDraft $roleDraft) : void
|
Parameters
Name |
Type |
Default value |
Description |
$roleDraft
|
RoleDraft
|
-
|
-
|
Removes a policy from a RoleDraft.
Parameters
Name |
Type |
Default value |
Description |
$roleDraft
|
RoleDraft
|
-
|
-
|
$policyDraft
|
PolicyDraft
|
-
|
the policy to remove from the RoleDraft
|
Return values
RoleDraft
Removes the given role assignment.
i.e. unassigns a user or a user group from a role with the given limitations
Parameters
Name |
Type |
Default value |
Description |
$roleAssignment
|
RoleAssignment
|
-
|
-
|
Updates the limitations of a policy. The module and function cannot be changed and
the limitations are replaced by the ones in $roleUpdateStruct.
Parameters
Return values
PolicyDraft
Updates the properties of a RoleDraft.
Parameters
Return values
RoleDraft