AirLay backend

SearchingEntity extends DatabaseEntity
in package

Table of Contents

ALLOWED_DATA_SET_TYPES  = ['equal', 'notequal', 'entry', 'start', 'end', 'regexp', 'smart', 'text']
SYSTEM_TYPE  = 'system'
USER_TYPE  = 'user'
$_id  : ObjectId
$backName  : string|null
$dataSets  : array<string|int, mixed>
$examples  : array<string|int, mixed>
$icon  : string
$name  : string
$options  : array<string|int, mixed>
$organizationId  : ObjectId
$type  : string
__construct()  : mixed
__toString()  : string
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
fromArray()  : SearchingEntity
getBackName()  : string
getDataSets()  : array<string|int, mixed>
getExamples()  : array<string|int, string>
getIcon()  : string
getId()  : ObjectId
getName()  : string
getOptions()  : array<string|int, mixed>
getOrganizationId()  : ObjectId
getType()  : string
jsonSerialize()  : array<string|int, mixed>
parseObjectId()  : ObjectId|null
setDataSets()  : self
setExamples()  : $this
setIcon()  : self
setId()  : self
setName()  : self
setOrganizationId()  : self
setType()  : self
toArray()  : array<string|int, mixed>
validateDataSets()  : void
validateIcon()  : void

Constants

ALLOWED_DATA_SET_TYPES

public mixed ALLOWED_DATA_SET_TYPES = ['equal', 'notequal', 'entry', 'start', 'end', 'regexp', 'smart', 'text']

Properties

Methods

__construct()

public __construct(string $name, string $type, ObjectId $organizationId[, string $icon = '' ][, array<string|int, mixed> $dataSets = [] ][, array<string|int, mixed> $examples = [] ][, ObjectId|null $id = null ]) : mixed
Parameters
$name : string
$type : string
$organizationId : ObjectId
$icon : string = ''
$dataSets : array<string|int, mixed> = []
$examples : array<string|int, mixed> = []
$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 —

getBackName()

public getBackName() : string
Return values
string —

getDataSets()

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

getExamples()

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

getOptions()

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

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 —

setDataSets()

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

setExamples()

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

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 —

setOrganizationId()

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

setType()

public setType(string $type) : self
Parameters
$type : string
Return values
self —

toArray()

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

validateDataSets()

private validateDataSets(array<string|int, mixed> $dataSets) : void
Parameters
$dataSets : array<string|int, mixed>
Return values
void —

validateIcon()

private validateIcon(string $icon) : void
Parameters
$icon : string
Return values
void —

Search results