UsersCollection
extends BaseCollection
in package
Class BaseCollection.
Table of Contents
- DEFAULT_SORT = ['_id' => 1]
- DEFAULT_TYPE_MAP = ['root' => 'array', 'document' => 'array', 'array' => 'array']
- $mongoDbManager : Manager
- $bulkWrite : BulkWrite
- $cache : array<string|int, mixed>
- $collection : Collection
- $collectionName : string
- $databaseName : string
- $objectType : string
- $typeMap : array<string|int, mixed>
- __construct() : mixed
- addCoordinatesToUser() : UpdateResult
- addDatasetFiltersToUsers() : void
- addDepartmentToUser() : UpdateResult
- addToCache() : void
- addUserGroup() : void
- aggregate() : Traversable
- bulkWrite() : bool
- cacheCount() : int
- clearCache() : void
- count() : int
- createIndex() : void
- createIndexes() : void
- createIndexesWithValues() : void
- delete() : DeleteResult
- deleteAll() : DeleteResult
- deleteById() : DeleteResult
- deleteByIdAndOrganizationId() : void
- deleteOne() : DeleteResult
- distinct() : array<string|int, mixed>
- drop() : void
- dropIndexByName() : void
- dropIndexes() : void
- find() : mixed
- findAll() : array<string|int, mixed>
- findAllByOrganizationId() : array<string|int, UserEntity>
- findAndDeleteById() : object|null
- findByConfirmKey() : UserEntity|null
- findByDepartmentId() : array<string|int, UserEntity>
- findByEmail() : UserEntity|null
- findById() : mixed
- 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
- findInCache() : mixed
- findOne() : null|mixed
- findUserDatasetFilters() : array<string|int, mixed>
- findUsersByIdsAndOrganizationId() : array<string|int, UserEntity>
- findWithCursor() : Cursor
- flush() : void
- getCollectionName() : string
- getCollectionSize() : int|float
- getCollectionStats() : array<string|int, mixed>
- getIndexes() : array<string|int, IndexInfo>
- getUniqueValues() : array<string|int, mixed>
- hasByIdAndOrganizationId() : bool
- hasInCache() : bool
- hasIndex() : bool
- hasOne() : bool
- hasOneByEmail() : bool
- hasOneByLinkedAccountIdOrEmail() : bool
- hasOneByUserName() : bool
- insertMany() : bool
- insertOne() : bool
- removeDatasetFiltersFromUsers() : UpdateResult
- removeDepartmentFiltersFromUser() : UpdateResult
- removeDepartmentFromUser() : UpdateResult
- removeDepartmentsFromUsers() : UpdateResult
- removeGroupFromAllUsers() : UpdateResult
- removeUserGroup() : void
- save() : bool
- setBlockById() : void
- setTotpTwoFactoryAuthorization() : void
- setUserPassword() : UpdateResult
- update() : UpdateResult
- updateOne() : UpdateResult
- updateUserGroups() : void
- updateUsersDatasetFilter() : void
- updateUserSetPasswordToken() : UpdateResult
Constants
DEFAULT_SORT
public
mixed
DEFAULT_SORT
= ['_id' => 1]
DEFAULT_TYPE_MAP
public
mixed
DEFAULT_TYPE_MAP
= ['root' => 'array', 'document' => 'array', 'array' => 'array']
Properties
$mongoDbManager
public
Manager
$mongoDbManager
$bulkWrite
protected
BulkWrite
$bulkWrite
$cache
protected
array<string|int, mixed>
$cache
= []
$collection
protected
Collection
$collection
$collectionName
protected
string
$collectionName
$databaseName
protected
string
$databaseName
$objectType
protected
string
$objectType
= \Airlay\Library\Entities\UserEntity::class
$typeMap
protected
array<string|int, mixed>
$typeMap
Methods
__construct()
public
__construct() : mixed
Return values
mixed —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 —addToCache()
public
addToCache(ObjectId $id[, mixed $entity = null ]) : void
Parameters
- $id : ObjectId
- $entity : mixed = null
Return values
void —addUserGroup()
public
addUserGroup(ObjectId $userId, ObjectId $groupId) : void
Parameters
- $userId : ObjectId
- $groupId : ObjectId
Return values
void —aggregate()
public
aggregate(array<string|int, mixed> $pipeline[, array<string|int, mixed> $options = [] ]) : Traversable
Parameters
- $pipeline : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
Traversable —bulkWrite()
public
bulkWrite(array<string|int, mixed> $operations[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $operations : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —cacheCount()
public
cacheCount() : int
Return values
int —clearCache()
public
clearCache() : void
Return values
void —count()
public
count([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : int
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Return values
int —createIndex()
public
createIndex(array<string|int, mixed>|object $key, array<string|int, mixed> $options) : void
Parameters
- $key : array<string|int, mixed>|object
- $options : array<string|int, mixed>
Return values
void —createIndexes()
public
createIndexes(array<string|int, string> $indexesFields) : void
Parameters
- $indexesFields : array<string|int, string>
Return values
void —createIndexesWithValues()
public
createIndexesWithValues(array<string|int, mixed> $indexes) : void
Parameters
- $indexes : array<string|int, mixed>
-
= [ ['index' => 'value'], ['index' => 'value'] . . . ]
Return values
void —delete()
public
delete(array<string|int, mixed> $filter) : DeleteResult
Parameters
- $filter : array<string|int, mixed>
Return values
DeleteResult —deleteAll()
public
deleteAll() : DeleteResult
Return values
DeleteResult —deleteById()
public
deleteById(ObjectId $id) : DeleteResult
Parameters
- $id : ObjectId
Return values
DeleteResult —deleteByIdAndOrganizationId()
public
deleteByIdAndOrganizationId(ObjectId $userId, ObjectId $organizationId) : void
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
Return values
void —deleteOne()
public
deleteOne(array<string|int, mixed> $filter) : DeleteResult
Parameters
- $filter : array<string|int, mixed>
Return values
DeleteResult —distinct()
public
distinct(string $field[, mixed $filter = [] ][, mixed $options = [] ]) : array<string|int, mixed>
Parameters
- $field : string
- $filter : mixed = []
- $options : mixed = []
Return values
array<string|int, mixed> —drop()
public
drop() : void
Return values
void —dropIndexByName()
public
dropIndexByName(string $name) : void
Parameters
- $name : string
Return values
void —dropIndexes()
public
dropIndexes() : void
Return values
void —find()
public
find(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
mixed —findAll()
public
findAll([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findAllByOrganizationId()
public
findAllByOrganizationId(ObjectId $organizationId) : array<string|int, UserEntity>
Parameters
- $organizationId : ObjectId
Return values
array<string|int, UserEntity> —findAndDeleteById()
public
findAndDeleteById(ObjectId $id) : object|null
Parameters
- $id : ObjectId
Return values
object|null —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 —findById()
public
findById(ObjectId $id[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $id : ObjectId
- $options : array<string|int, mixed> = []
Return values
mixed —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 —findInCache()
public
findInCache(ObjectId $id) : mixed
Parameters
- $id : ObjectId
Return values
mixed —findOne()
public
findOne(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ]) : null|mixed
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
null|mixed —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> —findWithCursor()
public
findWithCursor([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : Cursor
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Tags
Return values
Cursor —flush()
public
flush() : void
Return values
void —getCollectionName()
public
getCollectionName() : string
Return values
string —getCollectionSize()
public
getCollectionSize() : int|float
Return values
int|float —getCollectionStats()
public
getCollectionStats() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIndexes()
public
getIndexes() : array<string|int, IndexInfo>
Return values
array<string|int, IndexInfo> —getUniqueValues()
public
getUniqueValues(string $field, string $value, int $limit[, array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>
Parameters
- $field : string
- $value : string
- $limit : int
- $filter : array<string|int, mixed> = []
Return values
array<string|int, mixed> —hasByIdAndOrganizationId()
public
hasByIdAndOrganizationId(ObjectId $id, ObjectId $organizationId) : bool
Parameters
- $id : ObjectId
- $organizationId : ObjectId
Return values
bool —hasInCache()
public
hasInCache(ObjectId $id) : bool
Parameters
- $id : ObjectId
Return values
bool —hasIndex()
public
hasIndex(string $name) : bool
Parameters
- $name : string
Return values
bool —hasOne()
public
hasOne(array<string|int, mixed> $filter) : bool
Parameters
- $filter : array<string|int, mixed>
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 —insertMany()
public
insertMany(array<string|int, mixed> $nodes) : bool
Parameters
- $nodes : array<string|int, mixed>
Return values
bool —insertOne()
public
insertOne(mixed $entity) : bool
Parameters
- $entity : mixed
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 —save()
public
save(mixed $data) : bool
Parameters
- $data : mixed
Return values
bool —setBlockById()
public
setBlockById(ObjectId $userId, bool $value) : void
Parameters
- $userId : ObjectId
- $value : bool
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 —update()
public
update(array<string|int, mixed> $filter, array<string|int, mixed> $update[, mixed $options = [] ]) : UpdateResult
Parameters
- $filter : array<string|int, mixed>
- $update : array<string|int, mixed>
- $options : mixed = []
Return values
UpdateResult —updateOne()
public
updateOne(array<string|int, mixed> $filter, array<string|int, mixed> $update[, mixed $options = [] ]) : UpdateResult
Parameters
- $filter : array<string|int, mixed>
- $update : array<string|int, mixed>
- $options : mixed = []
Return values
UpdateResult —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