AirLay backend

RelationsCollection extends BaseCollection
in package

Table of Contents

$objectType  : string
$uniqueField  : string|null
$uniqueValueCache  : array<string|int, mixed>
$maxNumberUniqueValue  : int|null
$prefix  : string
__construct()  : mixed
buildRecursiveTreesByParentIds()  : array<string|int, mixed>
clearMarkedToDelete()  : void
clearUniqueValueCache()  : void
createDefaultIndexes()  : void
deleteTtlIndex()  : void
find()  : array<string|int, RelationEntity>
findArrayWithChildrenRecursive()  : array<string|int, array<string|int, mixed>>
findById()  : RelationEntity|null
findByIds()  : array<string|int, RelationEntity>
findByMembersId()  : array<string|int, RelationEntity>
findByMembersIds()  : array<string|int, RelationEntity>
findByUniqueField()  : RelationEntity|null
findByUniqueValues()  : array<string|int, RelationEntity>
findChildrenRecursiveByIds()  : array<string|int, RelationEntity>
findInArray()  : object|null
findMarkedToDelete()  : array<string|int, RelationEntity>
findParentsByIds()  : array<string|int, RelationEntity>
findRelationIdsByArea()  : array<string|int, ObjectId>
findRelationsByBbox()  : array<string|int, RelationEntity>
findWithChildrenRecursive()  : array<string|int, RelationEntity>
findWithChildrenRecursiveById()  : array<string|int, mixed>
findWithErrors()  : array<string|int, mixed>
findWithoutCache()  : RelationEntity|null
findWithParentsRecursive()  : array<string|int, mixed>
findWithParentsRecursiveById()  : array<string|int, mixed>
flush()  : void
getObjectType()  : string
getRelations()  : array<string|int, mixed>
hasOneById()  : bool
insertMany()  : bool
insertOne()  : true
replaceOne()  : bool
addToUniqueValueCache()  : void
findInUniqueValueCache()  : ObjectId|null
hasInUniqueValueCache()  : bool
buildRelationsTree()  : array<string|int, mixed>
buildRelationsTreeFromArray()  : array<string|int, mixed>
buildTreeRecursive()  : object

Properties

$objectType

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

Methods

__construct()

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

buildRecursiveTreesByParentIds()

public buildRecursiveTreesByParentIds(array<string|int, mixed> $ids, bool $withGeometry) : array<string|int, mixed>
Parameters
$ids : array<string|int, mixed>
$withGeometry : bool
Return values
array<string|int, mixed> —

clearUniqueValueCache()

public clearUniqueValueCache() : 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, RelationEntity>
Parameters
$filter : array<string|int, mixed>
$options : array<string|int, mixed> = []
$excludeDeletedObjects : bool = true
$withUniqueValueCache : bool = true
Return values
array<string|int, RelationEntity> —

findArrayWithChildrenRecursive()

public findArrayWithChildrenRecursive(array<string|int, mixed> $filter) : array<string|int, array<string|int, mixed>>
Parameters
$filter : array<string|int, mixed>
Return values
array<string|int, array<string|int, mixed>> —

findById()

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

findByMembersId()

public findByMembersId(ObjectId $memberId[, array<string|int, mixed> $options = [] ]) : array<string|int, RelationEntity>
Parameters
$memberId : ObjectId
$options : array<string|int, mixed> = []
Return values
array<string|int, RelationEntity> —

findByUniqueValues()

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

findChildrenRecursiveByIds()

public findChildrenRecursiveByIds(array<string|int, ObjectId> $relationsIds) : array<string|int, RelationEntity>
Parameters
$relationsIds : array<string|int, ObjectId>
Return values
array<string|int, RelationEntity> —

findInArray()

public findInArray(ObjectId $id, array<string|int, mixed> $objects) : object|null
Parameters
$id : ObjectId
$objects : array<string|int, mixed>
Return values
object|null —

findParentsByIds()

public findParentsByIds(array<string|int, ObjectId> $relationsIds) : array<string|int, RelationEntity>
Parameters
$relationsIds : array<string|int, ObjectId>
Return values
array<string|int, RelationEntity> —

findRelationIdsByArea()

public findRelationIdsByArea(Polygon $area, int $limit) : array<string|int, ObjectId>
Parameters
$area : Polygon
$limit : int
Return values
array<string|int, ObjectId> —

findRelationsByBbox()

public findRelationsByBbox(Bbox $bbox, array<string|int, mixed> $options, int $limit) : array<string|int, RelationEntity>
Parameters
$bbox : Bbox
$options : array<string|int, mixed>
$limit : int
Return values
array<string|int, RelationEntity> —

findWithChildrenRecursive()

public findWithChildrenRecursive(array<string|int, mixed> $filter) : array<string|int, RelationEntity>
Parameters
$filter : array<string|int, mixed>
Return values
array<string|int, RelationEntity> —

findWithChildrenRecursiveById()

public findWithChildrenRecursiveById(ObjectId $relationId) : array<string|int, mixed>
Parameters
$relationId : ObjectId
Return values
array<string|int, mixed> —

findWithErrors()

public findWithErrors([string $value = '' ], int $skip[, int $limit = 10 ][, string $filter = '' ]) : array<string|int, mixed>
Parameters
$value : string = ''
$skip : int
$limit : int = 10
$filter : string = ''
Return values
array<string|int, mixed> —

findWithoutCache()

public findWithoutCache(array<string|int, mixed> $filter, array<string|int, mixed> $options) : RelationEntity|null
Parameters
$filter : array<string|int, mixed>
$options : array<string|int, mixed>
Return values
RelationEntity|null —

findWithParentsRecursive()

public findWithParentsRecursive(array<string|int, mixed> $filter) : array<string|int, mixed>
Parameters
$filter : array<string|int, mixed>
Return values
array<string|int, mixed> —

findWithParentsRecursiveById()

public findWithParentsRecursiveById(ObjectId $relationId) : array<string|int, mixed>
Parameters
$relationId : ObjectId
Return values
array<string|int, mixed> —

getRelations()

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

hasOneById()

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

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 —

buildRelationsTree()

private buildRelationsTree(RelationEntity $relation, array<string|int, mixed> $relationsMap) : array<string|int, mixed>
Parameters
$relation : RelationEntity
$relationsMap : array<string|int, mixed>
Return values
array<string|int, mixed> —

buildRelationsTreeFromArray()

private buildRelationsTreeFromArray(array<string|int, mixed> $relation, array<string|int, mixed> $relationsMap) : array<string|int, mixed>
Parameters
$relation : array<string|int, mixed>
$relationsMap : array<string|int, mixed>
Return values
array<string|int, mixed> —

buildTreeRecursive()

private buildTreeRecursive(object $object, array<string|int, mixed> $objects) : object
Parameters
$object : object
$objects : array<string|int, mixed>
Return values
object —

Search results