AccessGroupWriteService
in package
implements
AccessGroupWriteService
Class AccessGroupWriteService
Interfaces, Classes and Traits
- AccessGroupWriteService
- Interface AccessGroupWriteService
Table of Contents
- $factory : AccessGroupFactory
- $repository : AccessGroupRepository
- __construct() : mixed
- GroupService constructor.
- 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.
Properties
$factory
private
AccessGroupFactory
$factory
$repository
private
AccessGroupRepository
$repository
Methods
__construct()
GroupService constructor.
public
__construct(AccessGroupRepository $repository, AccessGroupFactory $factory) : mixed
Parameters
- $repository : AccessGroupRepository
- $factory : AccessGroupFactory
Return values
mixed —createAccessGroup()
Creates a new access group based on the provided names, descriptions, sort order and protection status.
public
createAccessGroup(array<string|int, mixed> $names, array<string|int, mixed> $descriptions, int $sortOrder[, bool $isProtected = false ][, int|null $parentGroupId = null ]) : AccessGroup
Parameters
- $names : array<string|int, mixed>
- $descriptions : array<string|int, mixed>
- $sortOrder : int
- $isProtected : bool = false
- $parentGroupId : int|null = null
-
Provide null, if there is no parent group.
Tags
Return values
AccessGroup —deleteAccessGroups()
Deletes all access groups based on the provided group IDs.
public
deleteAccessGroups(int ...$groupIds) : void
Parameters
- $groupIds : 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