AdminAccessPermissionManagerInterface

Extends

Interface AdminAccessPermissionManagerInterface

category

System

package

AdminAccess

subpackage

Managers

Methods

Checks the deleting permission for an ajax handler.

checkDeletingPermissionForAjaxHandler(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of an ajax handler to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a deleting permission for the ajax handler, false otherwise.

Checks the deleting permission for a controller.

checkDeletingPermissionForController(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a controller to identify an admin access group.

$customerId

\IdType

ID of a customer to check the permission for.

Response

boolean

True if customer has a deleting permission for the controller, false otherwise.

Checks the deleting permission for a page.

checkDeletingPermissionForPage(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a page to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a deleting permission for the page, false otherwise.

Checks the reading permission for an ajax handler.

checkReadingPermissionForAjaxHandler(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of an ajax handler to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a reading permission for the ajax handler, false otherwise.

Checks the reading permission for a controller.

checkReadingPermissionForController(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a controller to identify an admin access group.

$customerId

\IdType

ID of a customer to check the permission for.

Response

boolean

True if customer has a reading permission for the controller, false otherwise.

Checks the reading permission for a page.

checkReadingPermissionForPage(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a page to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a reading permission for the page, false otherwise.

Checks the writing permission for an ajax handler.

checkWritingPermissionForAjaxHandler(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of an ajax handler to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a writing permission for the ajax handler, false otherwise.

Checks the writing permission for a controller.

checkWritingPermissionForController(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a controller to identify an admin access group.

$customerId

\IdType

ID of a customer to check the permission for.

Response

boolean

True if customer has a writing permission for the controller, false otherwise.

Checks the writing permission for a page.

checkWritingPermissionForPage(\NonEmptyStringType $identifier, \IdType $customerId) : boolean

Arguments

$identifier

\NonEmptyStringType

The name of a page to identify an admin access group.

$customerId

\IdType

ID of a customer to check permission for.

Response

boolean

True if customer has a writing permission for the page, false otherwise.

Returns a collection of permissions of a role by a given group collection.

getPermissionsByGroupCollection(\IdType $roleId, \AdminAccessGroupCollection $groupCollection) : \AdminAccessPermissionCollection

Arguments

$roleId

\IdType

Role ID.

$groupCollection

\AdminAccessGroupCollection

Group collection.

Response

\AdminAccessPermissionCollection

Permission collection object with all role permissions.

Returns a collection of all permissions by a given role ID.

getPermissionsByRoleId(\IdType $roleId) : \AdminAccessPermissionCollection

Arguments

$roleId

\IdType

Role ID.

Response

\AdminAccessPermissionCollection

Permission collection object with all role permissions.

Grants deleting permission to a role for a given group id.

grantDeletingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManager
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to grant permission for.

$groupId

\IdType

Group ID to grant permission for.

Response

\AdminAccessPermissionManager

Returns same instance for chained method calls.

Grants reading permission to a role for a given group id.

grantReadingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManager
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to grant permission for.

$groupId

\IdType

Group ID to grant permission for.

Response

\AdminAccessPermissionManager

Returns same instance for chained method calls.

Grants writing permission to a role for a given group id.

grantWritingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManager
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to grant permission for.

$groupId

\IdType

Group ID to grant permission for.

Response

\AdminAccessPermissionManager

Returns same instance for chained method calls.

Removes deleting permission from role for a given group id.

removeDeletingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManagerInterface
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to remove permission from.

$groupId

\IdType

Group ID to remove permission for.

Response

\AdminAccessPermissionManagerInterface

Returns same instance for chained method calls.

Removes reading permission from role for a given group id.

removeReadingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManagerInterface
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to remove permission from.

$groupId

\IdType

Group ID to remove permission for.

Response

\AdminAccessPermissionManagerInterface

Returns same instance for chained method calls.

Removes writing permission from role for a given group id.

removeWritingPermission(\IdType $roleId, \IdType $groupId) : \AdminAccessPermissionManagerInterface
Throws
\GroupNotFoundException

Arguments

$roleId

\IdType

Role ID to remove permission from.

$groupId

\IdType

Group ID to remove permission for.

Response

\AdminAccessPermissionManagerInterface

Returns same instance for chained method calls.