AccessGroupWriteService
in
Interface AccessGroupWriteService
Table of Contents
- createAccessGroup() : AccessGroup
- Creates a new access group based on the provided names, descriptions, sort order and protection status.
- deleteAccessGroups() : void
- Deletes all access groups based on the provided group IDs.
- storeAccessGroups() : AccessGroupIds
- Stores (updates) all provided access groups and returns their group IDs.
Methods
createAccessGroup()
Creates a new access group based on the provided names, descriptions, sort order and protection status.
public
createAccessGroup(array<int, string> $names, array<int, string> $descriptions, int $sortOrder[, bool $isProtected = false ][, int|null $parentGroupId = null ]) : AccessGroup
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
- $parentGroupId : int|null = null
-
Provide null, if there is no parent group.
Return values
AccessGroup —deleteAccessGroups()
Deletes all access groups based on the provided group IDs.
public
deleteAccessGroups(array<string|int, int> ...$groupIds) : void
Parameters
- $groupIds : array<string|int, int>
Tags
Return values
void —storeAccessGroups()
Stores (updates) all provided access groups and returns their group IDs.
public
storeAccessGroups(AccessGroup ...$groups) : AccessGroupIds
Parameters
- $groups : AccessGroup