TokenCollection
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>
- __construct() : mixed
- addToCache() : void
- aggregate() : Traversable
- bulkWrite() : bool
- cacheCount() : int
- clearCache() : void
- count() : int
- createIndex() : void
- createIndexes() : void
- createIndexesWithValues() : void
- delete() : DeleteResult
- deleteAll() : DeleteResult
- deleteByDataLoaderIdAndOrganizationId() : DeleteResult
- deleteById() : DeleteResult
- deleteByOrganizationId() : DeleteResult
- deleteByTokenAndOrganizationId() : DeleteResult
- deleteOne() : DeleteResult
- distinct() : array<string|int, mixed>
- drop() : void
- dropIndexByName() : void
- dropIndexes() : void
- find() : mixed
- findAll() : array<string|int, mixed>
- findAndDeleteById() : object|null
- findById() : mixed
- findInCache() : mixed
- findOne() : null|mixed
- findWithCursor() : Cursor
- flush() : void
- getCollectionName() : string
- getCollectionSize() : int|float
- getCollectionStats() : array<string|int, mixed>
- getIndexes() : array<string|int, IndexInfo>
- getUniqueValues() : array<string|int, mixed>
- hasInCache() : bool
- hasIndex() : bool
- hasOne() : bool
- insertMany() : bool
- insertOne() : bool
- save() : bool
- update() : UpdateResult
- updateOne() : UpdateResult
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
$typeMap
protected
array<string|int, mixed>
$typeMap
Methods
__construct()
public
__construct() : mixed
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 —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 —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 —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 —deleteByDataLoaderIdAndOrganizationId()
public
deleteByDataLoaderIdAndOrganizationId(ObjectId $dataLoaderId, ObjectId $organizationId) : DeleteResult
Parameters
- $dataLoaderId : ObjectId
- $organizationId : ObjectId
Return values
DeleteResult —deleteById()
public
deleteById(ObjectId $id) : DeleteResult
Parameters
- $id : ObjectId
Return values
DeleteResult —deleteByOrganizationId()
public
deleteByOrganizationId(ObjectId $organizationId) : DeleteResult
Parameters
- $organizationId : ObjectId
Return values
DeleteResult —deleteByTokenAndOrganizationId()
public
deleteByTokenAndOrganizationId(string $token, ObjectId $organizationId) : DeleteResult
Parameters
- $token : string
- $organizationId : ObjectId
Return values
DeleteResult —deleteOne()
public
deleteOne(array<string|int, mixed> $filter) : DeleteResult
Parameters
- $filter : array<string|int, mixed>
Return values
DeleteResult —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 = [] ]) : mixed
Parameters
- $filter : array<string|int, mixed>
- $options : array<string|int, mixed> = []
Return values
mixed —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 —findById()
public
findById(ObjectId $id[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $id : ObjectId
- $options : array<string|int, mixed> = []
Return values
mixed —findInCache()
public
findInCache(ObjectId $id) : mixed
Parameters
- $id : ObjectId
Return values
mixed —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 —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 —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> —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 —insertMany()
public
insertMany(array<string|int, mixed> $nodes) : bool
Parameters
- $nodes : array<string|int, mixed>
Return values
bool —insertOne()
public
insertOne(mixed $entity) : bool
Parameters
- $entity : mixed
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 = []