PHP Class Webiny\Component\Mongo\Bridge\MongoDb

Inheritance: implements Webiny\Component\Mongo\Bridge\MongoInterface, use trait Webiny\Component\StdLib\StdLibTrait
Show file Open project: Webiny/Framework

Public Methods

Method Description
aggregate ( string $collectionName, array $pipeline, array $options = [] ) : Traversable
bulkWrite ( string $collectionName, array $operations, array $options = [] ) : MongoDB\BulkWriteResult
command ( array | object $command, array $options = [] ) : MongoDB\Driver\Cursor
connect ( $uri, array $uriOptions = [], array $driverOptions = [] )
count ( string $collectionName, array $filter = [], array $options = [] ) : integer
createCollection ( string $collectionName, array $options = [] ) : object
createIndex ( string $collectionName, array | object $key, array $options = [] ) : string
createIndexes ( string $collectionName, array $indexes ) : string[]
delete ( string $collectionName, array | object $filter, array $options = [] ) : MongoDB\DeleteResult
distinct ( string $collectionName, string $fieldName, array $filter = [], array $options = [] ) : mixed[]
dropCollection ( string $collectionName, array $options = [] ) : array | object
dropIndex ( string $collectionName, string $indexName, array $options = [] ) : array | object
dropIndexes ( string $collectionName, array $options = [] ) : array | object
find ( string $collectionName, array $filter = [], array $options = [] ) : MongoDB\Driver\Cursor
findOne ( string $collectionName, array $filter = [], array $options = [] ) : null | object
findOneAndDelete ( string $collectionName, array | object $filter, array $options = [] ) : null | object
findOneAndReplace ( string $collectionName, array | object $filter, array | object $replacement, array $options = [] ) : null | object
findOneAndUpdate ( string $collectionName, array | object $filter, array | object $update, array $options = [] ) : null | object
getNamespace ( string $collectionName ) : string
id ( null | string $id = null ) : mixed Create a mongo ID instance
insertMany ( string $collectionName, array $documents, array $options = [] ) : MongoDB\InsertManyResult
insertOne ( string $collectionName, array | object $document, array $options = [] ) : MongoDB\InsertOneResult
isId ( mixed $id ) : boolean Check if given string/object is a valid mongo ID.
listCollections ( array $options = [] ) : MongoDB\Model\CollectionInfoIterator
listIndexes ( string $collectionName, array $options = [] ) : MongoDB\Model\IndexInfoIterator
selectDatabase ( string $database ) Select database
update ( string $collectionName, array | object $filter, array | object $update, array $options = [] ) : MongoDB\UpdateResult

Private Methods

Method Description
getCollection ( $collectionName ) : MongoDB\Collection
getDb ( ) : MongoDB\Database

Method Details

aggregate() public method

public aggregate ( string $collectionName, array $pipeline, array $options = [] ) : Traversable
$collectionName string
$pipeline array
$options array
return Traversable

bulkWrite() public method

public bulkWrite ( string $collectionName, array $operations, array $options = [] ) : MongoDB\BulkWriteResult
$collectionName string
$operations array
$options array
return MongoDB\BulkWriteResult

command() public method

public command ( array | object $command, array $options = [] ) : MongoDB\Driver\Cursor
$command array | object
$options array
return MongoDB\Driver\Cursor

connect() public method

public connect ( $uri, array $uriOptions = [], array $driverOptions = [] )
$uriOptions array
$driverOptions array

count() public method

public count ( string $collectionName, array $filter = [], array $options = [] ) : integer
$collectionName string
$filter array
$options array
return integer

createCollection() public method

public createCollection ( string $collectionName, array $options = [] ) : object
$collectionName string
$options array
return object

createIndex() public method

public createIndex ( string $collectionName, array | object $key, array $options = [] ) : string
$collectionName string
$key array | object
$options array
return string

createIndexes() public method

public createIndexes ( string $collectionName, array $indexes ) : string[]
$collectionName string
$indexes array
return string[]

delete() public method

public delete ( string $collectionName, array | object $filter, array $options = [] ) : MongoDB\DeleteResult
$collectionName string
$filter array | object
$options array
return MongoDB\DeleteResult

distinct() public method

public distinct ( string $collectionName, string $fieldName, array $filter = [], array $options = [] ) : mixed[]
$collectionName string
$fieldName string
$filter array
$options array
return mixed[]

dropCollection() public method

public dropCollection ( string $collectionName, array $options = [] ) : array | object
$collectionName string
$options array
return array | object

dropIndex() public method

public dropIndex ( string $collectionName, string $indexName, array $options = [] ) : array | object
$collectionName string
$indexName string
$options array
return array | object

dropIndexes() public method

public dropIndexes ( string $collectionName, array $options = [] ) : array | object
$collectionName string
$options array
return array | object

find() public method

public find ( string $collectionName, array $filter = [], array $options = [] ) : MongoDB\Driver\Cursor
$collectionName string
$filter array
$options array
return MongoDB\Driver\Cursor

findOne() public method

public findOne ( string $collectionName, array $filter = [], array $options = [] ) : null | object
$collectionName string
$filter array
$options array
return null | object

findOneAndDelete() public method

public findOneAndDelete ( string $collectionName, array | object $filter, array $options = [] ) : null | object
$collectionName string
$filter array | object
$options array
return null | object

findOneAndReplace() public method

public findOneAndReplace ( string $collectionName, array | object $filter, array | object $replacement, array $options = [] ) : null | object
$collectionName string
$filter array | object
$replacement array | object
$options array
return null | object

findOneAndUpdate() public method

public findOneAndUpdate ( string $collectionName, array | object $filter, array | object $update, array $options = [] ) : null | object
$collectionName string
$filter array | object
$update array | object
$options array
return null | object

getNamespace() public method

public getNamespace ( string $collectionName ) : string
$collectionName string
return string

id() public method

Create a mongo ID instance
public id ( null | string $id = null ) : mixed
$id null | string
return mixed

insertMany() public method

public insertMany ( string $collectionName, array $documents, array $options = [] ) : MongoDB\InsertManyResult
$collectionName string
$documents array
$options array
return MongoDB\InsertManyResult

insertOne() public method

public insertOne ( string $collectionName, array | object $document, array $options = [] ) : MongoDB\InsertOneResult
$collectionName string
$document array | object
$options array
return MongoDB\InsertOneResult

isId() public method

Check if given string/object is a valid mongo ID.
public isId ( mixed $id ) : boolean
$id mixed
return boolean

listCollections() public method

public listCollections ( array $options = [] ) : MongoDB\Model\CollectionInfoIterator
$options array
return MongoDB\Model\CollectionInfoIterator

listIndexes() public method

public listIndexes ( string $collectionName, array $options = [] ) : MongoDB\Model\IndexInfoIterator
$collectionName string
$options array
return MongoDB\Model\IndexInfoIterator

selectDatabase() public method

Select database
public selectDatabase ( string $database )
$database string

update() public method

public update ( string $collectionName, array | object $filter, array | object $update, array $options = [] ) : MongoDB\UpdateResult
$collectionName string
$filter array | object
$update array | object
$options array
return MongoDB\UpdateResult