AirLay backend

FilterEntity extends DatabaseEntity
in package

Table of Contents

ALLOWED_TYPES  = ['string', 'number', 'date']
$_id  : ObjectId
$dataSetsIds  : array<string|int, mixed>
$filterByIssue  : bool
$items  : array<string|int, mixed>
$name  : string
$organizationId  : ObjectId
__construct()  : mixed
__toString()  : string
addDataSetId()  : self
addItem()  : self
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
fromArray()  : FilterEntity
getDataSetsIds()  : array<string|int, ObjectId>
getFilterByIssue()  : bool
getId()  : ObjectId
getItems()  : array<string|int, mixed>
getName()  : string
getOrganizationId()  : ObjectId
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
removeDataSetId()  : self
removeItem()  : self
replaceItem()  : self
setDataSetsIds()  : $this
setFilterByIssue()  : self
setId()  : self
setItems()  : $this
setName()  : self
setOrganizationId()  : self
findItemIndex()  : int
toArray()  : array<string|int, mixed>

Constants

ALLOWED_TYPES

private mixed ALLOWED_TYPES = ['string', 'number', 'date']

Properties

$dataSetsIds

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

Methods

__construct()

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

__toString()

public __toString() : string
Return values
string —

addDataSetId()

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

addItem()

public addItem(string $field, string $type, string $alias[, string|null $default = null ][, string|null $player = null ]) : self
Parameters
$field : string
$type : string
$alias : string
$default : string|null = null
$player : string|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 —

getDataSetsIds()

public getDataSetsIds() : array<string|int, ObjectId>
Return values
array<string|int, ObjectId> —

getFilterByIssue()

public getFilterByIssue() : bool
Return values
bool —

getItems()

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

getName()

public getName() : string
Return values
string —

getOrganizationId()

public getOrganizationId() : ObjectId
Return values
ObjectId —

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 —

removeDataSetId()

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

removeItem()

public removeItem(string $field, string $type, string $alias[, string|null $default = null ][, string|null $player = null ]) : self
Parameters
$field : string
$type : string
$alias : string
$default : string|null = null
$player : string|null = null
Return values
self —

replaceItem()

public replaceItem(string $oldField, string $oldType, string $oldAlias, string $field, string $type, string $alias[, string|null $oldDefault = null ][, string|null $default = null ][, string|null $oldPlayer = null ][, string|null $player = null ]) : self
Parameters
$oldField : string
$oldType : string
$oldAlias : string
$field : string
$type : string
$alias : string
$oldDefault : string|null = null
$default : string|null = null
$oldPlayer : string|null = null
$player : string|null = null
Return values
self —

setDataSetsIds()

public setDataSetsIds(array<string|int, ObjectId> $dataSetsIds) : $this
Parameters
$dataSetsIds : array<string|int, ObjectId>
Return values
$this —

setFilterByIssue()

public setFilterByIssue(bool $filterByIssue) : self
Parameters
$filterByIssue : bool
Return values
self —

setId()

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

setItems()

public setItems(array<string|int, mixed> $items) : $this
Parameters
$items : array<string|int, mixed>
Return values
$this —

setName()

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

setOrganizationId()

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

findItemIndex()

private findItemIndex(string $field, string $type, string $alias[, string|null $default = null ][, string|null $player = null ]) : int
Parameters
$field : string
$type : string
$alias : string
$default : string|null = null
$player : string|null = null
Return values
int —

toArray()

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

Search results