Class AdminAccessUser

A User is a representation of an user with administration rights. Since all users are stored in the customers table of the shop system, the term "customerId" is used to identify such an user. Apart from the ID the user has a collection of roles.

AdminAccessUser implements AdminAccessUserInterface

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

Methods summary

`public`	# `__construct( AdminAccessUserWriterInterface $writer, AdminAccessUserDeleterInterface $userDeleter, IdType $customerId, AdminAccessRoleCollection $roles )` AdminAccessUser constructor. AdminAccessUser constructor. Parameters `$writer` User writer. `$userDeleter` User deleter. `$customerId` User id. `$roles` User roles collection. Implementation of `AdminAccessUserInterface::__construct()`
`public integer`	# `getId( )` Returns the user id. Returns the user id. Returns integer User ID. Implementation of `AdminAccessUserInterface::getId()`
`public AdminAccessUserInterface`	# `addNewRole( AdminAccessRoleInterface $role )` Adds a role to this user. Adds a role to this user. Parameters `$role` Role object. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Implementation of `AdminAccessUserInterface::addNewRole()`
`public AdminAccessUserInterface`	# `removeRole( AdminAccessRoleInterface $role )` Removes role from this user. Removes role from this user. Parameters `$role` Role object. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Throws `RoleNotFoundInCollectionException` Implementation of `AdminAccessUserInterface::removeRole()`
`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 deleting permission is granted, false otherwise. Implementation of `AdminAccessUserInterface::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 reading permission is granted, false otherwise. Implementation of `AdminAccessUserInterface::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 writing permission is granted, false otherwise. Implementation of `AdminAccessUserInterface::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 `AdminAccessUserInterface::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 `AdminAccessUserInterface::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 `AdminAccessUserInterface::checkWritingPermissionForUnknownGroup()`
`public AdminAccessUserInterface`	# `setCustomerId( IdType $id )` Sets the customer ID. Sets the customer ID. Parameters `$id` Customer ID. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Implementation of `AdminAccessUserInterface::setCustomerId()`
`public AdminAccessUserInterface`	# `setRoles( AdminAccessRoleCollection $roles )` Sets the user roles. Sets the user roles. Parameters `$roles` Access roles collection. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Implementation of `AdminAccessUserInterface::setRoles()`
`public AbstractCollection\|AdminAccessRoleCollection`	# `getRoles( )` Returns the user roles. Returns the user roles. Returns `AbstractCollection`\|`AdminAccessRoleCollection` Cloned roles collection. Implementation of `AdminAccessUserInterface::getRoles()`
`public AdminAccessUserInterface`	# `update( )` Stores/Updates an user into/from the database. Stores/Updates an user into/from the database. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Implementation of `AdminAccessUserInterface::update()`
`public AdminAccessUserInterface`	# `delete( )` Deletes an user from the database. Deletes an user from the database. Returns `AdminAccessUserInterface` Returns same instance for chained method calls. Implementation of `AdminAccessUserInterface::delete()`

Properties summary

`protected integer`	`$customerId`	#
`protected AdminAccessRoleCollection\|AbstractCollection`	`$roles`	#
`protected AdminAccessUserWriterInterface`	`$userWriter`	#
`protected AdminAccessUserDeleterInterface`	`$userDeleter`	#
`protected boolean`	`$readingUnknownGroupGranted`	#
`protected boolean`	`$writingUnknownGroupGranted`	#
`protected boolean`	`$deletingUnknownGroupGranted`	#

Packages

Classes

Interfaces

Class AdminAccessUser

Methods summary

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Properties summary