AdminAccessUser
in package
implements
AdminAccessUserInterface
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.
Tags
Interfaces, Classes and Traits
- AdminAccessUserInterface
- Interface AdminAccessUserInterface
Table of Contents
- $customerId : int
- $deletingUnknownGroupGranted : bool
- $readingUnknownGroupGranted : bool
- $roles : AdminAccessRoleCollection|AbstractCollection
- $userDeleter : AdminAccessUserDeleterInterface
- $userWriter : AdminAccessUserWriterInterface
- $writingUnknownGroupGranted : bool
- __construct() : mixed
- AdminAccessUser constructor.
- addNewRole() : AdminAccessUserInterface
- Adds a role to this user.
- 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() : AdminAccessUserInterface
- Deletes an user from the database.
- getId() : int
- Returns the user id.
- getRoles() : AbstractCollection|AdminAccessRoleCollection
- Returns the user roles.
- removeRole() : AdminAccessUserInterface
- Removes role from this user.
- setCustomerId() : AdminAccessUserInterface
- Sets the customer ID.
- setRoles() : AdminAccessUserInterface
- Sets the user roles.
- update() : AdminAccessUserInterface
- Stores/Updates an user into/from the database.
Properties
$customerId
protected
int
$customerId
$deletingUnknownGroupGranted
protected
bool
$deletingUnknownGroupGranted
$readingUnknownGroupGranted
protected
bool
$readingUnknownGroupGranted
$roles
protected
AdminAccessRoleCollection|AbstractCollection
$roles
$userDeleter
protected
AdminAccessUserDeleterInterface
$userDeleter
$userWriter
protected
AdminAccessUserWriterInterface
$userWriter
$writingUnknownGroupGranted
protected
bool
$writingUnknownGroupGranted
Methods
__construct()
AdminAccessUser constructor.
public
__construct(AdminAccessUserWriterInterface $writer, AdminAccessUserDeleterInterface $userDeleter, IdType $customerId, AdminAccessRoleCollection $roles) : mixed
Parameters
- $writer : AdminAccessUserWriterInterface
-
User writer.
- $userDeleter : AdminAccessUserDeleterInterface
-
User deleter.
- $customerId : IdType
-
User id.
- $roles : AdminAccessRoleCollection
-
User roles collection.
Return values
mixed —addNewRole()
Adds a role to this user.
public
addNewRole(AdminAccessRoleInterface $role) : AdminAccessUserInterface
Parameters
- $role : AdminAccessRoleInterface
-
Role object.
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.
checkDeletingPermission()
Checks deleting permission for a given group.
public
checkDeletingPermission(AdminAccessGroupInterface $group) : bool
Parameters
- $group : AdminAccessGroupInterface
-
Group object.
Return values
bool —True if deleting permission is granted, 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 reading permission 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.
checkWritingPermission()
Checks writing permission for a given group.
public
checkWritingPermission(AdminAccessGroupInterface $group) : bool
Parameters
- $group : AdminAccessGroupInterface
-
Group object.
Return values
bool —True if writing permission 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.
delete()
Deletes an user from the database.
public
delete() : AdminAccessUserInterface
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.
getId()
Returns the user id.
public
getId() : int
Return values
int —User ID.
getRoles()
Returns the user roles.
public
getRoles() : AbstractCollection|AdminAccessRoleCollection
Return values
AbstractCollection|AdminAccessRoleCollection —Cloned roles collection.
removeRole()
Removes role from this user.
public
removeRole(AdminAccessRoleInterface $role) : AdminAccessUserInterface
Parameters
- $role : AdminAccessRoleInterface
-
Role object.
Tags
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.
setCustomerId()
Sets the customer ID.
public
setCustomerId(IdType $id) : AdminAccessUserInterface
Parameters
- $id : IdType
-
Customer ID.
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.
setRoles()
Sets the user roles.
public
setRoles(AdminAccessRoleCollection $roles) : AdminAccessUserInterface
Parameters
- $roles : AdminAccessRoleCollection
-
Access roles collection.
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.
update()
Stores/Updates an user into/from the database.
public
update() : AdminAccessUserInterface
Return values
AdminAccessUserInterface —Returns same instance for chained method calls.