AdminAccessServiceInterface
in
Interface AuthServiceInterface
Tags
Table of Contents
- addItemToGroup() : AdminAccessGroupInterface
- Adds a group item to an existing group.
- addRoleToUserByCustomerId() : AdminAccessServiceInterface
- Adds a role to a user by a given role and customer ID.
- checkDeletingPermissionForAjaxHandler() : bool
- Checks the deleting permission for an ajax handler.
- checkDeletingPermissionForController() : bool
- Checks the deleting permission for a controller.
- checkDeletingPermissionForPage() : bool
- Checks the deleting permission for a page.
- checkReadingPermissionForAjaxHandler() : bool
- Checks the reading permission for an ajax handler.
- checkReadingPermissionForController() : bool
- Checks the reading permission for a controller.
- checkReadingPermissionForPage() : bool
- Checks the reading permission for a page.
- checkWritingPermissionForAjaxHandler() : bool
- Checks the writing permission for an ajax handler.
- checkWritingPermissionForController() : bool
- Checks the writing permission for a controller.
- checkWritingPermissionForPage() : bool
- Checks the writing permission for a page.
- createNewGroup() : AdminAccessGroupInterface
- Creates a new group.
- createNewRole() : AdminAccessRoleInterface
- Creates a new role.
- deleteGroupById() : AdminAccessServiceInterface
- Deletes a group by a given group ID.
- deleteRoleById() : AdminAccessServiceInterface
- Deletes role by a given role ID.
- deleteUserByCustomerId() : AdminAccessServiceInterface
- Deletes an admin access user by a given customer ID.
- getAllGroups() : AdminAccessGroupCollection
- Returns a collection of all groups.
- getAllRoles() : AdminAccessRoleCollection
- Returns a collection of all roles.
- getGroupByAjaxHandler() : AdminAccessGroupInterface
- Returns a group by a given ajax handler identifier.
- getGroupByController() : AdminAccessGroupInterface
- Returns a group by a given controller identifier.
- getGroupById() : AdminAccessGroupInterface
- Returns a group by a given group id.
- getGroupByPage() : AdminAccessGroupInterface
- Returns a group by a given page identifier.
- getPermissionsByGroupCollection() : AdminAccessPermissionCollection
- Returns a collection of permissions of a role by a given group collection.
- getPermissionsByRoleId() : AdminAccessPermissionCollection
- Returns a collection of all permissions by a given role ID.
- getRoleById() : AdminAccessRoleInterface
- Returns a role by a given role ID.
- getRolesByCustomerId() : AdminAccessRoleCollection
- Returns all roles of certain user by a given user ID.
- grantDeletingPermissionToRole() : AdminAccessServiceInterface
- Grants deleting permission to a role for a given group id.
- grantReadingPermissionToRole() : AdminAccessServiceInterface
- Grants reading permission to a role for a given group id.
- grantWritingPermissionToRole() : AdminAccessServiceInterface
- Grants writing permission to a role for a given group id.
- removeDeletingPermissionFromRole() : AdminAccessServiceInterface
- Removes deleting permission from role for a given group id.
- removeItemFromGroup() : AdminAccessGroupInterface
- Removes a group item from an existing group.
- removeReadingPermissionFromRole() : AdminAccessServiceInterface
- Removes reading permission from role for a given group id.
- removeRoleFromUserByCustomerId() : AdminAccessServiceInterface
- Removes a role from a user by given role and customer ID.
- removeWritingPermissionFromRole() : AdminAccessServiceInterface
- Removes writing permission from role for a given group id.
- updateGroup() : AdminAccessServiceInterface
- Updates a group by a given group ID.
- updateRoleById() : AdminAccessServiceInterface
- Updates a role by a given role ID.
Methods
addItemToGroup()
Adds a group item to an existing group.
public
addItemToGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type) : AdminAccessGroupInterface
Parameters
- $groupId : IdType
-
Id of the group.
- $identifier : NonEmptyStringType
-
Identifier for this item.
- $type : NonEmptyStringType
-
Type of this item.
Tags
Return values
AdminAccessGroupInterface —Group object.
addRoleToUserByCustomerId()
Adds a role to a user by a given role and customer ID.
public
addRoleToUserByCustomerId(IdType $roleId, IdType $customerId) : AdminAccessServiceInterface
Parameters
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
checkDeletingPermissionForAjaxHandler()
Checks the deleting permission for an ajax handler.
public
checkDeletingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of an ajax handler to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a deleting permission for the ajax handler, false otherwise.
checkDeletingPermissionForController()
Checks the deleting permission for a controller.
public
checkDeletingPermissionForController(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a controller to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check the permission for.
Return values
bool —True if customer has a deleting permission for the controller, false otherwise.
checkDeletingPermissionForPage()
Checks the deleting permission for a page.
public
checkDeletingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a page to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a deleting permission for the page, false otherwise.
checkReadingPermissionForAjaxHandler()
Checks the reading permission for an ajax handler.
public
checkReadingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of an ajax handler to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a reading permission for the ajax handler, false otherwise.
checkReadingPermissionForController()
Checks the reading permission for a controller.
public
checkReadingPermissionForController(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a controller to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check the permission for.
Return values
bool —True if customer has a reading permission for the controller, false otherwise.
checkReadingPermissionForPage()
Checks the reading permission for a page.
public
checkReadingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a page to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a reading permission for the page, false otherwise.
checkWritingPermissionForAjaxHandler()
Checks the writing permission for an ajax handler.
public
checkWritingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of an ajax handler to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a writing permission for the ajax handler, false otherwise.
checkWritingPermissionForController()
Checks the writing permission for a controller.
public
checkWritingPermissionForController(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a controller to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check the permission for.
Return values
bool —True if customer has a writing permission for the controller, false otherwise.
checkWritingPermissionForPage()
Checks the writing permission for a page.
public
checkWritingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId) : bool
Parameters
- $identifier : NonEmptyStringType
-
The name of a page to identify an admin access group.
- $customerId : IdType
-
ID of a customer to check permission for.
Return values
bool —True if customer has a writing permission for the page, false otherwise.
createNewGroup()
Creates a new group.
public
createNewGroup(KeyValueCollection $name, KeyValueCollection $description, IdType $parentId, IntType $sortOrder) : AdminAccessGroupInterface
Parameters
- $name : KeyValueCollection
-
Collection with the group names. Index of a group name must be his language code.
- $description : KeyValueCollection
-
Collection with the group descriptions. Index of a group name must be his language code.
- $parentId : IdType
-
Id of the parent group.
- $sortOrder : IntType
-
Group sorts order.
Tags
Return values
AdminAccessGroupInterface —Returns the create role.
createNewRole()
Creates a new role.
public
createNewRole(KeyValueCollection $name, KeyValueCollection $description, IntType $sortOrder, BoolType $unknownReadingGranted, BoolType $unknownWritingGranted, BoolType $unknownDeletingGranted) : AdminAccessRoleInterface
Parameters
- $name : KeyValueCollection
-
Collection with the role names. Index of a role name must be his language code.
- $description : KeyValueCollection
-
Collection with the role descriptions. Index of a role name must be his language code.
- $sortOrder : IntType
-
Roles sort order.
- $unknownReadingGranted : BoolType
-
Value of the reading permission for unknown groups.
- $unknownWritingGranted : BoolType
-
Value of the writing permission for unknown groups.
- $unknownDeletingGranted : BoolType
-
Value of the deleting permission for unknown groups.
Return values
AdminAccessRoleInterface —Returns the create role.
deleteGroupById()
Deletes a group by a given group ID.
public
deleteGroupById(IdType $id) : AdminAccessServiceInterface
Parameters
- $id : IdType
-
ID of the group that should be deleted.
Tags
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
deleteRoleById()
Deletes role by a given role ID.
public
deleteRoleById(IdType $roleId) : AdminAccessServiceInterface
Parameters
- $roleId : IdType
-
ID of the role that should be deleted.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
deleteUserByCustomerId()
Deletes an admin access user by a given customer ID.
public
deleteUserByCustomerId(IdType $customerId) : AdminAccessServiceInterface
Parameters
- $customerId : IdType
-
ID of the user that should be deleted.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
getAllGroups()
Returns a collection of all groups.
public
getAllGroups() : AdminAccessGroupCollection
Return values
AdminAccessGroupCollection —Group collection.
getAllRoles()
Returns a collection of all roles.
public
getAllRoles() : AdminAccessRoleCollection
Return values
AdminAccessRoleCollection —Role collection with all available roles.
getGroupByAjaxHandler()
Returns a group by a given ajax handler identifier.
public
getGroupByAjaxHandler(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Ajax handler identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupByController()
Returns a group by a given controller identifier.
public
getGroupByController(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Controller identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupById()
Returns a group by a given group id.
public
getGroupById(IdType $id) : AdminAccessGroupInterface
Parameters
- $id : IdType
-
Group id.
Tags
Return values
AdminAccessGroupInterface —Group object.
getGroupByPage()
Returns a group by a given page identifier.
public
getGroupByPage(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Page identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getPermissionsByGroupCollection()
Returns a collection of permissions of a role by a given group collection.
public
getPermissionsByGroupCollection(IdType $roleId, AdminAccessGroupCollection $groupCollection) : AdminAccessPermissionCollection
Parameters
- $roleId : IdType
-
Role ID.
- $groupCollection : AdminAccessGroupCollection
-
Group collection.
Return values
AdminAccessPermissionCollection —Permission collection object with all role permissions.
getPermissionsByRoleId()
Returns a collection of all permissions by a given role ID.
public
getPermissionsByRoleId(IdType $roleId) : AdminAccessPermissionCollection
Parameters
- $roleId : IdType
-
Role ID.
Return values
AdminAccessPermissionCollection —Permission collection object with all role permissions.
getRoleById()
Returns a role by a given role ID.
public
getRoleById(IdType $roleId) : AdminAccessRoleInterface
Parameters
- $roleId : IdType
-
ID of the requested role.
Return values
AdminAccessRoleInterface —getRolesByCustomerId()
Returns all roles of certain user by a given user ID.
public
getRolesByCustomerId(idType $id) : AdminAccessRoleCollection
Parameters
- $id : idType
-
User ID.
Return values
AdminAccessRoleCollection —Collection of all roles that certain user has.
grantDeletingPermissionToRole()
Grants deleting permission to a role for a given group id.
public
grantDeletingPermissionToRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to grant permission for.
- $roleId : IdType
-
Role ID to grant permission for.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
grantReadingPermissionToRole()
Grants reading permission to a role for a given group id.
public
grantReadingPermissionToRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to grant permission for.
- $roleId : IdType
-
Role ID to grant permission for.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
grantWritingPermissionToRole()
Grants writing permission to a role for a given group id.
public
grantWritingPermissionToRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to grant permission for.
- $roleId : IdType
-
Role ID to grant permission for.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
removeDeletingPermissionFromRole()
Removes deleting permission from role for a given group id.
public
removeDeletingPermissionFromRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to remove permission for.
- $roleId : IdType
-
Role ID to remove permission from.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
removeItemFromGroup()
Removes a group item from an existing group.
public
removeItemFromGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type) : AdminAccessGroupInterface
Parameters
- $groupId : IdType
-
Id of the group.
- $identifier : NonEmptyStringType
-
Identifier for this item.
- $type : NonEmptyStringType
-
Type of this item.
Tags
Return values
AdminAccessGroupInterface —Group object.
removeReadingPermissionFromRole()
Removes reading permission from role for a given group id.
public
removeReadingPermissionFromRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to remove permission for.
- $roleId : IdType
-
Role ID to remove permission from.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
removeRoleFromUserByCustomerId()
Removes a role from a user by given role and customer ID.
public
removeRoleFromUserByCustomerId(IdType $roleId, IdType $customerId) : AdminAccessServiceInterface
Parameters
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
removeWritingPermissionFromRole()
Removes writing permission from role for a given group id.
public
removeWritingPermissionFromRole(IdType $groupId, IdType $roleId) : AdminAccessServiceInterface
Parameters
- $groupId : IdType
-
Group ID to remove permission for.
- $roleId : IdType
-
Role ID to remove permission from.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
updateGroup()
Updates a group by a given group ID.
public
updateGroup(IdType $id, KeyValueCollection $newName, KeyValueCollection $newDescription, IdType $newParentId, IntType $newSortOrder) : AdminAccessServiceInterface
Parameters
- $id : IdType
- $newName : KeyValueCollection
-
Collection with the group names. Index of a group name must be his language code.
- $newDescription : KeyValueCollection
-
Collection with the group descriptions. Index of a group name must be his language code.
- $newParentId : IdType
-
New id of the parent group.
- $newSortOrder : IntType
-
New group sorts order.
Tags
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.
updateRoleById()
Updates a role by a given role ID.
public
updateRoleById(IdType $roleId, KeyValueCollection $newName, KeyValueCollection $newDescription, IntType $newSortOrder, BoolType $unknownReadingGranted, BoolType $unknownWritingGranted, BoolType $unknownDeletingGranted) : AdminAccessServiceInterface
Parameters
- $roleId : IdType
-
Role ID to remove permission from.
- $newName : KeyValueCollection
-
Collection with the new role names. Index of a role name must be his language code.
- $newDescription : KeyValueCollection
-
Collection with the new role descriptions. Index of a role name must be his language code.
- $newSortOrder : IntType
-
New roles sort order.
- $unknownReadingGranted : BoolType
-
Value of the reading permission for unknown groups.
- $unknownWritingGranted : BoolType
-
Value of the writing permission for unknown groups.
- $unknownDeletingGranted : BoolType
-
Value of the deleting permission for unknown groups.
Return values
AdminAccessServiceInterface —Returns same instance for chained method calls.