phpDocumentor

AccessGroupReadService implements AccessGroupReadService

Class AccessGroupReadService

Interfaces, Classes and Traits

AccessGroupReadService
Interface AccessGroupReadService

Table of Contents

UNKNOWN_ITEM_DESCRIPTOR  = 'unknown-admin-access-item'
$factory  : AccessGroupFactory
$repository  : AccessGroupRepository
__construct()  : mixed
GroupService constructor.
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.

Constants

Properties

Methods

findAccessGroupByTypeAndDescriptor()

Returns the best-matching access group based on the provided group item type and descriptor.

public findAccessGroupByTypeAndDescriptor(string $type, string $descriptor) : AccessGroup
Parameters
$type : string
$descriptor : string
Tags
inheritDoc
note

If this logic needs to be extended, e.g. for another type, then it should be refactored and some strategy pattern (or so) should be implemented. Currently I would assume, that this logic would become simpler, because the types PAGE, CONTROLLER, and AJAX_HANDLER will be removed.

Return values
AccessGroup

getAccessGroupById()

Returns a specific access group based on the provided group ID.

public getAccessGroupById(int $groupId) : AccessGroup
Parameters
$groupId : int
Tags
inheritDoc
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
inheritDoc
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
Tags
inheritDoc
Return values
AccessGroup

Search results