AirLay backend

FeaturesCollection extends BaseCollection
in package

Table of Contents

$objectType  : string
$uniqueField  : string|null
$maxNumberUniqueValue  : int|null
$prefix  : string
$uniqueValueCache  : array<string|int, mixed>
__construct()  : mixed
clearMarkedToDelete()  : void
clearUniqueValueCache()  : void
createDefaultIndexes()  : void
deleteTtlIndex()  : void
find()  : array<string|int, FeatureEntity>
findById()  : FeatureEntity|null
findByIds()  : array<string|int, FeatureEntity>
findByUniqueField()  : FeatureEntity|null
findByUniqueValues()  : array<string|int, FeatureEntity>
findMarkedToDelete()  : array<string|int, FeatureEntity>
flush()  : void
hasOneById()  : bool
insertOne()  : true
replaceOne()  : true
addToUniqueValueCache()  : void
findInUniqueValueCache()  : ObjectId|null
hasInUniqueValueCache()  : bool

Properties

$objectType

protected string $objectType = \Airlay\Library\Entities\FeatureEntity::class

Methods

__construct()

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

clearMarkedToDelete()

public clearMarkedToDelete() : void
Return values
void —

clearUniqueValueCache()

public clearUniqueValueCache() : void
Return values
void —

createDefaultIndexes()

public createDefaultIndexes() : void
Return values
void —

find()

public find(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ][, bool $excludeDeletedObjects = true ][, bool $withUniqueValueCache = true ]) : array<string|int, FeatureEntity>
Parameters
$filter : array<string|int, mixed>
$options : array<string|int, mixed> = []
$excludeDeletedObjects : bool = true
$withUniqueValueCache : bool = true
Return values
array<string|int, FeatureEntity> —

findById()

public findById(ObjectId $id[, array<string|int, mixed> $options = [] ]) : FeatureEntity|null
Parameters
$id : ObjectId
$options : array<string|int, mixed> = []
Return values
FeatureEntity|null —

findByUniqueValues()

public findByUniqueValues(array<string|int, mixed> $values[, array<string|int, mixed> $options = [] ]) : array<string|int, FeatureEntity>
Parameters
$values : array<string|int, mixed>
$options : array<string|int, mixed> = []
Return values
array<string|int, FeatureEntity> —

hasOneById()

public hasOneById(ObjectId $id) : bool
Parameters
$id : ObjectId
Return values
bool —

addToUniqueValueCache()

protected addToUniqueValueCache(string $uniqueValue[, FeatureEntity|null $feature = null ]) : void
Parameters
$uniqueValue : string
$feature : FeatureEntity|null = null
Return values
void —

findInUniqueValueCache()

protected findInUniqueValueCache(string $uniqueValue) : ObjectId|null
Parameters
$uniqueValue : string
Return values
ObjectId|null —

hasInUniqueValueCache()

protected hasInUniqueValueCache(string $uniqueValue) : bool
Parameters
$uniqueValue : string
Return values
bool —

Search results