AirLay backend

UsersCollection extends BaseCollection
in package

Table of Contents

$objectType  : string
__construct()  : mixed
addCoordinatesToUser()  : UpdateResult
addDatasetFiltersToUsers()  : void
addDepartmentToUser()  : UpdateResult
addUserGroup()  : void
deleteByIdAndOrganizationId()  : void
findAllByOrganizationId()  : array<string|int, UserEntity>
findByConfirmKey()  : UserEntity|null
findByDepartmentId()  : array<string|int, UserEntity>
findByEmail()  : UserEntity|null
findByIdAndOrganizationId()  : UserEntity|null
findByIds()  : array<string|int, UserEntity>
findByLinkedAccountId()  : UserEntity|null
findByNameAndEmail()  : UserEntity|null
findByNames()  : array<string|int, UserEntity>
findBySetPasswordToken()  : UserEntity|null
findByUserName()  : UserEntity|null
findUserDatasetFilters()  : array<string|int, mixed>
findUsersByIdsAndOrganizationId()  : array<string|int, UserEntity>
hasByIdAndOrganizationId()  : bool
hasOneByEmail()  : bool
hasOneByLinkedAccountIdOrEmail()  : bool
hasOneByUserName()  : bool
removeDatasetFiltersFromUsers()  : UpdateResult
removeDepartmentFiltersFromUser()  : UpdateResult
removeDepartmentFromUser()  : UpdateResult
removeDepartmentsFromUsers()  : UpdateResult
removeGroupFromAllUsers()  : UpdateResult
removeUserGroup()  : void
setBlockById()  : void
setBlockByIds()  : void
setIsPasswordExpirationNotificationSent()  : void
setLastActivity()  : void
setTotpTwoFactoryAuthorization()  : void
setUserPassword()  : UpdateResult
setUserUpdateTime()  : void
updateUserGroups()  : void
updateUsersDatasetFilter()  : void
updateUserSetPasswordToken()  : UpdateResult

Properties

$objectType

protected string $objectType = \Airlay\Library\Entities\UserEntity::class

Methods

addCoordinatesToUser()

public addCoordinatesToUser(ObjectId $userId, array<string|int, mixed> $coordinates) : UpdateResult
Parameters
$userId : ObjectId
$coordinates : array<string|int, mixed>
Return values
UpdateResult —

addDatasetFiltersToUsers()

public addDatasetFiltersToUsers(array<string|int, ObjectId> $usersIds, array<string|int, mixed> $datasetFilters) : void
Parameters
$usersIds : array<string|int, ObjectId>
$datasetFilters : array<string|int, mixed>

Dataset filters, example ['datasetId' => ObjectId, 'departmentId' => ObjectId, 'filter' => string]

Return values
void —

addDepartmentToUser()

public addDepartmentToUser(ObjectId $userId, ObjectId $departmentId) : UpdateResult
Parameters
$userId : ObjectId
$departmentId : ObjectId
Return values
UpdateResult —

addUserGroup()

public addUserGroup(ObjectId $userId, ObjectId $groupId) : void
Parameters
$userId : ObjectId
$groupId : ObjectId
Return values
void —

deleteByIdAndOrganizationId()

public deleteByIdAndOrganizationId(ObjectId $userId, ObjectId $organizationId) : void
Parameters
$userId : ObjectId
$organizationId : ObjectId
Return values
void —

findAllByOrganizationId()

public findAllByOrganizationId(ObjectId $organizationId) : array<string|int, UserEntity>
Parameters
$organizationId : ObjectId
Return values
array<string|int, UserEntity> —

findByConfirmKey()

public findByConfirmKey(string $key) : UserEntity|null
Parameters
$key : string
Return values
UserEntity|null —

findByDepartmentId()

public findByDepartmentId(ObjectId $id) : array<string|int, UserEntity>
Parameters
$id : ObjectId
Return values
array<string|int, UserEntity> —

findByEmail()

public findByEmail(string $email) : UserEntity|null
Parameters
$email : string
Return values
UserEntity|null —

findByIdAndOrganizationId()

public findByIdAndOrganizationId(ObjectId $id, ObjectId $organizationId) : UserEntity|null
Parameters
$id : ObjectId
$organizationId : ObjectId
Return values
UserEntity|null —

findByIds()

public findByIds(array<string|int, ObjectId> $ids) : array<string|int, UserEntity>
Parameters
$ids : array<string|int, ObjectId>
Return values
array<string|int, UserEntity> —

findByLinkedAccountId()

public findByLinkedAccountId(string $type, string $id) : UserEntity|null
Parameters
$type : string
$id : string
Return values
UserEntity|null —

findByNameAndEmail()

public findByNameAndEmail(string $name, string $email) : UserEntity|null
Parameters
$name : string
$email : string
Return values
UserEntity|null —

findByNames()

public findByNames(array<string|int, string> $names) : array<string|int, UserEntity>
Parameters
$names : array<string|int, string>
Return values
array<string|int, UserEntity> —

findBySetPasswordToken()

public findBySetPasswordToken(string $token) : UserEntity|null
Parameters
$token : string
Return values
UserEntity|null —

findByUserName()

public findByUserName(string $name) : UserEntity|null
Parameters
$name : string
Return values
UserEntity|null —

findUserDatasetFilters()

public findUserDatasetFilters(ObjectId $userId, ObjectId $datasetId[, bool $readFlag = false ]) : array<string|int, mixed>
Parameters
$userId : ObjectId
$datasetId : ObjectId
$readFlag : bool = false
Return values
array<string|int, mixed> —

findUsersByIdsAndOrganizationId()

public findUsersByIdsAndOrganizationId(array<string|int, ObjectId> $ids, ObjectId $organizationId) : array<string|int, UserEntity>
Parameters
$ids : array<string|int, ObjectId>
$organizationId : ObjectId
Return values
array<string|int, UserEntity> —

hasByIdAndOrganizationId()

public hasByIdAndOrganizationId(ObjectId $id, ObjectId $organizationId) : bool
Parameters
$id : ObjectId
$organizationId : ObjectId
Return values
bool —

hasOneByEmail()

public hasOneByEmail(string $email) : bool
Parameters
$email : string
Return values
bool —

hasOneByLinkedAccountIdOrEmail()

public hasOneByLinkedAccountIdOrEmail(string $type, string $linkedAccountId, string $email) : bool
Parameters
$type : string
$linkedAccountId : string
$email : string
Return values
bool —

hasOneByUserName()

public hasOneByUserName(string $name) : bool
Parameters
$name : string
Return values
bool —

removeDatasetFiltersFromUsers()

public removeDatasetFiltersFromUsers(ObjectId $departmentId[, ObjectId|null $datasetId = null ]) : UpdateResult
Parameters
$departmentId : ObjectId
$datasetId : ObjectId|null = null
Return values
UpdateResult —

removeDepartmentFiltersFromUser()

public removeDepartmentFiltersFromUser(ObjectId $userId, ObjectId $departmentId) : UpdateResult
Parameters
$userId : ObjectId
$departmentId : ObjectId
Return values
UpdateResult —

removeDepartmentFromUser()

public removeDepartmentFromUser(ObjectId $userId, ObjectId $departmentId) : UpdateResult
Parameters
$userId : ObjectId
$departmentId : ObjectId
Return values
UpdateResult —

removeDepartmentsFromUsers()

public removeDepartmentsFromUsers(ObjectId $departmentId) : UpdateResult
Parameters
$departmentId : ObjectId
Return values
UpdateResult —

removeGroupFromAllUsers()

public removeGroupFromAllUsers(ObjectId $groupId, array<string|int, mixed> $users) : UpdateResult
Parameters
$groupId : ObjectId
$users : array<string|int, mixed>
Return values
UpdateResult —

removeUserGroup()

public removeUserGroup(ObjectId $groupId, ObjectId $userId) : void
Parameters
$groupId : ObjectId
$userId : ObjectId
Return values
void —

setBlockById()

public setBlockById(ObjectId $userId, bool $value) : void
Parameters
$userId : ObjectId
$value : bool
Return values
void —

setBlockByIds()

public setBlockByIds(array<string|int, mixed> $userIds, bool $value) : void
Parameters
$userIds : array<string|int, mixed>
$value : bool
Return values
void —

setIsPasswordExpirationNotificationSent()

public setIsPasswordExpirationNotificationSent(ObjectId $userId) : void
Parameters
$userId : ObjectId
Return values
void —

setLastActivity()

public setLastActivity(ObjectId $id, int $time) : void
Parameters
$id : ObjectId
$time : int
Return values
void —

setTotpTwoFactoryAuthorization()

public setTotpTwoFactoryAuthorization(ObjectId $userId) : void
Parameters
$userId : ObjectId
Return values
void —

setUserPassword()

public setUserPassword(ObjectId $userId, string $passwordHash) : UpdateResult
Parameters
$userId : ObjectId
$passwordHash : string
Return values
UpdateResult —

setUserUpdateTime()

public setUserUpdateTime(ObjectId $userId, int $time) : void
Parameters
$userId : ObjectId
$time : int
Return values
void —

updateUserGroups()

public updateUserGroups(ObjectId $userId, array<string|int, mixed> $groupsIds) : void
Parameters
$userId : ObjectId
$groupsIds : array<string|int, mixed>
Return values
void —

updateUsersDatasetFilter()

public updateUsersDatasetFilter(ObjectId $departmentId, ObjectId $datasetId, string $datasetFilter, bool $applyToRead) : void
Parameters
$departmentId : ObjectId
$datasetId : ObjectId
$datasetFilter : string
$applyToRead : bool
Return values
void —

updateUserSetPasswordToken()

public updateUserSetPasswordToken(ObjectId $userId, string $token) : UpdateResult
Parameters
$userId : ObjectId
$token : string
Return values
UpdateResult —

Search results