AccessGroupReadService
in
Interface AccessGroupReadService
Table of Contents
- findAccessGroupByTypeAndDescriptor() : AccessGroup
- Returns the best-matching access group based on the provided group item type and descriptor.
- getAccessGroupById() : AccessGroup
- Returns a specific access group based on the provided group ID.
- getAccessGroupByTypeAndDescriptor() : AccessGroup
- Returns a specific access group based on the provided group item type and descriptor.
- getAccessGroupForUnknownItemsByType() : AccessGroup
- Returns a the access group for unknown items based on the provided group item type.
- getAccessGroups() : AccessGroups
- Returns all available access groups.
Methods
findAccessGroupByTypeAndDescriptor()
Returns the best-matching access group based on the provided group item type and descriptor.
public
findAccessGroupByTypeAndDescriptor(string $type, string $descriptor) : AccessGroup
If there is no group for a specific route or controller (e.g. /admin/route/specific or controller/action),
then it's possible that a group will be returned, which belongs to a more generic route or controller
(e.g. /admin/route or controller).
If absolutely no group matches, this service will return the group for unknown items.
Parameters
- $type : string
- $descriptor : string
Return values
AccessGroup —getAccessGroupById()
Returns a specific access group based on the provided group ID.
public
getAccessGroupById(int $groupId) : AccessGroup
Parameters
- $groupId : int
Tags
Return values
AccessGroup —getAccessGroupByTypeAndDescriptor()
Returns a specific access group based on the provided group item type and descriptor.
public
getAccessGroupByTypeAndDescriptor(string $type, string $descriptor) : AccessGroup
Parameters
- $type : string
- $descriptor : string
Tags
Return values
AccessGroup —getAccessGroupForUnknownItemsByType()
Returns a the access group for unknown items based on the provided group item type.
public
getAccessGroupForUnknownItemsByType(string $type) : AccessGroup
Parameters
- $type : string
Return values
AccessGroup —getAccessGroups()
Returns all available access groups.
public
getAccessGroups() : AccessGroups