RelationsCollection
extends BaseCollection
in package
Class BaseCollection.
Table of Contents
- DEFAULT_SORT = ['_id' => 1]
- DEFAULT_TYPE_MAP = ['root' => 'array', 'document' => 'array', 'array' => 'array']
- $mongoDbManager : Manager
- $bulkWrite : BulkWrite
- $cache : array<string|int, mixed>
- $collection : Collection
- $collectionName : string
- $databaseName : string
- $objectType : string
- $typeMap : array<string|int, mixed>
- $uniqueField : string|null
- $uniqueValueCache : array<string|int, mixed>
- $maxNumberUniqueValue : int|null
- $prefix : string
- __construct() : mixed
- addToCache() : void
- aggregate() : Traversable
- buildRecursiveTreesByParentIds() : array<string|int, mixed>
- bulkWrite() : bool
- cacheCount() : int
- clearCache() : void
- clearMarkedToDelete() : void
- clearUniqueValueCache() : void
- count() : int
- createDefaultIndexes() : void
- createIndex() : void
- createIndexes() : void
- createIndexesWithValues() : void
- delete() : DeleteResult
- deleteAll() : DeleteResult
- deleteById() : DeleteResult
- deleteOne() : DeleteResult
- deleteTtlIndex() : void
- distinct() : array<string|int, mixed>
- drop() : void
- dropIndexByName() : void
- dropIndexes() : void
- find() : array<string|int, RelationEntity>
- findAll() : array<string|int, mixed>
- findAndDeleteById() : object|null
- 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
- findInCache() : mixed
- findMarkedToDelete() : array<string|int, RelationEntity>
- findOne() : null|mixed
- 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>
- findWithCursor() : Cursor
- findWithErrors() : array<string|int, mixed>
- findWithoutCache() : RelationEntity|null
- findWithParentsRecursive() : array<string|int, mixed>
- findWithParentsRecursiveById() : array<string|int, mixed>
- flush() : void
- getCollectionName() : string
- getCollectionSize() : int|float
- getCollectionStats() : array<string|int, mixed>
- getIndexes() : array<string|int, IndexInfo>
- getObjectType() : string
- getRelations() : array<string|int, mixed>
- getUniqueValues() : array<string|int, mixed>
- hasInCache() : bool
- hasIndex() : bool
- hasOne() : bool
- hasOneById() : bool
- insertMany() : bool
- insertOne() : true
- replaceOne() : bool
- save() : bool
- update() : UpdateResult
- updateOne() : UpdateResult
- addToUniqueValueCache() : void
- findInUniqueValueCache() : ObjectId|null
- hasInUniqueValueCache() : bool
- buildRelationsTree() : array<string|int, mixed>
- buildRelationsTreeFromArray() : array<string|int, mixed>
- buildTreeRecursive() : object
Constants
DEFAULT_SORT
public
mixed
DEFAULT_SORT
= ['_id' => 1]
DEFAULT_TYPE_MAP
public
mixed
DEFAULT_TYPE_MAP
= ['root' => 'array', 'document' => 'array', 'array' => 'array']
Properties
$mongoDbManager
public
Manager
$mongoDbManager
$bulkWrite
protected
BulkWrite
$bulkWrite
$cache
protected
array<string|int, mixed>
$cache
= []
$collection
protected
Collection
$collection
$collectionName
protected
string
$collectionName
$databaseName
protected
string
$databaseName
$objectType
protected
string
$objectType
= \Airlay\Library\Entities\RelationEntity::class
$typeMap
protected
array<string|int, mixed>
$typeMap
$uniqueField
protected
string|null
$uniqueField
$uniqueValueCache
protected
array<string|int, mixed>
$uniqueValueCache
= []
$maxNumberUniqueValue
private
int|null
$maxNumberUniqueValue
= null
$prefix
private
string
$prefix
= 'relations_'
Methods
__construct()
public
__construct(string $name[, string|null $uniqueField = null ]) : mixed
Parameters
- $name : string
- $uniqueField : string|null = null
Return values
mixed —addToCache()
public
addToCache(ObjectId $id[, mixed $entity = null ]) : void
Parameters
- $id : ObjectId
- $entity : mixed = null
Return values
void —aggregate()
public
aggregate(array<string|int, mixed> $pipeline[, array<string|int, mixed> $options = [] ]) : Traversable
Parameters
- $pipeline : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
Traversable —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> —bulkWrite()
public
bulkWrite(array<string|int, mixed> $operations[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $operations : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
bool —cacheCount()
public
cacheCount() : int
Return values
int —clearCache()
public
clearCache() : void
Return values
void —clearMarkedToDelete()
public
clearMarkedToDelete() : void
Return values
void —clearUniqueValueCache()
public
clearUniqueValueCache() : void
Return values
void —count()
public
count([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : int
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Return values
int —createDefaultIndexes()
public
createDefaultIndexes() : void
Return values
void —createIndex()
public
createIndex(array<string|int, mixed>|object $key, array<string|int, mixed> $options) : void
Parameters
- $key : array<string|int, mixed>|object
- $options : array<string|int, mixed>
Return values
void —createIndexes()
public
createIndexes(array<string|int, string> $indexesFields) : void
Parameters
- $indexesFields : array<string|int, string>
Return values
void —createIndexesWithValues()
public
createIndexesWithValues(array<string|int, mixed> $indexes) : void
Parameters
- $indexes : array<string|int, mixed>
-
= [ ['index' => 'value'], ['index' => 'value'] . . . ]
Return values
void —delete()
public
delete(array<string|int, mixed> $filter) : DeleteResult
Parameters
- $filter : array<string|int, mixed>
Return values
DeleteResult —deleteAll()
public
deleteAll() : DeleteResult
Return values
DeleteResult —deleteById()
public
deleteById(ObjectId $id) : DeleteResult
Parameters
- $id : ObjectId
Return values
DeleteResult —deleteOne()
public
deleteOne(array<string|int, mixed> $filter) : DeleteResult
Parameters
- $filter : array<string|int, mixed>
Return values
DeleteResult —deleteTtlIndex()
public
deleteTtlIndex() : void
Return values
void —distinct()
public
distinct(string $field[, mixed $filter = [] ][, mixed $options = [] ]) : array<string|int, mixed>
Parameters
- $field : string
- $filter : mixed = []
- $options : mixed = []
Return values
array<string|int, mixed> —drop()
public
drop() : void
Return values
void —dropIndexByName()
public
dropIndexByName(string $name) : void
Parameters
- $name : string
Return values
void —dropIndexes()
public
dropIndexes() : 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> —findAll()
public
findAll([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed> —findAndDeleteById()
public
findAndDeleteById(ObjectId $id) : object|null
Parameters
- $id : ObjectId
Return values
object|null —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 —findByIds()
public
findByIds(array<string|int, ObjectId> $ids) : array<string|int, RelationEntity>
Parameters
- $ids : array<string|int, ObjectId>
Return values
array<string|int, RelationEntity> —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> —findByMembersIds()
public
findByMembersIds(array<string|int, ObjectId> $ids) : array<string|int, RelationEntity>
Parameters
- $ids : array<string|int, ObjectId>
Return values
array<string|int, RelationEntity> —findByUniqueField()
public
findByUniqueField(string $value) : RelationEntity|null
Parameters
- $value : string
Return values
RelationEntity|null —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 —findInCache()
public
findInCache(ObjectId $id) : mixed
Parameters
- $id : ObjectId
Return values
mixed —findMarkedToDelete()
public
findMarkedToDelete() : array<string|int, RelationEntity>
Return values
array<string|int, RelationEntity> —findOne()
public
findOne(array<string|int, mixed> $filter[, array<string|int, mixed> $options = [] ]) : null|mixed
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
null|mixed —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> —findWithCursor()
public
findWithCursor([array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $options = [] ]) : Cursor
Parameters
- $filter : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []
Tags
Return values
Cursor —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> —flush()
public
flush() : void
Return values
void —getCollectionName()
public
getCollectionName() : string
Return values
string —getCollectionSize()
public
getCollectionSize() : int|float
Return values
int|float —getCollectionStats()
public
getCollectionStats() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIndexes()
public
getIndexes() : array<string|int, IndexInfo>
Return values
array<string|int, IndexInfo> —getObjectType()
public
getObjectType() : string
Return values
string —getRelations()
public
getRelations() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUniqueValues()
public
getUniqueValues(string $field, string $value, int $limit[, array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>
Parameters
- $field : string
- $value : string
- $limit : int
- $filter : array<string|int, mixed> = []
Return values
array<string|int, mixed> —hasInCache()
public
hasInCache(ObjectId $id) : bool
Parameters
- $id : ObjectId
Return values
bool —hasIndex()
public
hasIndex(string $name) : bool
Parameters
- $name : string
Return values
bool —hasOne()
public
hasOne(array<string|int, mixed> $filter) : bool
Parameters
- $filter : array<string|int, mixed>
Return values
bool —hasOneById()
public
hasOneById(ObjectId $id) : bool
Parameters
- $id : ObjectId
Return values
bool —insertMany()
public
insertMany(array<string|int, RelationEntity> $relations) : bool
Parameters
- $relations : array<string|int, RelationEntity>
Return values
bool —insertOne()
public
insertOne(RelationEntity $relation) : true
Parameters
- $relation : RelationEntity
Return values
true —replaceOne()
public
replaceOne(RelationEntity $relation) : bool
Parameters
- $relation : RelationEntity
Return values
bool —save()
public
save(mixed $data) : bool
Parameters
- $data : mixed
Return values
bool —update()
public
update(array<string|int, mixed> $filter, array<string|int, mixed> $update[, mixed $options = [] ]) : UpdateResult
Parameters
- $filter : array<string|int, mixed>
- $update : array<string|int, mixed>
- $options : mixed = []
Return values
UpdateResult —updateOne()
public
updateOne(array<string|int, mixed> $filter, array<string|int, mixed> $update[, mixed $options = [] ]) : UpdateResult
Parameters
- $filter : array<string|int, mixed>
- $update : array<string|int, mixed>
- $options : mixed = []
Return values
UpdateResult —addToUniqueValueCache()
protected
addToUniqueValueCache(string $uniqueValue[, RelationEntity|null $relation = null ]) : void
Parameters
- $uniqueValue : string
- $relation : RelationEntity|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 —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>