AdminAccessPermission
in package
implements
AdminAccessPermissionPresentationInterface, AdminAccessPermissionPersistenceInterface, AdminAccessPermissionInterface
Class AdminAccessPermission
A permission is the bridge element between a group and a role. It assigns these two elements a values for a reading, writing and deleting (permission).
Tags
Interfaces, Classes and Traits
- AdminAccessPermissionPresentationInterface
- Interface AdminAccessPermissionPresentationInterface
- AdminAccessPermissionPersistenceInterface
- Interface AdminAccessPermissionPersistenceInterface
- AdminAccessPermissionInterface
- Interface AdminAccessPermissionInterface
Table of Contents
- $deletingGranted : bool
- $group : AdminAccessGroupInterface
- $groupId : int
- $groupReader : AdminAccessGroupReaderInterface
- $permissionDeleter : AdminAccessPermissionDeleterInterface
- $permissionReader : AdminAccessPermissionInterface
- $permissionWriter : AdminAccessPermissionWriterInterface
- $readingGranted : bool
- $role : AdminAccessRoleInterface
- $writingGranted : bool
- __construct() : mixed
- AdminAccessPermission constructor.
- delete() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Deletes a permission.
- getGroup() : AdminAccessGroupInterface
- Returns the group of this permission.
- getRole() : AdminAccessRoleInterface
- Returns the role of this permission.
- grantDeleting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Grants deleting access.
- grantReading() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Grants reading access.
- grantWriting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Grants writing access.
- isDeletingGranted() : bool
- Checks if deleting is granted.
- isReadingGranted() : bool
- Checks if reading is granted.
- isWritingGranted() : bool
- Checks if writing is granted.
- removeDeleting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Removes deleting access.
- removeReading() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Removes reading access.
- removeWriting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Removes writing access.
- setGroup() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Sets the group of this permission.
- setGroupId() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Sets group ID.
- setRole() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Sets the role of this permission.
- store() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Stores a permission into the database.
- update() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
- Updates a permission in the database.
Properties
$deletingGranted
protected
bool
$deletingGranted
$group
protected
AdminAccessGroupInterface
$group
$groupId
protected
int
$groupId
$groupReader
protected
AdminAccessGroupReaderInterface
$groupReader
$permissionDeleter
protected
AdminAccessPermissionDeleterInterface
$permissionDeleter
$permissionReader
protected
AdminAccessPermissionInterface
$permissionReader
$permissionWriter
protected
AdminAccessPermissionWriterInterface
$permissionWriter
$readingGranted
protected
bool
$readingGranted
$role
protected
AdminAccessRoleInterface
$role
$writingGranted
protected
bool
$writingGranted
Methods
__construct()
AdminAccessPermission constructor.
public
__construct(AdminAccessPermissionDeleterInterface $permissionDeleter, AdminAccessPermissionWriterInterface $permissionWriter, AdminAccessGroupReaderInterface $groupReader, AdminAccessPermissionReaderInterface $permissionReader) : mixed
Parameters
- $permissionDeleter : AdminAccessPermissionDeleterInterface
-
Permission deleter.
- $permissionWriter : AdminAccessPermissionWriterInterface
-
Permission writer.
- $groupReader : AdminAccessGroupReaderInterface
-
Group reader.
- $permissionReader : AdminAccessPermissionReaderInterface
-
Permission reader.
Return values
mixed —delete()
Deletes a permission.
public
delete() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
getGroup()
Returns the group of this permission.
public
getGroup() : AdminAccessGroupInterface
Tags
Return values
AdminAccessGroupInterface —Group object.
getRole()
Returns the role of this permission.
public
getRole() : AdminAccessRoleInterface
Return values
AdminAccessRoleInterface —Role object.
grantDeleting()
Grants deleting access.
public
grantDeleting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
grantReading()
Grants reading access.
public
grantReading() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
grantWriting()
Grants writing access.
public
grantWriting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
isDeletingGranted()
Checks if deleting is granted.
public
isDeletingGranted() : bool
Return values
bool —True if deleting is granted, false otherwise.
isReadingGranted()
Checks if reading is granted.
public
isReadingGranted() : bool
Return values
bool —True if reading is granted, false otherwise.
isWritingGranted()
Checks if writing is granted.
public
isWritingGranted() : bool
Return values
bool —True if writing is granted, false otherwise.
removeDeleting()
Removes deleting access.
public
removeDeleting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
removeReading()
Removes reading access.
public
removeReading() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
removeWriting()
Removes writing access.
public
removeWriting() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
setGroup()
Sets the group of this permission.
public
setGroup(AdminAccessGroupInterface $accessGroup) : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Parameters
- $accessGroup : AdminAccessGroupInterface
-
Group object.
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
setGroupId()
Sets group ID.
public
setGroupId(IdType $groupId) : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Parameters
- $groupId : IdType
-
Group ID.
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
setRole()
Sets the role of this permission.
public
setRole(AdminAccessRoleInterface $accessRole) : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Parameters
- $accessRole : AdminAccessRoleInterface
-
Role object.
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
store()
Stores a permission into the database.
public
store() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.
update()
Updates a permission in the database.
public
update() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface —Returns same instance for chained method calls.