phpDocumentor

AdminAccessRole
in package
implements AdminAccessRoleInterface

Class AdminAccessRole

A role represents a collection of administration permissions that can be assigned to an user. The role has also a set of descriptive attributes like a name and a description so the user can understand, what the roles purpose is.

Tags
category

System

subpackage

Entities

Interfaces, Classes and Traits

AdminAccessRoleInterface
Interface AdminAccessRoleInterface

Table of Contents

$deleter  : AdminAccessRoleDeleterInterface
$deletingUnknownGroupGranted  : bool
$description  : KeyValueCollection
$id  : int
$name  : KeyValueCollection
$permissionReader  : AdminAccessPermissionReaderInterface
$protected  : bool
$readingUnknownGroupGranted  : bool
$sortOrder  : int
$writer  : AdminAccessRoleWriterInterface
$writingUnknownGroupGranted  : bool
__construct()  : mixed
AdminAccessRole constructor.
checkDeletingPermission()  : bool
Checks deleting permission for a given group.
checkDeletingPermissionForUnknownGroup()  : bool
Checks deleting permission for an unknown group.
checkReadingPermission()  : bool
Checks reading permission for a given group.
checkReadingPermissionForUnknownGroup()  : bool
Checks reading permission for an unknown group.
checkWritingPermission()  : bool
Checks writing permission for a given group.
checkWritingPermissionForUnknownGroup()  : bool
Checks writing permission for an unknown group.
delete()  : AdminAccessRoleInterface
Deletes an access role.
getDescription()  : KeyValueCollection
Returns the role descriptions as a collection.
getId()  : int
Returns the role id.
getName()  : KeyValueCollection
Returns the role names as a collection.
getPermissionByGroup()  : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null
Returns the a permission for this role by a given group.
getPermissionsByGroupCollection()  : AdminAccessPermissionCollection
Returns the a permission for this role by a given group collection.
getProtected()  : bool
Returns the protected value.
getSortOrder()  : int
Returns the role sort order.
setDeletingUnknownGroupGranted()  : AdminAccessRoleInterface
Sets the deleting permission value for an unknown group.
setDescription()  : AdminAccessRoleInterface
Sets the role description.
setId()  : AdminAccessRoleInterface
Sets the role ID.
setName()  : AdminAccessRoleInterface
Sets the role names.
setProtected()  : AdminAccessRoleInterface
Sets the protected value.
setReadingUnknownGroupGranted()  : AdminAccessRoleInterface
Sets the reading permission value for an unknown group.
setSortOrder()  : AdminAccessRoleInterface
Sets the role sort order.
setWritingUnknownGroupGranted()  : AdminAccessRoleInterface
Sets the writing permission value for an unknown group.
store()  : AdminAccessRoleInterface
Stores this role into the database.
update()  : AdminAccessRoleInterface
Updates this role in the database.

Properties

Methods

checkDeletingPermissionForUnknownGroup()

Checks deleting permission for an unknown group.

public checkDeletingPermissionForUnknownGroup() : bool
Return values
bool —

True if deleting permission for an unknown group is granted, false otherwise.

checkReadingPermissionForUnknownGroup()

Checks reading permission for an unknown group.

public checkReadingPermissionForUnknownGroup() : bool
Return values
bool —

True if reading permission for an unknown group is granted, false otherwise.

checkWritingPermissionForUnknownGroup()

Checks writing permission for an unknown group.

public checkWritingPermissionForUnknownGroup() : bool
Return values
bool —

True if writing permission for an unknown group is granted, false otherwise.

getProtected()

Returns the protected value.

public getProtected() : bool
Return values
bool —

getSortOrder()

Returns the role sort order.

public getSortOrder() : int
Return values
int —

Sort order.

Search results