AdminAccessRoleInterface
in
Interface AdminAccessRoleInterface
Tags
Table of Contents
- 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.
Methods
checkDeletingPermission()
Checks deleting permission for a given group.
public
checkDeletingPermission(AdminAccessGroupInterface $group) : bool
Parameters
- $group : AdminAccessGroupInterface
-
Group object.
Return values
bool —True if role has deleting permission, false otherwise.
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.
checkReadingPermission()
Checks reading permission for a given group.
public
checkReadingPermission(AdminAccessGroupInterface $group) : bool
Parameters
- $group : AdminAccessGroupInterface
-
Group object.
Return values
bool —True if role has reading permission, 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.
checkWritingPermission()
Checks writing permission for a given group.
public
checkWritingPermission(AdminAccessGroupInterface $group) : bool
Parameters
- $group : AdminAccessGroupInterface
-
Group object.
Return values
bool —True if role has writing permission, 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.
delete()
Deletes an access role.
public
delete() : AdminAccessRoleInterface
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
getDescription()
Returns the role descriptions as a collection.
public
getDescription() : KeyValueCollection
Return values
KeyValueCollection —Role description in all available languages.
getId()
Returns the role id.
public
getId() : int
Return values
int —Role ID.
getName()
Returns the role names as a collection.
public
getName() : KeyValueCollection
Return values
KeyValueCollection —Role name in all available languages.
getPermissionByGroup()
Returns the a permission for this role by a given group.
public
getPermissionByGroup( $group) : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null
Parameters
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null —Returns permission found or null if permission not found.
getPermissionsByGroupCollection()
Returns the a permission for this role by a given group collection.
public
getPermissionsByGroupCollection( $groupCollection) : AdminAccessPermissionCollection
Parameters
Return values
AdminAccessPermissionCollection —Returns permissions collection.
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.
setDeletingUnknownGroupGranted()
Sets the deleting permission value for an unknown group.
public
setDeletingUnknownGroupGranted(BoolType $permissionGranted) : AdminAccessRoleInterface
Parameters
- $permissionGranted : BoolType
-
Value of the deleting permission for unknown groups.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setDescription()
Sets the role description.
public
setDescription(KeyValueCollection $description) : AdminAccessRoleInterface
Parameters
- $description : KeyValueCollection
-
Role description.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setId()
Sets the role ID.
public
setId(IdType $id) : AdminAccessRoleInterface
Parameters
- $id : IdType
-
Role ID.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setName()
Sets the role names.
public
setName(KeyValueCollection $name) : AdminAccessRoleInterface
Parameters
- $name : KeyValueCollection
-
Role name.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setProtected()
Sets the protected value.
public
setProtected(BoolType $value) : AdminAccessRoleInterface
Parameters
- $value : BoolType
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setReadingUnknownGroupGranted()
Sets the reading permission value for an unknown group.
public
setReadingUnknownGroupGranted(BoolType $permissionGranted) : AdminAccessRoleInterface
Parameters
- $permissionGranted : BoolType
-
Value of the reading permission for unknown groups.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setSortOrder()
Sets the role sort order.
public
setSortOrder(IntType $sortOrder) : AdminAccessRoleInterface
Parameters
- $sortOrder : IntType
-
Role sort order.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
setWritingUnknownGroupGranted()
Sets the writing permission value for an unknown group.
public
setWritingUnknownGroupGranted(BoolType $permissionGranted) : AdminAccessRoleInterface
Parameters
- $permissionGranted : BoolType
-
Value of the writing permission for unknown groups.
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
store()
Stores this role into the database.
public
store() : AdminAccessRoleInterface
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.
update()
Updates this role in the database.
public
update() : AdminAccessRoleInterface
Return values
AdminAccessRoleInterface —Returns same instance for chained method calls.