AirLay backend

GroupEntity extends DatabaseEntity
in package

Table of Contents

PERMISSION_CREATE  = 2
PERMISSION_READ  = 1
PERMISSION_UPDATE  = 4
ALLOWED_ADMIN_TYPE  = ['admin', 'guest']
$_id  : ObjectId
$adminType  : string|null
$CMSAccess  : bool
$dataSets  : array<string|int, mixed>
$name  : string
$organizationId  : ObjectId
$permissions  : array<string|int, mixed>
$portals  : array<string|int, mixed>
$users  : array<string|int, mixed>
__construct()  : mixed
__toString()  : string
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
deleteAllDataSets()  : self
deleteAllPortals()  : self
deleteAllUsers()  : self
fromArray()  : GroupEntity
getAdminType()  : string|null
getCMSAccess()  : bool
getDataSets()  : array<string|int, mixed>
getId()  : ObjectId
getName()  : string
getOrganizationId()  : ObjectId
getPermissions()  : array<string|int, mixed>
getPortals()  : array<string|int, mixed>
getUsers()  : array<string|int, mixed>
insertDataSet()  : self
insertPortal()  : self
insertUser()  : self
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
removeDataSet()  : self
removePortal()  : self
removeUser()  : self
setAdminType()  : self
setCMSAccess()  : self
setDataSetAccessMask()  : self
setDataSets()  : self
setId()  : self
setName()  : self
setOrganizationId()  : self
setPermissions()  : self
setPortals()  : self
setUsers()  : self
toArray()  : array<string|int, mixed>

Constants

PERMISSION_CREATE

public mixed PERMISSION_CREATE = 2

PERMISSION_UPDATE

public mixed PERMISSION_UPDATE = 4

ALLOWED_ADMIN_TYPE

private mixed ALLOWED_ADMIN_TYPE = ['admin', 'guest']

Properties

$dataSets

protected array<string|int, mixed> $dataSets = []

$permissions

protected array<string|int, mixed> $permissions = ['issues' => 0, 'milestones' => 0, 'brigades' => 0, 'push' => 0]

$portals

protected array<string|int, mixed> $portals = []

$users

protected array<string|int, mixed> $users = []

Methods

__construct()

public __construct(string $name, ObjectId $organizationId[, ObjectId|null $id = null ]) : mixed
Parameters
$name : string
$organizationId : ObjectId
$id : ObjectId|null = null
Return values
mixed —

__toString()

public __toString() : string
Return values
string —

bsonSerialize()

public bsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

bsonUnserialize()

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

deleteAllDataSets()

public deleteAllDataSets() : self
Return values
self —

deleteAllPortals()

public deleteAllPortals() : self
Return values
self —

deleteAllUsers()

public deleteAllUsers() : self
Return values
self —

getAdminType()

public getAdminType() : string|null
Return values
string|null —

getCMSAccess()

public getCMSAccess() : bool
Return values
bool —

getDataSets()

public getDataSets() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getName()

public getName() : string
Return values
string —

getOrganizationId()

public getOrganizationId() : ObjectId
Return values
ObjectId —

getPermissions()

public getPermissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getPortals()

public getPortals() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUsers()

public getUsers() : array<string|int, mixed>
Return values
array<string|int, mixed> —

insertDataSet()

public insertDataSet(ObjectId $dataSetId, int $accessMask) : self
Parameters
$dataSetId : ObjectId
$accessMask : int
Return values
self —

insertPortal()

public insertPortal(int $id) : self
Parameters
$id : int
Return values
self —

insertUser()

public insertUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

parseObjectId()

public static parseObjectId(mixed $objectId) : ObjectId|null
Parameters
$objectId : mixed
Return values
ObjectId|null —

removeDataSet()

public removeDataSet(ObjectId $id) : self
Parameters
$id : ObjectId
Return values
self —

removePortal()

public removePortal(int $id) : self
Parameters
$id : int
Return values
self —

removeUser()

public removeUser(ObjectId $userId) : self
Parameters
$userId : ObjectId
Return values
self —

setAdminType()

public setAdminType(string|null $adminType) : self
Parameters
$adminType : string|null
Return values
self —

setCMSAccess()

public setCMSAccess(bool $CMSAccess) : self
Parameters
$CMSAccess : bool
Return values
self —

setDataSetAccessMask()

public setDataSetAccessMask(ObjectId $dataSetId, int $accessMask) : self
Parameters
$dataSetId : ObjectId
$accessMask : int
Return values
self —

setDataSets()

public setDataSets(array<string|int, mixed> $dataSets) : self
Parameters
$dataSets : array<string|int, mixed>
Return values
self —

setId()

public setId(ObjectId $id) : self
Parameters
$id : ObjectId
Return values
self —

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self —

setOrganizationId()

public setOrganizationId(ObjectId $organizationId) : self
Parameters
$organizationId : ObjectId
Return values
self —

setPermissions()

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

setPortals()

public setPortals(array<string|int, mixed> $portals) : self
Parameters
$portals : array<string|int, mixed>
Return values
self —

setUsers()

public setUsers(array<string|int, mixed> $users) : self
Parameters
$users : array<string|int, mixed>
Return values
self —

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results