Class AdminAccessPermissionManager

AdminAccessPermissionManager implements AdminAccessPermissionManagerInterface

Package: AdminAccess\Managers
Category: System
Located at Services/System/AdminAccess/Managers/AdminAccessPermissionManager.inc.php

Methods summary

`public`	# `__construct( AdminAccessGroupReaderInterface $groupReader, AdminAccessRoleFactoryInterface $roleFactory, AdminAccessUserReaderInterface $userReader, AdminAccessRoleReaderInterface $roleReader )` AdminAccessPermissionManager constructor. AdminAccessPermissionManager constructor. Parameters `$groupReader` Group reader instance. `$roleFactory` Role factory instance. `$userReader` User reader instance. `$roleReader` Role reader instance.
`public boolean`	# `checkDeletingPermissionForController( NonEmptyStringType $identifier, IdType $customerId )` Checks the deleting permission for a controller. Checks the deleting permission for a controller. Parameters `$identifier` The name of a controller to identify an admin access group. `$customerId` ID of a customer to check the permission for. Returns boolean True if customer has a deleting permission for the controller, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkDeletingPermissionForController()`
`public boolean`	# `checkDeletingPermissionForPage( NonEmptyStringType $identifier, IdType $customerId )` Checks the deleting permission for a page. Checks the deleting permission for a page. Parameters `$identifier` The name of a page to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a deleting permission for the page, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkDeletingPermissionForPage()`
`public boolean`	# `checkDeletingPermissionForAjaxHandler( NonEmptyStringType $identifier, IdType $customerId )` Checks the deleting permission for an ajax handler. Checks the deleting permission for an ajax handler. Parameters `$identifier` The name of an ajax handler to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a deleting permission for the ajax handler, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkDeletingPermissionForAjaxHandler()`
`public boolean`	# `checkReadingPermissionForController( NonEmptyStringType $identifier, IdType $customerId )` Checks the reading permission for a controller. Checks the reading permission for a controller. Parameters `$identifier` The name of a controller to identify an admin access group. `$customerId` ID of a customer to check the permission for. Returns boolean True if customer has a reading permission for the controller, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkReadingPermissionForController()`
`public boolean`	# `checkReadingPermissionForPage( NonEmptyStringType $identifier, IdType $customerId )` Checks the reading permission for a page. Checks the reading permission for a page. Parameters `$identifier` The name of a page to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a reading permission for the page, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkReadingPermissionForPage()`
`public boolean`	# `checkReadingPermissionForAjaxHandler( NonEmptyStringType $identifier, IdType $customerId )` Checks the reading permission for an ajax handler. Checks the reading permission for an ajax handler. Parameters `$identifier` The name of an ajax handler to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a reading permission for the ajax handler, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkReadingPermissionForAjaxHandler()`
`public boolean`	# `checkWritingPermissionForController( NonEmptyStringType $identifier, IdType $customerId )` Checks the writing permission for a controller. Checks the writing permission for a controller. Parameters `$identifier` The name of a controller to identify an admin access group. `$customerId` ID of a customer to check the permission for. Returns boolean True if customer has a writing permission for the controller, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkWritingPermissionForController()`
`public boolean`	# `checkWritingPermissionForPage( NonEmptyStringType $identifier, IdType $customerId )` Checks the writing permission for a page. Checks the writing permission for a page. Parameters `$identifier` The name of a page to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a writing permission for the page, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkWritingPermissionForPage()`
`public boolean`	# `checkWritingPermissionForAjaxHandler( NonEmptyStringType $identifier, IdType $customerId )` Checks the writing permission for an ajax handler. Checks the writing permission for an ajax handler. Parameters `$identifier` The name of an ajax handler to identify an admin access group. `$customerId` ID of a customer to check permission for. Returns boolean True if customer has a writing permission for the ajax handler, false otherwise. Implementation of `AdminAccessPermissionManagerInterface::checkWritingPermissionForAjaxHandler()`
`public AdminAccessPermissionManager`	# `grantDeletingPermission( IdType $roleId, IdType $groupId )` Grants deleting permission to a role for a given group id. Grants deleting permission to a role for a given group id. Parameters `$roleId` $groupId Group ID to grant permission for. `$groupId` $roleId Role ID to grant permission for. Returns `AdminAccessPermissionManager` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::grantDeletingPermission()`
`public AdminAccessPermissionManager`	# `grantReadingPermission( IdType $roleId, IdType $groupId )` Grants reading permission to a role for a given group id. Grants reading permission to a role for a given group id. Parameters `$roleId` $groupId Group ID to grant permission for. `$groupId` $roleId Role ID to grant permission for. Returns `AdminAccessPermissionManager` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::grantReadingPermission()`
`public AdminAccessPermissionManager`	# `grantWritingPermission( IdType $roleId, IdType $groupId )` Grants writing permission to a role for a given group id. Grants writing permission to a role for a given group id. Parameters `$roleId` $groupId Group ID to grant permission for. `$groupId` $roleId Role ID to grant permission for. Returns `AdminAccessPermissionManager` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::grantWritingPermission()`
`public AdminAccessPermissionManagerInterface`	# `removeDeletingPermission( IdType $roleId, IdType $groupId )` Removes deleting permission from role for a given group id. Removes deleting permission from role for a given group id. Parameters `$roleId` $groupId Group ID to remove permission for. `$groupId` $roleId Role ID to remove permission from. Returns `AdminAccessPermissionManagerInterface` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::removeDeletingPermission()`
`public AdminAccessPermissionManagerInterface`	# `removeReadingPermission( IdType $roleId, IdType $groupId )` Removes reading permission from role for a given group id. Removes reading permission from role for a given group id. Parameters `$roleId` $groupId Group ID to remove permission for. `$groupId` $roleId Role ID to remove permission from. Returns `AdminAccessPermissionManagerInterface` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::removeReadingPermission()`
`public AdminAccessPermissionManagerInterface`	# `removeWritingPermission( IdType $roleId, IdType $groupId )` Removes writing permission from role for a given group id. Removes writing permission from role for a given group id. Parameters `$roleId` $groupId Group ID to remove permission for. `$groupId` $roleId Role ID to remove permission from. Returns `AdminAccessPermissionManagerInterface` Returns same instance for chained method calls. Throws `GroupNotFoundException` Implementation of `AdminAccessPermissionManagerInterface::removeWritingPermission()`
`public AdminAccessPermissionCollection`	# `getPermissionsByRoleId( IdType $roleId )` Returns a collection of all permissions by a given role ID. Returns a collection of all permissions by a given role ID. Parameters `$roleId` Role ID. Returns `AdminAccessPermissionCollection` Permission collection object with all role permissions. Implementation of `AdminAccessPermissionManagerInterface::getPermissionsByRoleId()`
`public AdminAccessPermissionCollection`	# `getPermissionsByGroupCollection( IdType $roleId, AdminAccessGroupCollection $groupCollection )` Returns a collection of permissions of a role by a given group collection. Returns a collection of permissions of a role by a given group collection. Parameters `$roleId` Role ID. `$groupCollection` Group collection. Returns `AdminAccessPermissionCollection` Permission collection object with all role permissions. Implementation of `AdminAccessPermissionManagerInterface::getPermissionsByGroupCollection()`
`protected AdminAccessUserInterface`	# `_getUser( IdType $customerId )` Returns an user by a given customer ID. Returns an user by a given customer ID. Parameters `$customerId` Customer ID. Returns `AdminAccessUserInterface` User object.
`protected AdminAccessGroupInterface`	# `_getGroupByPage( NonEmptyStringType $identifier )` Returns a group by a given identifier. Returns a group by a given identifier. Parameters `$identifier` Identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`protected AdminAccessGroupInterface`	# `_getGroupByAjaxHandler( NonEmptyStringType $identifier )` Returns a group by a given identifier. Returns a group by a given identifier. Parameters `$identifier` Identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`protected AdminAccessGroupInterface`	# `_getGroupByController( NonEmptyStringType $identifier )` Returns a group by a given identifier. Returns a group by a given identifier. Parameters `$identifier` Identifier. Returns `AdminAccessGroupInterface` Group object. Throws `GroupNotFoundException`
`protected AdminAccessPermissionPersistenceInterface\|AdminAccessPermissionPresentationInterface`	# `_getPermission( IdType $roleId, IdType $groupId )` Returns a permission by a given role ID and group ID. Returns a permission by a given role ID and group ID. If no permission could be found, a new permission will be returned. Parameters `$roleId` Role ID. `$groupId` Group ID. Returns `AdminAccessPermissionPersistenceInterface`\|`AdminAccessPermissionPresentationInterface` Permission object. Throws `GroupNotFoundException`

Properties summary

`protected AdminAccessGroupReaderInterface`	`$groupReader`	#
`protected AdminAccessRoleReaderInterface`	`$roleReader`	#
`protected AdminAccessUserReaderInterface`	`$userReader`	#
`protected AdminAccessRoleFactoryInterface`	`$roleFactory`	#

Packages

Classes

Interfaces

Class AdminAccessPermissionManager

Methods summary

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Properties summary