UserService
extends AirlayService
in package
Class UserService.
Table of Contents
- $ : AirlayConfig
- $collection : UsersCollection
- $rabbitmq : AMQPStreamConnection
- $user : UserEntity
- $collection : mixed
- __construct() : mixed
- addDepartmentsToUser() : void
- addGroupToUser() : void
- auth() : UserEntity
- confirmRegistration() : UserEntity
- create() : UserEntity
- createFromArray() : UserEntity
- deleteById() : void
- deleteUser() : void
- getCollection() : mixed
- getRole() : string
- getRoleByPortal() : string
- getUserList() : array<string|int, mixed>
- isUserBlocked() : bool
- removeDepartmentsFromUser() : void
- removeGroupFromUser() : void
- removeUserFromDepartment() : void
- restoreUserPassword() : UserEntity
- saveUserAvatarsInS3() : array<string|int, string>
- setBlockingTime() : void
- setUserAvatar() : array<string|int, mixed>
- setUserPassword() : void
- updateById() : void
- updateDefaultUserCoordinates() : void
- updateDefaultUserCoordinatesByEntity() : void
- passwordVerify() : bool
Properties
$
public
AirlayConfig
$
config
$collection
public
UsersCollection
$collection
$rabbitmq
public
AMQPStreamConnection
$rabbitmq
$user
public
UserEntity
$user
$collection
protected
mixed
$collection
Methods
__construct()
public
__construct(mixed $collection) : mixed
Parameters
- $collection : mixed
Return values
mixed —addDepartmentsToUser()
public
addDepartmentsToUser(ObjectId $userId, array<string|int, mixed> $departmentIds) : void
Parameters
- $userId : ObjectId
- $departmentIds : array<string|int, mixed>
Return values
void —addGroupToUser()
public
addGroupToUser(ObjectId $userId, array<string|int, mixed> $groupIds) : void
Parameters
- $userId : ObjectId
- $groupIds : array<string|int, mixed>
Return values
void —auth()
public
auth(string $username, string $password) : UserEntity
Parameters
- $username : string
- $password : string
Tags
Return values
UserEntity —confirmRegistration()
public
confirmRegistration(string $key) : UserEntity
Parameters
- $key : string
Return values
UserEntity —create()
public
create(mixed $params) : UserEntity
Parameters
- $params : mixed
Return values
UserEntity —createFromArray()
public
createFromArray(array<string|int, mixed> $params) : UserEntity
Parameters
- $params : array<string|int, mixed>
Return values
UserEntity —deleteById()
public
deleteById(ObjectId $userId, ObjectId $organizationId) : void
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
Return values
void —deleteUser()
public
deleteUser(UserEntity $user, ObjectId $organizationId) : void
Parameters
- $user : UserEntity
- $organizationId : ObjectId
Return values
void —getCollection()
public
getCollection() : mixed
Return values
mixed —getRole()
public
getRole(ObjectId $userId[, ObjectId|null $organizationId = null ]) : string
Parameters
- $userId : ObjectId
- $organizationId : ObjectId|null = null
Return values
string —getRoleByPortal()
public
getRoleByPortal(ObjectId $userId, PortalEntity $portal) : string
Parameters
- $userId : ObjectId
- $portal : PortalEntity
Return values
string —getUserList()
public
getUserList(UserListRequest $request) : array<string|int, mixed>
Parameters
- $request : UserListRequest
Return values
array<string|int, mixed> —isUserBlocked()
public
isUserBlocked(ObjectId $userId) : bool
Parameters
- $userId : ObjectId
Return values
bool —removeDepartmentsFromUser()
public
removeDepartmentsFromUser(ObjectId $userId, array<string|int, mixed> $departmentIds) : void
Parameters
- $userId : ObjectId
- $departmentIds : array<string|int, mixed>
Return values
void —removeGroupFromUser()
public
removeGroupFromUser(ObjectId $userId, array<string|int, mixed> $groupIds) : void
Parameters
- $userId : ObjectId
- $groupIds : array<string|int, mixed>
Return values
void —removeUserFromDepartment()
public
removeUserFromDepartment(ObjectId $userId, ObjectId $departmentId) : void
Parameters
- $userId : ObjectId
- $departmentId : ObjectId
Return values
void —restoreUserPassword()
public
restoreUserPassword(ObjectId $userId, ObjectId $organizationId) : UserEntity
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
Tags
Return values
UserEntity —saveUserAvatarsInS3()
public
saveUserAvatarsInS3(array<string|int, TmpFile> $tmpFiles, ObjectId $userId, string $extension) : array<string|int, string>
Parameters
- $tmpFiles : array<string|int, TmpFile>
- $userId : ObjectId
- $extension : string
Return values
array<string|int, string> —setBlockingTime()
public
setBlockingTime(ObjectId $userId, int|null $blockingTime) : void
Parameters
- $userId : ObjectId
- $blockingTime : int|null
Return values
void —setUserAvatar()
public
setUserAvatar(string $imageBase64, UserEntity $user) : array<string|int, mixed>
Parameters
- $imageBase64 : string
- $user : UserEntity
Return values
array<string|int, mixed> —setUserPassword()
public
setUserPassword(ObjectId $userId, string $password, ObjectId $organizationId) : void
Parameters
- $userId : ObjectId
- $password : string
- $organizationId : ObjectId
Return values
void —updateById()
public
updateById(ObjectId $userId, ObjectId $organizationId, array<string|int, mixed> $params) : void
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
- $params : array<string|int, mixed>
Return values
void —updateDefaultUserCoordinates()
public
updateDefaultUserCoordinates(ObjectId $userId) : void
Parameters
- $userId : ObjectId
Return values
void —updateDefaultUserCoordinatesByEntity()
public
updateDefaultUserCoordinatesByEntity(UserEntity $user) : void
Parameters
- $user : UserEntity
Return values
void —passwordVerify()
protected
passwordVerify(string $password, string $hashPassword) : bool
Parameters
- $password : string
- $hashPassword : string