AirLay backend

SchemeEntity extends DatabaseEntity
in package

Table of Contents

ALLOWED_TYPES  = ['Tracker', 'Collector', 'DataSet']
TYPES_WITH_FIELDS  = ['Collector']
$_id  : ObjectId
$dataSetId  : ObjectId
$fields  : array<string|int, mixed>|null
$icon  : string
$name  : string
$organizationId  : ObjectId
$trackerId  : ObjectId
$type  : string
__construct()  : mixed
__toString()  : string
addFields()  : self
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
createFromArray()  : SchemeEntity
fieldsValidate()  : void
getDataSetId()  : ObjectId
getFields()  : array<string|int, mixed>
getIcon()  : string
getId()  : ObjectId
getName()  : string
getOrganizationId()  : ObjectId
getTrackerId()  : ObjectId
getType()  : string
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
removeFields()  : $this
setDataSetId()  : self
setFields()  : self
setIcon()  : self
setId()  : self
setName()  : self
setTrackerId()  : self
toArray()  : array<string|int, mixed>

Constants

ALLOWED_TYPES

public mixed ALLOWED_TYPES = ['Tracker', 'Collector', 'DataSet']

TYPES_WITH_FIELDS

public mixed TYPES_WITH_FIELDS = ['Collector']

Properties

$fields

private array<string|int, mixed>|null $fields = null

Methods

__construct()

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

__toString()

public __toString() : string
Return values
string —

addFields()

public addFields(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Tags
throws
BadFunctionCallException
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 —

createFromArray()

public static createFromArray(array<string|int, mixed> $data) : SchemeEntity
Parameters
$data : array<string|int, mixed>
Tags
throws
BadFunctionCallException
Return values
SchemeEntity —

fieldsValidate()

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

getDataSetId()

public getDataSetId() : ObjectId
Return values
ObjectId —

getFields()

public getFields() : array<string|int, mixed>
Tags
throws
BadFunctionCallException
Return values
array<string|int, mixed> —

getIcon()

public getIcon() : string
Return values
string —

getName()

public getName() : string
Return values
string —

getOrganizationId()

public getOrganizationId() : ObjectId
Return values
ObjectId —

getTrackerId()

public getTrackerId() : ObjectId
Return values
ObjectId —

getType()

public getType() : string
Return values
string —

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 —

removeFields()

public removeFields(array<string|int, string> $names) : $this
Parameters
$names : array<string|int, string>
Return values
$this —

setDataSetId()

public setDataSetId(ObjectId $dataSetId) : self
Parameters
$dataSetId : ObjectId
Return values
self —

setFields()

public setFields(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Tags
throws
BadFunctionCallException
Return values
self —

setIcon()

public setIcon(string $icon) : self
Parameters
$icon : string
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 —

setTrackerId()

public setTrackerId(ObjectId $trackerId) : self
Parameters
$trackerId : ObjectId
Return values
self —

toArray()

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

Search results