PHP Class MongoDB

Afficher le fichier Open project: alcaeus/mongo-php-adapter Class Usage Examples

Protected Properties

Свойство Type Description
$connection MongoClient
$db MongoDB\Database
$name string

Méthodes publiques

Méthode Description
__construct ( MongoClient $conn, string $name ) Creates a new database
__get ( string $name ) : MongoCollection Gets a collection
__set ( string $name, mixed $value )
__sleep ( ) : array
__toString ( ) : string The name of this database
authenticate ( string $username, string $password ) : array Log in to this database
command ( array $data, array $options = [], &$hash = null ) : array Execute a database command
createCollection ( string $name, array $options ) : MongoCollection Creates a collection
createDBRef ( string $collection, mixed $document_or_id ) : array Creates a database reference
drop ( ) : array Drops this database
dropCollection ( MongoCollection | string $coll ) : array Drops a collection
execute ( MongoCode | string $code, array $args = [] ) : array Runs JavaScript code on the database server.
forceError ( ) : boolean Creates a database error
getCollectionInfo ( array $options = [] ) : array Returns information about collections in this database
getCollectionNames ( array $options = [] ) : array Get all collections from this database
getConnection ( ) : MongoClient
getDBRef ( array $ref ) : array Fetches the document pointed to by a database reference
getDb ( ) : MongoDB\Database
getGridFS ( string $prefix = "fs" ) : MongoGridFS Fetches toolkit for dealing with files stored in this database
getProfilingLevel ( ) : integer Gets this database's profiling level
lastError ( ) : array Check if there was an error on the most recent db operation performed
listCollections ( array $options = [] ) : MongoCollection[] Get a list of collections in this database
prevError ( ) : array Checks for the last error thrown during a database operation
repair ( boolean $preserve_cloned_files = FALSE, boolean $backup_original_files = FALSE ) : array Repairs and compacts this database
resetError ( ) : array Clears any flagged errors on the database
selectCollection ( string $name ) : MongoCollection Gets a collection
setProfilingLevel ( integer $level ) : integer Sets this database's profiling level
setReadPreference ( $readPreference, $tags = null )
setWriteConcern ( $wstring, $wtimeout )

Méthodes protégées

Méthode Description
notImplemented ( )

Private Methods

Méthode Description
checkDatabaseName ( $name )
createDatabaseObject ( ) : MongoDB\Database
getSystemCollectionFilterClosure ( boolean $includeSystemCollections = false ) : Closure

Method Details

__construct() public méthode

This method is not meant to be called directly. The preferred way to create an instance of MongoDB is through {@see \Mongo::__get()} or {@see \Mongo::selectDB()}.
See link: http://www.php.net/manual/en/mongodb.construct.php
public __construct ( MongoClient $conn, string $name )
$conn MongoClient Database connection.
$name string Database name.

__get() public méthode

Gets a collection
See link: http://www.php.net/manual/en/mongodb.get.php
public __get ( string $name ) : MongoCollection
$name string The name of the collection.
Résultat MongoCollection

__set() public méthode

public __set ( string $name, mixed $value )
$name string
$value mixed

__sleep() public méthode

public __sleep ( ) : array
Résultat array

__toString() public méthode

The name of this database
See link: http://www.php.net/manual/en/mongodb.--tostring.php
public __toString ( ) : string
Résultat string Returns this database's name.

authenticate() public méthode

Log in to this database
See link: http://www.php.net/manual/en/mongodb.authenticate.php
Deprecation: This method is not implemented, supply authentication credentials through the connection string instead.
public authenticate ( string $username, string $password ) : array
$username string The username.
$password string The password (in plaintext).
Résultat array Returns database response. If the login was successful, it will return 1.

command() public méthode

Execute a database command
See link: http://www.php.net/manual/en/mongodb.command.php
public command ( array $data, array $options = [], &$hash = null ) : array
$data array The query to send.
$options array
Résultat array Returns database response.

createCollection() public méthode

Creates a collection
See link: http://www.php.net/manual/en/mongodb.createcollection.php
public createCollection ( string $name, array $options ) : MongoCollection
$name string The name of the collection.
$options array
Résultat MongoCollection Returns a collection object representing the new collection.

createDBRef() public méthode

Creates a database reference
See link: http://www.php.net/manual/en/mongodb.createdbref.php
public createDBRef ( string $collection, mixed $document_or_id ) : array
$collection string The collection to which the database reference will point.
$document_or_id mixed
Résultat array Returns a database reference array.

drop() public méthode

Drops this database
See link: http://www.php.net/manual/en/mongodb.drop.php
public drop ( ) : array
Résultat array Returns the database response.

dropCollection() public méthode

Drops a collection
See link: http://www.php.net/manual/en/mongodb.dropcollection.php
Deprecation: Use MongoCollection::drop() instead.
public dropCollection ( MongoCollection | string $coll ) : array
$coll MongoCollection | string MongoCollection or name of collection to drop.
Résultat array Returns the database response.

execute() public méthode

Runs JavaScript code on the database server.
See link: http://www.php.net/manual/en/mongodb.execute.php
public execute ( MongoCode | string $code, array $args = [] ) : array
$code MongoCode | string Code to execute.
$args array [optional] Arguments to be passed to code.
Résultat array Returns the result of the evaluation.

forceError() public méthode

Creates a database error
See link: http://www.php.net/manual/en/mongodb.forceerror.php
public forceError ( ) : boolean
Résultat boolean Returns the database response.

getCollectionInfo() public méthode

Returns information about collections in this database
See link: http://www.php.net/manual/en/mongodb.getcollectioninfo.php
public getCollectionInfo ( array $options = [] ) : array
$options array An array of options for listing the collections.
Résultat array

getCollectionNames() public méthode

Get all collections from this database
See link: http://www.php.net/manual/en/mongodb.getcollectionnames.php
public getCollectionNames ( array $options = [] ) : array
$options array An array of options for listing the collections.
Résultat array Returns the names of the all the collections in the database as an array

getConnection() public méthode

public getConnection ( ) : MongoClient
Résultat MongoClient

getDBRef() public méthode

Fetches the document pointed to by a database reference
See link: http://www.php.net/manual/en/mongodb.getdbref.php
public getDBRef ( array $ref ) : array
$ref array A database reference.
Résultat array Returns the document pointed to by the reference.

getDb() public méthode

public getDb ( ) : MongoDB\Database
Résultat MongoDB\Database

getGridFS() public méthode

Fetches toolkit for dealing with files stored in this database
See link: http://www.php.net/manual/en/mongodb.getgridfs.php
public getGridFS ( string $prefix = "fs" ) : MongoGridFS
$prefix string The prefix for the files and chunks collections.
Résultat MongoGridFS Returns a new gridfs object for this database.

getProfilingLevel() public méthode

Gets this database's profiling level
See link: http://www.php.net/manual/en/mongodb.getprofilinglevel.php
public getProfilingLevel ( ) : integer
Résultat integer Returns the profiling level.

lastError() public méthode

Check if there was an error on the most recent db operation performed
See link: http://www.php.net/manual/en/mongodb.lasterror.php
public lastError ( ) : array
Résultat array Returns the error, if there was one.

listCollections() public méthode

Get a list of collections in this database
See link: http://www.php.net/manual/en/mongodb.listcollections.php
public listCollections ( array $options = [] ) : MongoCollection[]
$options array
Résultat MongoCollection[] Returns a list of MongoCollections.

notImplemented() protected méthode

protected notImplemented ( )

prevError() public méthode

Checks for the last error thrown during a database operation
See link: http://www.php.net/manual/en/mongodb.preverror.php
public prevError ( ) : array
Résultat array Returns the error and the number of operations ago it occurred.

repair() public méthode

Repairs and compacts this database
See link: http://www.php.net/manual/en/mongodb.repair.php
public repair ( boolean $preserve_cloned_files = FALSE, boolean $backup_original_files = FALSE ) : array
$preserve_cloned_files boolean [optional]

If cloned files should be kept if the repair fails.
$backup_original_files boolean [optional]

If original files should be backed up.
Résultat array

Returns db response.

resetError() public méthode

Clears any flagged errors on the database
See link: http://www.php.net/manual/en/mongodb.reseterror.php
public resetError ( ) : array
Résultat array Returns the database response.

selectCollection() public méthode

Gets a collection
See link: http://www.php.net/manual/en/mongodb.selectcollection.php
public selectCollection ( string $name ) : MongoCollection
$name string The collection name.
Résultat MongoCollection Returns a new collection object.

setProfilingLevel() public méthode

Sets this database's profiling level
See link: http://www.php.net/manual/en/mongodb.setprofilinglevel.php
public setProfilingLevel ( integer $level ) : integer
$level integer Profiling level.
Résultat integer Returns the previous profiling level.

setReadPreference() public méthode

public setReadPreference ( $readPreference, $tags = null )

setWriteConcern() public méthode

public setWriteConcern ( $wstring, $wtimeout )

Property Details

$connection protected_oe property

protected MongoClient $connection
Résultat MongoClient

$db protected_oe property

protected Database,MongoDB $db
Résultat MongoDB\Database

$name protected_oe property

protected string $name
Résultat string