PHP Class Webiny\Component\Mongo\Mongo

Inheritance: use trait Webiny\Component\StdLib\ComponentTrait, use trait Webiny\Component\StdLib\StdLibTrait
Afficher le fichier Open project: Webiny/Framework Class Usage Examples

Méthodes publiques

Méthode 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

Méthode Description
cName ( $collectionName ) : string Get collection name

Method Details

__construct() public méthode

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

aggregate() public méthode

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

bulkWrite() public méthode

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

command() public méthode

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

count() public méthode

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

createCollection() public méthode

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

createIndex() public méthode

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

createIndexes() public méthode

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

delete() public méthode

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

distinct() public méthode

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

dropCollection() public méthode

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

dropIndex() public méthode

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

dropIndexes() public méthode

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

find() public méthode

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

findOne() public méthode

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

findOneAndDelete() public méthode

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

findOneAndReplace() public méthode

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

findOneAndUpdate() public méthode

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

getCollectionPrefix() public méthode

Get collection prefix
public getCollectionPrefix ( ) : string
Résultat string

getNamespace() public méthode

public getNamespace ( $collectionName )

id() public méthode

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

insertMany() public méthode

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

insertOne() public méthode

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

isId() public méthode

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

listCollections() public méthode

List collections
public listCollections ( array $options = [] ) : mixed
$options array
Résultat mixed

listIndexes() public méthode

public listIndexes ( string $collectionName, array $options = [] ) : array
$collectionName string
$options array
Résultat array

selectDatabase() public méthode

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

update() public méthode

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