PHP Class Webiny\Component\Mongo\Mongo

Inheritance: use trait Webiny\Component\StdLib\ComponentTrait, use trait Webiny\Component\StdLib\StdLibTrait
Mostrar archivo Open project: Webiny/Framework Class Usage Examples

Public Methods

Method Description
__construct ( $uri, array $uriOptions = [], array $driverOptions = [], $collectionPrefix = '' )
aggregate ( $collectionName, array $pipeline, array $options = [] )
bulkWrite ( $collectionName, array $operations, array $options = [] )
command ( $command, array $options = [] )
count ( $collectionName, $filter = [], array $options = [] )
createCollection ( string $name, array $options = [] ) : array | object Create collection
createIndex ( $collectionName, Webiny\Component\Mongo\Index\IndexInterface $index, array $options = [] )
createIndexes ( $collectionName, array $indexes )
delete ( $collectionName, $filter, array $options = [] )
distinct ( $collectionName, $fieldName, $filter = [], array $options = [] )
dropCollection ( string $collectionName, array $options = [] ) : array | object Drop collection
dropIndex ( $collectionName, $indexName, array $options = [] )
dropIndexes ( $collectionName, array $options = [] )
find ( $collectionName, $filter = [], $sort = [], $limit, $skip, array $options = [] )
findOne ( $collectionName, $filter = [], array $options = [] )
findOneAndDelete ( $collectionName, $filter, array $options = [] )
findOneAndReplace ( $collectionName, $filter, $replacement, array $options = [] )
findOneAndUpdate ( $collectionName, $filter, $update, array $options = [] )
getCollectionPrefix ( ) : string Get collection prefix
getNamespace ( $collectionName )
id ( null | string $id = null ) : MongoDB\BSON\ObjectID Construct Mongo ID
insertMany ( $collectionName, array $documents, array $options = [] )
insertOne ( $collectionName, $document, array $options = [] )
isId ( $id ) : boolean Check if given string is a valid MongoId string
listCollections ( array $options = [] ) : mixed List collections
listIndexes ( string $collectionName, array $options = [] ) : array
selectDatabase ( string $database ) Select database
update ( $collectionName, $filter, $update, array $options = [] )

Private Methods

Method Description
cName ( $collectionName ) : string Get collection name

Method Details

__construct() public method

public __construct ( $uri, array $uriOptions = [], array $driverOptions = [], $collectionPrefix = '' )
$uriOptions array
$driverOptions array

aggregate() public method

public aggregate ( $collectionName, array $pipeline, array $options = [] )
$pipeline array
$options array

bulkWrite() public method

public bulkWrite ( $collectionName, array $operations, array $options = [] )
$operations array
$options array

command() public method

public command ( $command, array $options = [] )
$options array

count() public method

public count ( $collectionName, $filter = [], array $options = [] )
$options array

createCollection() public method

Create collection
public createCollection ( string $name, array $options = [] ) : array | object
$name string Name
$options array
return array | object

createIndex() public method

public createIndex ( $collectionName, Webiny\Component\Mongo\Index\IndexInterface $index, array $options = [] )
$index Webiny\Component\Mongo\Index\IndexInterface
$options array

createIndexes() public method

public createIndexes ( $collectionName, array $indexes )
$indexes array

delete() public method

public delete ( $collectionName, $filter, array $options = [] )
$options array

distinct() public method

public distinct ( $collectionName, $fieldName, $filter = [], array $options = [] )
$options array

dropCollection() public method

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

dropIndex() public method

public dropIndex ( $collectionName, $indexName, array $options = [] )
$options array

dropIndexes() public method

public dropIndexes ( $collectionName, array $options = [] )
$options array

find() public method

public find ( $collectionName, $filter = [], $sort = [], $limit, $skip, array $options = [] )
$options array

findOne() public method

public findOne ( $collectionName, $filter = [], array $options = [] )
$options array

findOneAndDelete() public method

public findOneAndDelete ( $collectionName, $filter, array $options = [] )
$options array

findOneAndReplace() public method

public findOneAndReplace ( $collectionName, $filter, $replacement, array $options = [] )
$options array

findOneAndUpdate() public method

public findOneAndUpdate ( $collectionName, $filter, $update, array $options = [] )
$options array

getCollectionPrefix() public method

Get collection prefix
public getCollectionPrefix ( ) : string
return string

getNamespace() public method

public getNamespace ( $collectionName )

id() public method

Construct Mongo ID
public id ( null | string $id = null ) : MongoDB\BSON\ObjectID
$id null | string (Optional)
return MongoDB\BSON\ObjectID

insertMany() public method

public insertMany ( $collectionName, array $documents, array $options = [] )
$documents array
$options array

insertOne() public method

public insertOne ( $collectionName, $document, array $options = [] )
$options array

isId() public method

Check if given string is a valid MongoId string
public isId ( $id ) : boolean
$id
return boolean

listCollections() public method

List collections
public listCollections ( array $options = [] ) : mixed
$options array
return mixed

listIndexes() public method

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

selectDatabase() public method

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

update() public method

public update ( $collectionName, $filter, $update, array $options = [] )
$options array