GroupsCollection
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
- addDataSetToAdminGroups() : void
- addDataSetToGroup() : void
- addDataSetToUserGroups() : void
- addPortal() : void
- addPortalToAdminGroup() : void
- addToCache() : void
- addUsersToGroup() : void
- addUserToGroup() : void
- addUserToGroups() : UpdateResult
- aggregate() : Traversable
- bulkWrite() : bool
- cacheCount() : int
- clearCache() : void
- count() : int
- createIndex() : void
- createIndexes() : void
- createIndexesWithValues() : void
- delete() : DeleteResult
- deleteAll() : DeleteResult
- deleteById() : DeleteResult
- deleteGroups() : void
- deleteOne() : DeleteResult
- distinct() : array<string|int, mixed>
- drop() : void
- dropIndexByName() : void
- dropIndexes() : void
- find() : mixed
- findAll() : array<string|int, mixed>
- findAndDeleteById() : object|null
- findById() : mixed
- findByIdAndOrganizationId() : GroupEntity|null
- findByIds() : array<string|int, GroupEntity>
- findByNames() : array<string|int, GroupEntity>
- findByNamesAndOrganizationId() : array<string|int, GroupEntity>
- findByOrganizationId() : array<string|int, mixed>
- findByUserId() : array<string|int, GroupEntity>
- findByUserIdAndDataSetId() : array<string|int, GroupEntity>
- findByUserIdAndDataSetIdAndOrganizationId() : array<string|int, GroupEntity>
- findGroupsByIdsAndOrganizationId() : array<string|int, GroupEntity>
- findGuestGroupByDataSetId() : GroupEntity|null
- findGuestGroupByDataSetIdAndOrganizationId() : GroupEntity|null
- findGuestGroupByOrganizationId() : GroupEntity|null
- findInCache() : mixed
- findOne() : null|mixed
- findWithCursor() : Cursor
- flush() : void
- getCollectionName() : string
- getCollectionSize() : int|float
- getCollectionStats() : array<string|int, mixed>
- getIndexes() : array<string|int, IndexInfo>
- getUniqueValues() : array<string|int, mixed>
- getUserAccessMaskByUserIdAndType() : int
- hasByIdAndOrganizationId() : bool
- hasByIdAndUserId() : bool
- hasByUserIdAndAdminType() : bool
- hasDataSetById() : bool
- hasInCache() : bool
- hasIndex() : bool
- hasOne() : bool
- insertMany() : bool
- insertOne() : bool
- removeDataSetFromAllGroups() : void
- removeDataSetFromGroup() : void
- removePortalFromAllGroups() : void
- removePortalFromGroup() : void
- removeUserFromAllOrganizationGroups() : void
- removeUserFromGroup() : void
- save() : bool
- setPermissions() : void
- update() : UpdateResult
- updateOne() : 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\GroupEntity::class
$typeMap
protected
array<string|int, mixed>
$typeMap
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addDataSetToAdminGroups()
public
addDataSetToAdminGroups(ObjectId $dataSetId, ObjectId $organizationId) : void
Parameters
- $dataSetId : ObjectId
- $organizationId : ObjectId
Return values
void —addDataSetToGroup()
public
addDataSetToGroup(ObjectId $groupId, ObjectId $dataSetId, int $accessMask) : void
Parameters
- $groupId : ObjectId
- $dataSetId : ObjectId
- $accessMask : int
Return values
void —addDataSetToUserGroups()
public
addDataSetToUserGroups(DataSetEntity $dataSet, array<string|int, mixed> $groups) : void
Parameters
- $dataSet : DataSetEntity
- $groups : array<string|int, mixed>
Return values
void —addPortal()
public
addPortal(ObjectId $groupId, int $portalId) : void
Parameters
- $groupId : ObjectId
- $portalId : int
Return values
void —addPortalToAdminGroup()
public
addPortalToAdminGroup(int $portalId, ObjectId $organizationId) : void
Parameters
- $portalId : int
- $organizationId : ObjectId
Return values
void —addToCache()
public
addToCache(ObjectId $id[, mixed $entity = null ]) : void
Parameters
- $id : ObjectId
- $entity : mixed = null
Return values
void —addUsersToGroup()
public
addUsersToGroup(ObjectId $groupId, array<string|int, mixed> $usersIds) : void
Parameters
- $groupId : ObjectId
- $usersIds : array<string|int, mixed>
Return values
void —addUserToGroup()
public
addUserToGroup(ObjectId $groupId, ObjectId $userId) : void
Parameters
- $groupId : ObjectId
- $userId : ObjectId
Return values
void —addUserToGroups()
public
addUserToGroups(array<string|int, mixed> $groupsIds, ObjectId $userId) : UpdateResult
Parameters
- $groupsIds : array<string|int, mixed>
- $userId : ObjectId
Return values
UpdateResult —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 —deleteGroups()
public
deleteGroups(array<string|int, mixed> $groups) : void
Parameters
- $groups : array<string|int, mixed>
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> —findAndDeleteById()
public
findAndDeleteById(ObjectId $id) : object|null
Parameters
- $id : ObjectId
Return values
object|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(mixed $groupId, ObjectId $organizationId) : GroupEntity|null
Parameters
- $groupId : mixed
- $organizationId : ObjectId
Return values
GroupEntity|null —findByIds()
public
findByIds(array<string|int, ObjectId> $ids) : array<string|int, GroupEntity>
Parameters
- $ids : array<string|int, ObjectId>
Return values
array<string|int, GroupEntity> —findByNames()
public
findByNames(array<string|int, string> $names) : array<string|int, GroupEntity>
Parameters
- $names : array<string|int, string>
Return values
array<string|int, GroupEntity> —findByNamesAndOrganizationId()
public
findByNamesAndOrganizationId(array<string|int, mixed> $groupsNames, ObjectId $organizationId) : array<string|int, GroupEntity>
Parameters
- $groupsNames : array<string|int, mixed>
- $organizationId : ObjectId
Return values
array<string|int, GroupEntity> —findByOrganizationId()
public
findByOrganizationId(ObjectId $organizationId) : array<string|int, mixed>
Parameters
- $organizationId : ObjectId
Return values
array<string|int, mixed> —findByUserId()
public
findByUserId(ObjectId $userId) : array<string|int, GroupEntity>
Parameters
- $userId : ObjectId
Return values
array<string|int, GroupEntity> —findByUserIdAndDataSetId()
public
findByUserIdAndDataSetId(ObjectId|int $userId, ObjectId $dataSetId) : array<string|int, GroupEntity>
Parameters
- $userId : ObjectId|int
- $dataSetId : ObjectId
Return values
array<string|int, GroupEntity> —findByUserIdAndDataSetIdAndOrganizationId()
public
findByUserIdAndDataSetIdAndOrganizationId(ObjectId $userId, ObjectId $dataSetId, ObjectId $organizationId) : array<string|int, GroupEntity>
Parameters
- $userId : ObjectId
- $dataSetId : ObjectId
- $organizationId : ObjectId
Return values
array<string|int, GroupEntity> —findGroupsByIdsAndOrganizationId()
public
findGroupsByIdsAndOrganizationId(array<string|int, ObjectId> $ids, ObjectId $organizationId) : array<string|int, GroupEntity>
Parameters
- $ids : array<string|int, ObjectId>
- $organizationId : ObjectId
Return values
array<string|int, GroupEntity> —findGuestGroupByDataSetId()
public
findGuestGroupByDataSetId(ObjectId $dataSetId) : GroupEntity|null
Parameters
- $dataSetId : ObjectId
Return values
GroupEntity|null —findGuestGroupByDataSetIdAndOrganizationId()
public
findGuestGroupByDataSetIdAndOrganizationId(ObjectId $datSetId, ObjectId $organizationId) : GroupEntity|null
Parameters
- $datSetId : ObjectId
- $organizationId : ObjectId
Return values
GroupEntity|null —findGuestGroupByOrganizationId()
public
findGuestGroupByOrganizationId(ObjectId $organizationId) : GroupEntity|null
Parameters
- $organizationId : ObjectId
Return values
GroupEntity|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 —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> —getUserAccessMaskByUserIdAndType()
public
getUserAccessMaskByUserIdAndType(ObjectId $userId, ObjectId $organizationId, string $type) : int
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
- $type : string
Return values
int —hasByIdAndOrganizationId()
public
hasByIdAndOrganizationId(ObjectId $id, ObjectId $organizationId) : bool
Parameters
- $id : ObjectId
- $organizationId : ObjectId
Return values
bool —hasByIdAndUserId()
public
hasByIdAndUserId(ObjectId $groupId, ObjectId $userId) : bool
Parameters
- $groupId : ObjectId
- $userId : ObjectId
Return values
bool —hasByUserIdAndAdminType()
public
hasByUserIdAndAdminType(ObjectId $userId, string $adminType) : bool
Parameters
- $userId : ObjectId
- $adminType : string
Return values
bool —hasDataSetById()
public
hasDataSetById(ObjectId $groupId, ObjectId $dataSetId) : bool
Parameters
- $groupId : ObjectId
- $dataSetId : 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 —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 —removeDataSetFromAllGroups()
public
removeDataSetFromAllGroups(ObjectId $dataSetId) : void
Parameters
- $dataSetId : ObjectId
Return values
void —removeDataSetFromGroup()
public
removeDataSetFromGroup(ObjectId $groupId, ObjectId $dataSetId) : void
Parameters
- $groupId : ObjectId
- $dataSetId : ObjectId
Return values
void —removePortalFromAllGroups()
public
removePortalFromAllGroups(int $portalId) : void
Parameters
- $portalId : int
Return values
void —removePortalFromGroup()
public
removePortalFromGroup(ObjectId $groupId, int $portalId) : void
Parameters
- $groupId : ObjectId
- $portalId : int
Return values
void —removeUserFromAllOrganizationGroups()
public
removeUserFromAllOrganizationGroups(ObjectId $userId, ObjectId $organizationId) : void
Parameters
- $userId : ObjectId
- $organizationId : ObjectId
Return values
void —removeUserFromGroup()
public
removeUserFromGroup(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 —setPermissions()
public
setPermissions(ObjectId $groupId, array<string|int, mixed> $permissions) : void
Parameters
- $groupId : ObjectId
- $permissions : array<string|int, mixed>
Return values
void —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 = []