AirLay backend

GroupsCollection extends BaseCollection
in package

Table of Contents

$objectType  : string
__construct()  : mixed
addDataSetToAdminGroups()  : void
addDataSetToGroup()  : void
addDataSetToUserGroups()  : void
addPortal()  : void
addPortalToAdminGroup()  : void
addProject()  : void
addProjectToAdminGroup()  : void
addUsersToGroup()  : void
addUserToGroup()  : void
addUserToGroups()  : UpdateResult
deleteGroups()  : void
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
findProjectsIdsByUserId()  : array<string|int, mixed>
getUserAccessMaskByUserIdAndType()  : int
hasByIdAndOrganizationId()  : bool
hasByIdAndUserId()  : bool
hasByUserIdAndAdminType()  : bool
hasDataSetById()  : bool
hasOneByProjectsAndUsers()  : bool
removeDataSetFromAllGroups()  : void
removeDataSetFromGroup()  : void
removePortalFromAllGroups()  : void
removePortalFromGroup()  : void
removeProject()  : void
removeProjectFromAllGroups()  : void
removeUserFromAllOrganizationGroups()  : void
removeUserFromGroup()  : void
setPermissions()  : void

Properties

$objectType

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

Methods

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 —

addProject()

public addProject(ObjectId $groupId, ObjectId $projectId) : void
Parameters
$groupId : ObjectId
$projectId : ObjectId
Return values
void —

addProjectToAdminGroup()

public addProjectToAdminGroup(ObjectId $projectId, ObjectId $organizationId) : void
Parameters
$projectId : ObjectId
$organizationId : ObjectId
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 —

deleteGroups()

public deleteGroups(array<string|int, mixed> $groups) : void
Parameters
$groups : array<string|int, mixed>
Return values
void —

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> —

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> —

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 —

findProjectsIdsByUserId()

public findProjectsIdsByUserId(ObjectId $userId) : array<string|int, mixed>
Parameters
$userId : ObjectId
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 —

hasOneByProjectsAndUsers()

public hasOneByProjectsAndUsers(ObjectId $projectId, ObjectId $userId) : bool
Parameters
$projectId : ObjectId
$userId : ObjectId
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 —

removeProject()

public removeProject(ObjectId $groupId, ObjectId $projectId) : void
Parameters
$groupId : ObjectId
$projectId : ObjectId
Return values
void —

removeProjectFromAllGroups()

public removeProjectFromAllGroups(ObjectId $projectId) : void
Parameters
$projectId : ObjectId
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 —

setPermissions()

public setPermissions(ObjectId $groupId, array<string|int, mixed> $permissions) : void
Parameters
$groupId : ObjectId
$permissions : array<string|int, mixed>
Return values
void —

Search results