API Documentation
Back to top  

AdminAccessGroupReaderInterface

Extends

Interface AdminAccessGroupReaderInterface

category

System
package

AdminAccess
subpackage

Readers

Methods

Returns an AdminAccessGroupCollection with all existing AdminAccessGroup objects.

getAll() : \AdminAccessGroupCollection

Response

\AdminAccessGroupCollection

Group collection with all available groups.

Returns an AdminAccessGroup instance by the given ajax handler identifier.

getByAjaxHandler(\NonEmptyStringType $identifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$identifier

\NonEmptyStringType

Identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given group identifier.

getByController(\NonEmptyStringType $controllerIdentifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$controllerIdentifier

\NonEmptyStringType

Controller identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given AccessGroup ID.

getById(\IdType $groupId) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$groupId

\IdType

Group ID.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given group identifier.

getByPage(\NonEmptyStringType $pageIdentifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$pageIdentifier

\NonEmptyStringType

Page Identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroupCollection instance with all child groups for the given group ID.

getChildren(\IdType $groupId) : \AdminAccessGroupCollection

Arguments

$groupId

\IdType

Group ID.

Response

\AdminAccessGroupCollection

Group collection.