DepartmentsCollection
extends BaseCollection
in package
Class DepartmentsCollection.
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
- addChildToDepartment() : UpdateResult
- addContact() : UpdateResult
- addDatasetToDepartment() : UpdateResult
- addToCache() : void
- addUserToDepartment() : UpdateResult
- aggregate() : Traversable
- bulkWrite() : bool
- cacheCount() : int
- clearCache() : void
- count() : int
- createIndex() : void
- createIndexes() : void
- createIndexesWithValues() : void
- delete() : DeleteResult
- deleteAll() : DeleteResult
- deleteById() : DeleteResult
- deleteDepartments() : void
- deleteFiltersByDataSet() : void
- deleteOne() : DeleteResult
- distinct() : array<string|int, mixed>
- drop() : void
- dropIndexByName() : void
- dropIndexes() : void
- find() : mixed
- findAll() : array<string|int, mixed>
- findAndDeleteById() : object|null
- findByCode() : DepartmentEntity|null
- findById() : mixed
- findByIds() : array<string|int, DepartmentEntity>
- findByOrganizationId() : array<string|int, DepartmentEntity>
- findByUserId() : array<string|int, DepartmentEntity>
- findChildrenDepartmentsRestrictByUserId() : mixed
- findChildrenIds() : array<string|int, ObjectId>
- findDepartmentsWithChildrenByUserId() : array<string|int, DepartmentEntity>
- findDepartmentUsersRecursiveByUserId() : array<string|int, UserEntity>
- findInCache() : mixed
- findOne() : null|mixed
- findOrganizationDepartmentById() : DepartmentEntity|null
- findParentById() : DepartmentEntity
- findWithCursor() : Cursor
- flush() : void
- getCollectionName() : string
- getCollectionSize() : int|float
- getCollectionStats() : array<string|int, mixed>
- getDepartmentsWithCoordinatesAndParents() : array<string|int, mixed>
- getFilterByIdAndDataSetId() : string
- getIndexes() : array<string|int, IndexInfo>
- getUniqueValues() : array<string|int, mixed>
- hasByIdAndOrganizationId() : bool
- hasInCache() : bool
- hasIndex() : bool
- hasOne() : bool
- insertMany() : bool
- insertOne() : bool
- isEmployeeOfChildrenDepartment() : bool
- isEmployeeOfParentDepartment() : bool
- removeContact() : UpdateResult
- removeDatasetFromAllDepartments() : UpdateResult
- removeDatasetFromDepartment() : UpdateResult
- removeFromParent() : void
- removeUserFromAllDepartments() : UpdateResult
- removeUserFromDepartment() : UpdateResult
- save() : bool
- update() : UpdateResult
- updateCode() : void
- updateCoordinates() : void
- updateEmails() : UpdateResult
- updateFilterOfDataset() : UpdateResult
- updateName() : void
- 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\DepartmentEntity::class
$typeMap
protected
array<string|int, mixed>
$typeMap
Methods
__construct()
public
__construct() : mixed
Return values
mixed —addChildToDepartment()
public
addChildToDepartment(ObjectId $parentId, ObjectId $childId[, int|null $position = null ]) : UpdateResult
Parameters
- $parentId : ObjectId
- $childId : ObjectId
- $position : int|null = null
Return values
UpdateResult —addContact()
public
addContact(ObjectId $departmentId, string $type, string $value) : UpdateResult
Parameters
- $departmentId : ObjectId
- $type : string
- $value : string
Return values
UpdateResult —addDatasetToDepartment()
public
addDatasetToDepartment(ObjectId $departmentId, array<string|int, mixed> $dataset) : UpdateResult
Parameters
- $departmentId : ObjectId
- $dataset : array<string|int, mixed>
Return values
UpdateResult —addToCache()
public
addToCache(ObjectId $id[, mixed $entity = null ]) : void
Parameters
- $id : ObjectId
- $entity : mixed = null
Return values
void —addUserToDepartment()
public
addUserToDepartment(ObjectId $departmentId, ObjectId $userId) : UpdateResult
Parameters
- $departmentId : ObjectId
- $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 —deleteDepartments()
public
deleteDepartments(array<string|int, ObjectId> $departmentsIds) : void
Parameters
- $departmentsIds : array<string|int, ObjectId>
Return values
void —deleteFiltersByDataSet()
public
deleteFiltersByDataSet(ObjectId $dataSetId) : void
Parameters
- $dataSetId : 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> —findAndDeleteById()
public
findAndDeleteById(ObjectId $id) : object|null
Parameters
- $id : ObjectId
Return values
object|null —findByCode()
public
findByCode(string $departmentCode) : DepartmentEntity|null
Parameters
- $departmentCode : string
Return values
DepartmentEntity|null —findById()
public
findById(ObjectId $id[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $id : ObjectId
- $options : array<string|int, mixed> = []
Return values
mixed —findByIds()
public
findByIds(array<string|int, ObjectId> $departmentsIds) : array<string|int, DepartmentEntity>
Parameters
- $departmentsIds : array<string|int, ObjectId>
Return values
array<string|int, DepartmentEntity> —findByOrganizationId()
public
findByOrganizationId(ObjectId $organizationId) : array<string|int, DepartmentEntity>
Parameters
- $organizationId : ObjectId
Return values
array<string|int, DepartmentEntity> —findByUserId()
public
findByUserId(ObjectId $userId) : array<string|int, DepartmentEntity>
Parameters
- $userId : ObjectId
Return values
array<string|int, DepartmentEntity> —findChildrenDepartmentsRestrictByUserId()
public
findChildrenDepartmentsRestrictByUserId(ObjectId $departmentId, ObjectId $userId) : mixed
Parameters
- $departmentId : ObjectId
- $userId : ObjectId
Return values
mixed —findChildrenIds()
public
findChildrenIds(ObjectId $parentId) : array<string|int, ObjectId>
Parameters
- $parentId : ObjectId
Return values
array<string|int, ObjectId> —findDepartmentsWithChildrenByUserId()
public
findDepartmentsWithChildrenByUserId(ObjectId $userId) : array<string|int, DepartmentEntity>
Parameters
- $userId : ObjectId
Return values
array<string|int, DepartmentEntity> —findDepartmentUsersRecursiveByUserId()
public
findDepartmentUsersRecursiveByUserId(ObjectId $userId) : array<string|int, UserEntity>
Parameters
- $userId : ObjectId
Return values
array<string|int, UserEntity> —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 —findOrganizationDepartmentById()
public
findOrganizationDepartmentById(ObjectId $departmentId, ObjectId $organizationId) : DepartmentEntity|null
Parameters
- $departmentId : ObjectId
- $organizationId : ObjectId
Return values
DepartmentEntity|null —findParentById()
public
findParentById(ObjectId $id) : DepartmentEntity
Parameters
- $id : ObjectId
Return values
DepartmentEntity —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> —getDepartmentsWithCoordinatesAndParents()
public
getDepartmentsWithCoordinatesAndParents(array<string|int, ObjectId> $departmentIds) : array<string|int, mixed>
Parameters
- $departmentIds : array<string|int, ObjectId>
Return values
array<string|int, mixed> —getFilterByIdAndDataSetId()
public
getFilterByIdAndDataSetId(ObjectId $id, ObjectId $dataSetId) : string
Parameters
- $id : ObjectId
- $dataSetId : ObjectId
Return values
string —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 —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 —isEmployeeOfChildrenDepartment()
public
isEmployeeOfChildrenDepartment(ObjectId $userId, ObjectId $departmentId) : bool
Parameters
- $userId : ObjectId
- $departmentId : ObjectId
Return values
bool —isEmployeeOfParentDepartment()
public
isEmployeeOfParentDepartment(ObjectId $userId, ObjectId $departmentId) : bool
Parameters
- $userId : ObjectId
- $departmentId : ObjectId
Return values
bool —removeContact()
public
removeContact(ObjectId $departmentId, string $type, string $value) : UpdateResult
Parameters
- $departmentId : ObjectId
- $type : string
- $value : string
Return values
UpdateResult —removeDatasetFromAllDepartments()
public
removeDatasetFromAllDepartments(ObjectId $datasetId) : UpdateResult
Parameters
- $datasetId : ObjectId
Return values
UpdateResult —removeDatasetFromDepartment()
public
removeDatasetFromDepartment(ObjectId $departmentId, ObjectId $datasetId) : UpdateResult
Parameters
- $departmentId : ObjectId
- $datasetId : ObjectId
Return values
UpdateResult —removeFromParent()
public
removeFromParent(ObjectId $id) : void
Parameters
- $id : ObjectId
Return values
void —removeUserFromAllDepartments()
public
removeUserFromAllDepartments(ObjectId $userId) : UpdateResult
Parameters
- $userId : ObjectId
Return values
UpdateResult —removeUserFromDepartment()
public
removeUserFromDepartment(ObjectId $departmentId, ObjectId $userId) : UpdateResult
Parameters
- $departmentId : ObjectId
- $userId : ObjectId
Return values
UpdateResult —save()
public
save(mixed $data) : bool
Parameters
- $data : mixed
Return values
bool —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 —updateCode()
public
updateCode(ObjectId $departmentId, string $code) : void
Parameters
- $departmentId : ObjectId
- $code : string
Return values
void —updateCoordinates()
public
updateCoordinates(ObjectId $departmentId, array<string|int, mixed> $coordinates) : void
Parameters
- $departmentId : ObjectId
- $coordinates : array<string|int, mixed>
Return values
void —updateEmails()
public
updateEmails(ObjectId $departmentId, array<string|int, string> $emails) : UpdateResult
Parameters
- $departmentId : ObjectId
- $emails : array<string|int, string>
Return values
UpdateResult —updateFilterOfDataset()
public
updateFilterOfDataset(ObjectId $departmentId, array<string|int, mixed> $dataset) : UpdateResult
Parameters
- $departmentId : ObjectId
- $dataset : array<string|int, mixed>
Return values
UpdateResult —updateName()
public
updateName(ObjectId $departmentId, string $name) : void
Parameters
- $departmentId : ObjectId
- $name : string
Return values
void —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 = []