DepartmentsCollection
extends BaseCollection
in package
Class DepartmentsCollection.
Table of Contents
- $objectType : string
- __construct() : mixed
- addChildToDepartment() : UpdateResult
- addDatasetToDepartment() : UpdateResult
- addUserToDepartment() : UpdateResult
- deleteDepartments() : void
- deleteFiltersByDataSet() : void
- findByCode() : DepartmentEntity|null
- 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>
- findOrganizationDepartmentById() : DepartmentEntity|null
- findParentById() : DepartmentEntity|null
- getDepartmentsWithCoordinatesAndParents() : array<string|int, mixed>
- getFilterByIdAndDataSetId() : string
- hasByIdAndOrganizationId() : bool
- isEmployeeOfChildrenDepartment() : bool
- isEmployeeOfParentDepartment() : bool
- removeDatasetFromAllDepartments() : UpdateResult
- removeDatasetFromDepartment() : UpdateResult
- removeFromParent() : void
- removeProjectFromAllDepartments() : void
- removeUserFromAllDepartments() : UpdateResult
- removeUserFromDepartment() : UpdateResult
- updateCode() : void
- updateCoordinates() : void
- updateEmails() : UpdateResult
- updateFilterOfDataset() : UpdateResult
- updateName() : void
Properties
$objectType
protected
string
$objectType
= \Airlay\Library\Entities\DepartmentEntity::class
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 —addDatasetToDepartment()
public
addDatasetToDepartment(ObjectId $departmentId, array<string|int, mixed> $dataset) : UpdateResult
Parameters
- $departmentId : ObjectId
- $dataset : array<string|int, mixed>
Return values
UpdateResult —addUserToDepartment()
public
addUserToDepartment(ObjectId $departmentId, ObjectId $userId) : UpdateResult
Parameters
- $departmentId : ObjectId
- $userId : ObjectId
Return values
UpdateResult —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 —findByCode()
public
findByCode(string $departmentCode) : DepartmentEntity|null
Parameters
- $departmentCode : string
Return values
DepartmentEntity|null —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> —findOrganizationDepartmentById()
public
findOrganizationDepartmentById(ObjectId $departmentId, ObjectId $organizationId) : DepartmentEntity|null
Parameters
- $departmentId : ObjectId
- $organizationId : ObjectId
Return values
DepartmentEntity|null —findParentById()
public
findParentById(ObjectId $id) : DepartmentEntity|null
Parameters
- $id : ObjectId
Return values
DepartmentEntity|null —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 —hasByIdAndOrganizationId()
public
hasByIdAndOrganizationId(ObjectId $id, ObjectId $organizationId) : bool
Parameters
- $id : ObjectId
- $organizationId : ObjectId
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 —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 —removeProjectFromAllDepartments()
public
removeProjectFromAllDepartments(ObjectId $projectId) : void
Parameters
- $projectId : 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 —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