AccessRoleWriteService
in
Interface AccessRoleWriteService
Table of Contents
- createAccessRole() : AccessRole
- Creates a new access role based on the provided names, descriptions, sort order and protection status.
- deleteAccessRoles() : void
- Deletes all access roles based on the provided role IDs.
- storeAccessRoles() : AccessRoleIds
- Stores (creates or updates) all provided access roles and returns their role IDs.
Methods
createAccessRole()
Creates a new access role based on the provided names, descriptions, sort order and protection status.
public
createAccessRole(array<int, string> $names, array<int, string> $descriptions, int $sortOrder[, bool $isProtected = false ]) : AccessRole
The provided names and description arrays need to map language ID (key) and name or description (value).
Parameters
- $names : array<int, string>
- $descriptions : array<int, string>
- $sortOrder : int
- $isProtected : bool = false
Return values
AccessRole —deleteAccessRoles()
Deletes all access roles based on the provided role IDs.
public
deleteAccessRoles(array<string|int, int> ...$roleIds) : void
Parameters
- $roleIds : array<string|int, int>
Tags
Return values
void —storeAccessRoles()
Stores (creates or updates) all provided access roles and returns their role IDs.
public
storeAccessRoles(AccessRole ...$roles) : AccessRoleIds
Parameters
- $roles : AccessRole