FeaturesCollection
extends BaseCollection
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
$objectType
protected
string
$objectType
= \Airlay\Library\Entities\FeatureEntity::class
$uniqueField
protected
string|null
$uniqueField
$maxNumberUniqueValue
private
int|null
$maxNumberUniqueValue
= null
$prefix
private
string
$prefix
= 'features_'
$uniqueValueCache
private
array<string|int, mixed>
$uniqueValueCache
= []
__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
—
deleteTtlIndex()
public
deleteTtlIndex() : 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
—
findByIds()
public
findByIds(array<string|int, ObjectId> $ids) : array<string|int, FeatureEntity>
Parameters
-
$ids
: array<string|int, ObjectId>
-
Return values
array<string|int, FeatureEntity>
—
findByUniqueField()
public
findByUniqueField(string $value) : FeatureEntity|null
Parameters
-
$value
: string
-
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>
—
findMarkedToDelete()
public
findMarkedToDelete() : array<string|int, FeatureEntity>
Return values
array<string|int, FeatureEntity>
—
flush()
public
flush() : void
Return values
void
—
hasOneById()
public
hasOneById(ObjectId $id) : bool
Parameters
-
$id
: ObjectId
-
Return values
bool
—
insertOne()
public
insertOne(FeatureEntity $feature) : true
Parameters
-
$feature
: FeatureEntity
-
Return values
true
—
replaceOne()
public
replaceOne(FeatureEntity $feature) : true
Parameters
-
$feature
: FeatureEntity
-
Return values
true
—
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
—