AirLay backend

BrigadeEntity extends DatabaseEntity
in package

Table of Contents

AVAILABLE_TYPES  = ['user', 'device']
$_id  : ObjectId
$departmentId  : ObjectId|null
$image  : array<string|int, mixed>
$members  : array<string|int, mixed>
$name  : string
$organizationId  : ObjectId
$properties  : array<string|int, mixed>
__construct()  : mixed
__toString()  : string
addMember()  : self
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
fromArray()  : BrigadeEntity
getDepartmentId()  : ObjectId|null
getId()  : ObjectId
getImage()  : array<string|int, mixed>
getMembers()  : array<string|int, mixed>
getName()  : string
getOrganizationId()  : ObjectId
getProperties()  : array<string|int, mixed>
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
removeMember()  : self
setDepartmentId()  : self
setId()  : self
setImage()  : self
setMembers()  : self
setName()  : self
setOrganizationId()  : self
setProperties()  : self
toArray()  : array<string|int, mixed>

Constants

AVAILABLE_TYPES

public mixed AVAILABLE_TYPES = ['user', 'device']

Properties

$properties

private array<string|int, mixed> $properties = []

Methods

__construct()

public __construct(string $name, ObjectId $organizationId, ObjectId|null $departmentId[, array<string|int, mixed> $properties = [] ][, ObjectId|null $id = null ]) : mixed
Parameters
$name : string
$organizationId : ObjectId
$departmentId : ObjectId|null
$properties : array<string|int, mixed> = []
$id : ObjectId|null = null
Return values
mixed —

__toString()

public __toString() : string
Return values
string —

addMember()

public addMember(string $type, ObjectId $id[, ObjectId|null $dataSetId = null ]) : self
Parameters
$type : string
$id : ObjectId
$dataSetId : ObjectId|null = null
Return values
self —

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 —

getDepartmentId()

public getDepartmentId() : ObjectId|null
Return values
ObjectId|null —

getImage()

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

getMembers()

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

getName()

public getName() : string
Return values
string —

getOrganizationId()

public getOrganizationId() : ObjectId
Return values
ObjectId —

getProperties()

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

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 —

removeMember()

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

setDepartmentId()

public setDepartmentId(ObjectId|null $departmentId) : self
Parameters
$departmentId : ObjectId|null
Return values
self —

setId()

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

setImage()

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

setMembers()

public setMembers(array<string|int, mixed> $members) : self
Parameters
$members : array<string|int, mixed>
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 —

setProperties()

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

toArray()

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

Search results