API Documentation
\

\Horde_Mongo_Client

Extend the base PECL MongoClient class by allowing it to be serialized.

Summary

Methods
Properties
Constants
__construct()
dropDB()
selectCollection()
selectDB()
checkIndices()
createIndices()
serialize()
unserialize()
$dbname
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_cArgs
N/A

Properties

$dbname

$dbname : string

Database name (Horde_Mongo_Client uses this single database by default to ease configuration).

Type

string

$_cArgs

$_cArgs : array

Constructor args.

Type

array

Methods

__construct()

__construct(  $server = null, array  $options = array())

Parameters

$server
array $options

dropDB()

dropDB(  $db)

Parameters

$db

selectCollection()

selectCollection(  $db,   $collection = null)

Parameters

$db
$collection

selectDB()

selectDB(  $name)

Parameters

$name

checkIndices()

checkIndices(mixed  $collection, array  $indices) : boolean

Checks that indices are up-to-date.

Parameters

mixed $collection

The collection name or a MongoCollection object.
array $indices

The index definition (see ensureIndex()).

Returns

boolean —

True if the indices are up-to-date.

createIndices()

createIndices(mixed  $collection, array  $indices)

Create indices for the collection.

Parameters

mixed $collection

The collection name or a MongoCollection object.
array $indices

The index definition (see ensureIndex()).

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data