PHP Class Horde_Mongo_Client, horde

Author: Michael Slusarz ([email protected])
Inheritance: extends MongoClient, implements Serializable
Show file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$dbname string Database name (Horde_Mongo_Client uses this single database by default to ease configuration).

Public Methods

Method Description
__construct ( $server = null, array $options = [] )
checkIndices ( mixed $collection, array $indices ) : boolean Checks that indices are up-to-date.
createIndices ( mixed $collection, array $indices ) Create indices for the collection.
dropDB ( $db )
selectCollection ( $db, $collection = null )
selectDB ( $name )
serialize ( )
unserialize ( $data )

Method Details

__construct() public method

public __construct ( $server = null, array $options = [] )
$options array

checkIndices() public method

Checks that indices are up-to-date.
public checkIndices ( mixed $collection, array $indices ) : boolean
$collection mixed The collection name or a MongoCollection object.
$indices array The index definition (see ensureIndex()).
return boolean True if the indices are up-to-date.

createIndices() public method

Create indices for the collection.
public createIndices ( mixed $collection, array $indices )
$collection mixed The collection name or a MongoCollection object.
$indices array The index definition (see ensureIndex()).

dropDB() public method

Deprecation:
public dropDB ( $db )

selectCollection() public method

public selectCollection ( $db, $collection = null )

selectDB() public method

public selectDB ( $name )

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )

Property Details

$dbname public property

Database name (Horde_Mongo_Client uses this single database by default to ease configuration).
public string $dbname
return string