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.

AdminAccessRole implements AdminAccessRoleInterface

Package: AdminAccess\Entities
Category: System
Located at Services/System/AdminAccess/Entities/AdminAccessRole.inc.php

Methods summary

`public`	# `__construct( AdminAccessRoleDeleterInterface $deleter, AdminAccessRoleWriterInterface $writer, AdminAccessPermissionReaderInterface $permissionReader )` AdminAccessRole constructor. AdminAccessRole constructor. Parameters `$deleter` Role deleter. `$writer` Role writer. `$permissionReader` Permission reader.
`public boolean`	# `checkDeletingPermission( AdminAccessGroupInterface $group )` Checks deleting permission for a given group. Checks deleting permission for a given group. Parameters `$group` Group object. Returns boolean True if role has deleting permission, false otherwise. Implementation of `AdminAccessRoleInterface::checkDeletingPermission()`
`public boolean`	# `checkReadingPermission( AdminAccessGroupInterface $group )` Checks reading permission for a given group. Checks reading permission for a given group. Parameters `$group` Group object. Returns boolean True if role has reading permission, false otherwise. Implementation of `AdminAccessRoleInterface::checkReadingPermission()`
`public boolean`	# `checkWritingPermission( AdminAccessGroupInterface $group )` Checks writing permission for a given group. Checks writing permission for a given group. Parameters `$group` Group object. Returns boolean True if role has writing permission, false otherwise. Implementation of `AdminAccessRoleInterface::checkWritingPermission()`
`public boolean`	# `checkDeletingPermissionForUnknownGroup( )` Checks deleting permission for an unknown group. Checks deleting permission for an unknown group. Returns boolean True if deleting permission for an unknown group is granted, false otherwise. Implementation of `AdminAccessRoleInterface::checkDeletingPermissionForUnknownGroup()`
`public boolean`	# `checkReadingPermissionForUnknownGroup( )` Checks reading permission for an unknown group. Checks reading permission for an unknown group. Returns boolean True if reading permission for an unknown group is granted, false otherwise. Implementation of `AdminAccessRoleInterface::checkReadingPermissionForUnknownGroup()`
`public boolean`	# `checkWritingPermissionForUnknownGroup( )` Checks writing permission for an unknown group. Checks writing permission for an unknown group. Returns boolean True if writing permission for an unknown group is granted, false otherwise. Implementation of `AdminAccessRoleInterface::checkWritingPermissionForUnknownGroup()`
`public AdminAccessRoleInterface`	# `delete( )` Deletes an access role. Deletes an access role. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Throws `ProtectedRoleException` Implementation of `AdminAccessRoleInterface::delete()`
`public integer`	# `getId( )` Returns the role id. Returns the role id. Returns integer Role ID. Implementation of `AdminAccessRoleInterface::getId()`
`public KeyValueCollection`	# `getName( )` Returns the role names as a collection. Returns the role names as a collection. Returns `KeyValueCollection` Role name in all available languages. Implementation of `AdminAccessRoleInterface::getName()`
`public KeyValueCollection`	# `getDescription( )` Returns the role descriptions as a collection. Returns the role descriptions as a collection. Returns `KeyValueCollection` Role description in all available languages. Implementation of `AdminAccessRoleInterface::getDescription()`
`public integer`	# `getSortOrder( )` Returns the role sort order. Returns the role sort order. Returns integer Sort order. Implementation of `AdminAccessRoleInterface::getSortOrder()`
`public AdminAccessRoleInterface`	# `setId( IdType $id )` Sets the role ID. Sets the role ID. Parameters `$id` Role ID. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setId()`
`public AdminAccessRoleInterface`	# `setName( KeyValueCollection $name )` Sets the role names. Sets the role names. Parameters `$name` Role name. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setName()`
`public AdminAccessRoleInterface`	# `setDescription( KeyValueCollection $description )` Sets the role description. Sets the role description. Parameters `$description` Role description. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setDescription()`
`public AdminAccessRoleInterface`	# `setSortOrder( IntType $sortOrder )` Sets the role sort order. Sets the role sort order. Parameters `$sortOrder` Role sort order. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setSortOrder()`
`public AdminAccessRoleInterface`	# `setDeletingUnknownGroupGranted( BoolType $permissionGranted )` Sets the deleting permission value for an unknown group. Sets the deleting permission value for an unknown group. Parameters `$permissionGranted` Value of the deleting permission for unknown groups. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setDeletingUnknownGroupGranted()`
`public AdminAccessRoleInterface`	# `setReadingUnknownGroupGranted( BoolType $permissionGranted )` Sets the reading permission value for an unknown group. Sets the reading permission value for an unknown group. Parameters `$permissionGranted` Value of the reading permission for unknown groups. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setReadingUnknownGroupGranted()`
`public AdminAccessRoleInterface`	# `setWritingUnknownGroupGranted( BoolType $permissionGranted )` Sets the writing permission value for an unknown group. Sets the writing permission value for an unknown group. Parameters `$permissionGranted` Value of the writing permission for unknown groups. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setWritingUnknownGroupGranted()`
`public AdminAccessRoleInterface`	# `store( )` Stores this role into the database. Stores this role into the database. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Throws `ProtectedRoleException` Implementation of `AdminAccessRoleInterface::store()`
`public AdminAccessRoleInterface`	# `update( )` Updates this role in the database. Updates this role in the database. Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Throws `ProtectedRoleException` Implementation of `AdminAccessRoleInterface::update()`
`public AdminAccessPermissionPresentationInterface\|AdminAccessPermissionPersistenceInterface\|null`	# `getPermissionByGroup( AdminAccessGroupInterface $group )` Returns the a permission for this role by a given group. Returns the a permission for this role by a given group. Parameters `$group` Admin access group. Returns `AdminAccessPermissionPresentationInterface`\|`AdminAccessPermissionPersistenceInterface`\|null Returns permission found or null if permission not found. Implementation of `AdminAccessRoleInterface::getPermissionByGroup()`
`public AdminAccessPermissionCollection`	# `getPermissionsByGroupCollection( AdminAccessGroupCollection $groupCollection )` Returns the a permission for this role by a given group collection. Returns the a permission for this role by a given group collection. Parameters `$groupCollection` Collections of groups to find. Returns `AdminAccessPermissionCollection` Returns permissions collection. Implementation of `AdminAccessRoleInterface::getPermissionsByGroupCollection()`
`public AdminAccessRoleInterface`	# `setProtected( BoolType $value )` Sets the protected value. Sets the protected value. Parameters `$value` Returns `AdminAccessRoleInterface` Returns same instance for chained method calls. Implementation of `AdminAccessRoleInterface::setProtected()`
`public boolean`	# `getProtected( )` Returns the protected value. Returns the protected value. Returns boolean Implementation of `AdminAccessRoleInterface::getProtected()`

Properties summary

`protected integer`	`$id`	#
`protected KeyValueCollection`	`$name`	#
`protected KeyValueCollection`	`$description`	#
`protected integer`	`$sortOrder`	#
`protected AdminAccessRoleDeleterInterface`	`$deleter`	#
`protected AdminAccessRoleWriterInterface`	`$writer`	#
`protected AdminAccessPermissionReaderInterface`	`$permissionReader`	#
`protected boolean`	`$deletingUnknownGroupGranted`	#
`protected boolean`	`$readingUnknownGroupGranted`	#
`protected boolean`	`$writingUnknownGroupGranted`	#
`protected boolean`	`$protected`	#

Packages

Classes

Interfaces

Class AdminAccessRole

Methods summary

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Throws

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

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

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Properties summary