Documentation

Collection
in package

Collection object.

Table of Contents

$database  : Database
$name  : string
__construct()  : mixed
Constructor
aggregate()  : Cursor
Data aggregation
count()  : int
Count documents in collections
drop()  : void
Drop collection
find()  : Cursor
Find documents
findOne()  : array<string|int, mixed>
Find one document
insert()  : mixed
Insert document
insertMany()  : count
Insert many documents
remove()  : mixed
Remove documents
renameCollection()  : bool
Rename Collection
save()  : mixed
Save document
update()  : int
Update documents
_insert()  : mixed
Insert document

Properties

Methods

__construct()

Constructor

public __construct(string $name, Database $database) : mixed
Parameters
$name : string
$database : Database
Return values
mixed —

aggregate()

Data aggregation

public aggregate(array<string|int, mixed> $pipeline) : Cursor
Parameters
$pipeline : array<string|int, mixed>
Return values
Cursor —

count()

Count documents in collections

public count([mixed $criteria = null ]) : int
Parameters
$criteria : mixed = null
Return values
int —

drop()

Drop collection

public drop() : void
Return values
void —

find()

Find documents

public find([mixed $criteria = null ][, array<string|int, mixed>|null $projection = null ]) : Cursor
Parameters
$criteria : mixed = null
$projection : array<string|int, mixed>|null = null
Return values
Cursor —

Cursor

findOne()

Find one document

public findOne([mixed $criteria = null ][, array<string|int, mixed>|null $projection = null ]) : array<string|int, mixed>
Parameters
$criteria : mixed = null
$projection : array<string|int, mixed>|null = null
Return values
array<string|int, mixed> —

insert()

Insert document

public insert(array<string|int, mixed> &$document) : mixed
Parameters
$document : array<string|int, mixed>
Return values
mixed —

last_insert_id for single document or count count of inserted documents for arrays

insertMany()

Insert many documents

public insertMany(array<string|int, mixed> $documents) : count
Parameters
$documents : array<string|int, mixed>
Return values
count —

of inserted documents for arrays

remove()

Remove documents

public remove(mixed $criteria) : mixed
Parameters
$criteria : mixed
Return values
mixed —

renameCollection()

Rename Collection

public renameCollection(string $newname) : bool
Parameters
$newname : string

[description]

Return values
bool —

save()

Save document

public save(array<string|int, mixed> &$document[, bool $create = false ]) : mixed
Parameters
$document : array<string|int, mixed>
$create : bool = false
Return values
mixed —

update()

Update documents

public update(mixed $criteria, array<string|int, mixed> $data[, bool $merge = true ]) : int
Parameters
$criteria : mixed
$data : array<string|int, mixed>
$merge : bool = true
Return values
int —

_insert()

Insert document

protected _insert(array<string|int, mixed> &$document) : mixed
Parameters
$document : array<string|int, mixed>
Return values
mixed —

Search results