RoleServiceDecorator

RoleServiceDecorator.php : 26 Copy path

Abstract

Implements RoleService

Properties¶

$innerService ¶

RoleServiceDecorator.php : 28 Copy path

protected RoleService $innerService

Methods¶

__construct() ¶

RoleServiceDecorator.php : 30 Copy path

public __construct(RoleService $innerService)

Parameters

Name	Type	Default value	Description
$innerService	RoleService	-	-

addPolicyByRoleDraft() ¶

RoleServiceDecorator.php : 69 Copy path

Adds a new policy to the RoleDraft.

public addPolicyByRoleDraft(RoleDraft $roleDraft, PolicyCreateStruct $policyCreateStruct) : RoleDraft

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-
$policyCreateStruct	PolicyCreateStruct	-	-

Return values

RoleDraft

assignRoleToUser() ¶

RoleServiceDecorator.php : 129 Copy path

Assigns a role to the given user.

public assignRoleToUser(Role $role, User $user[, RoleLimitation|null $roleLimitation = null ]) : void

Parameters

Name	Type	Default value	Description
$role	Role	-	-
$user	User	-	-
$roleLimitation	RoleLimitation\|null	null	an optional role limitation (which is either a subtree limitation or section limitation)

assignRoleToUserGroup() ¶

RoleServiceDecorator.php : 121 Copy path

Assigns a role to the given user group.

public assignRoleToUserGroup(Role $role, UserGroup $userGroup[, RoleLimitation|null $roleLimitation = null ]) : void

Parameters

Name	Type	Default value	Description
$role	Role	-	-
$userGroup	UserGroup	-	-
$roleLimitation	RoleLimitation\|null	null	an optional role limitation (which is either a subtree limitation or section limitation)

copyRole() ¶

RoleServiceDecorator.php : 45 Copy path

Copies an existing Role.

public copyRole(Role $role, RoleCopyStruct $roleCopyStruct) : Role

Parameters

Name	Type	Default value	Description
$role	Role	-	-
$roleCopyStruct	RoleCopyStruct	-	-

Return values

Role

countRoleAssignments() ¶

RoleServiceDecorator.php : 152 Copy path

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

createRole() ¶

RoleServiceDecorator.php : 35 Copy path

Creates a new RoleDraft.

public createRole(RoleCreateStruct $roleCreateStruct) : RoleDraft

Parameters

Name	Type	Default value	Description
$roleCreateStruct	RoleCreateStruct	-	-

Return values

RoleDraft

createRoleDraft() ¶

RoleServiceDecorator.php : 40 Copy path

Creates a new RoleDraft for existing Role.

public createRoleDraft(Role $role) : RoleDraft

Parameters

Name	Type	Default value	Description
$role	Role	-	-

Return values

RoleDraft

deleteRole() ¶

RoleServiceDecorator.php : 116 Copy path

Deletes the given role.

public deleteRole(Role $role) : void

Parameters

Name	Type	Default value	Description
$role	Role	-	-

deleteRoleDraft() ¶

RoleServiceDecorator.php : 91 Copy path

Deletes the given RoleDraft.

public deleteRoleDraft(RoleDraft $roleDraft) : void

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-

getLimitationType() ¶

RoleServiceDecorator.php : 201 Copy path

Returns the LimitationType registered with the given identifier.

public getLimitationType(string $identifier) : Type

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

Type

getLimitationTypesByModuleFunction() ¶

RoleServiceDecorator.php : 206 Copy path

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>

getRoleAssignments() ¶

RoleServiceDecorator.php : 142 Copy path

Returns the assigned user and user groups to this role.

public getRoleAssignments(Role $role) : array<string|int, RoleAssignment>

Parameters

Name	Type	Default value	Description
$role	Role	-	-

Return values

array<string|int, RoleAssignment>

getRoleAssignmentsForUser() ¶

RoleServiceDecorator.php : 157 Copy path

Returns UserRoleAssignments assigned to the given User, excluding the ones the current user is not allowed to read.

public getRoleAssignmentsForUser(User $user[, bool $inherited = false ]) : array<string|int, UserRoleAssignment>|array<string|int, UserGroupRoleAssignment>

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>

getRoleAssignmentsForUserGroup() ¶

RoleServiceDecorator.php : 164 Copy path

Returns the UserGroupRoleAssignments assigned to the given UserGroup, excluding the ones the current user is not allowed to read.

public getRoleAssignmentsForUserGroup(UserGroup $userGroup) : array<string|int, UserGroupRoleAssignment>

Parameters

Name	Type	Default value	Description
$userGroup	UserGroup	-	-

Return values

array<string|int, UserGroupRoleAssignment>

loadRole() ¶

RoleServiceDecorator.php : 101 Copy path

Loads a role for the given id.

public loadRole(int $id) : Role

Parameters

Name	Type	Default value	Description
$id	int	-	-

Return values

Role

loadRoleAssignment() ¶

RoleServiceDecorator.php : 137 Copy path

Loads a role assignment for the given id.

public loadRoleAssignment(int $roleAssignmentId) : RoleAssignment

Parameters

Name	Type	Default value	Description
$roleAssignmentId	int	-	-

Return values

RoleAssignment

loadRoleAssignments() ¶

RoleServiceDecorator.php : 147 Copy path

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>

loadRoleByIdentifier() ¶

RoleServiceDecorator.php : 106 Copy path

Loads a role for the given identifier.

public loadRoleByIdentifier(string $identifier) : Role

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

Role

loadRoleDraft() ¶

RoleServiceDecorator.php : 52 Copy path

Loads a RoleDraft for the given id.

public loadRoleDraft(int $id) : RoleDraft

Parameters

Name	Type	Default value	Description
$id	int	-	-

Return values

RoleDraft

loadRoleDraftByRoleId() ¶

RoleServiceDecorator.php : 57 Copy path

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

loadRoles() ¶

RoleServiceDecorator.php : 111 Copy path

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>

newPolicyCreateStruct() ¶

RoleServiceDecorator.php : 184 Copy path

Instantiates a policy create class.

public newPolicyCreateStruct(string $module, string $function) : PolicyCreateStruct

Parameters

Name	Type	Default value	Description
$module	string	-	-
$function	string	-	-

Return values

PolicyCreateStruct

newPolicyUpdateStruct() ¶

RoleServiceDecorator.php : 191 Copy path

Instantiates a policy update class.

public newPolicyUpdateStruct() : PolicyUpdateStruct

Return values

PolicyUpdateStruct

newRoleCopyStruct() ¶

RoleServiceDecorator.php : 179 Copy path

Instantiates a role copy struct.

public newRoleCopyStruct(string $name) : RoleCopyStruct

Parameters

Name	Type	Default value	Description
$name	string	-	-

Return values

RoleCopyStruct

newRoleCreateStruct() ¶

RoleServiceDecorator.php : 174 Copy path

Instantiates a role create class.

public newRoleCreateStruct(string $name) : RoleCreateStruct

Parameters

Name	Type	Default value	Description
$name	string	-	-

Return values

RoleCreateStruct

newRoleUpdateStruct() ¶

RoleServiceDecorator.php : 196 Copy path

Instantiates a policy update class.

public newRoleUpdateStruct() : RoleUpdateStruct

Return values

RoleUpdateStruct

publishRoleDraft() ¶

RoleServiceDecorator.php : 96 Copy path

Publishes the given RoleDraft.

public publishRoleDraft(RoleDraft $roleDraft) : void

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-

removePolicyByRoleDraft() ¶

RoleServiceDecorator.php : 76 Copy path

Removes a policy from a RoleDraft.

public removePolicyByRoleDraft(RoleDraft $roleDraft, PolicyDraft $policyDraft) : RoleDraft

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-
$policyDraft	PolicyDraft	-	the policy to remove from the RoleDraft

Return values

RoleDraft

removeRoleAssignment() ¶

RoleServiceDecorator.php : 169 Copy path

Removes the given role assignment.

public removeRoleAssignment(RoleAssignment $roleAssignment) : void

i.e. unassigns a user or a user group from a role with the given limitations

Parameters

Name	Type	Default value	Description
$roleAssignment	RoleAssignment	-	-

updatePolicyByRoleDraft() ¶

RoleServiceDecorator.php : 83 Copy path

Updates the limitations of a policy. The module and function cannot be changed and the limitations are replaced by the ones in $roleUpdateStruct.

public updatePolicyByRoleDraft(RoleDraft $roleDraft, PolicyDraft $policy, PolicyUpdateStruct $policyUpdateStruct) : PolicyDraft

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-
$policy	PolicyDraft	-	-
$policyUpdateStruct	PolicyUpdateStruct	-	-

Return values

PolicyDraft

updateRoleDraft() ¶

RoleServiceDecorator.php : 62 Copy path

Updates the properties of a RoleDraft.

public updateRoleDraft(RoleDraft $roleDraft, RoleUpdateStruct $roleUpdateStruct) : RoleDraft

Parameters

Name	Type	Default value	Description
$roleDraft	RoleDraft	-	-
$roleUpdateStruct	RoleUpdateStruct	-	-

Return values

RoleDraft