Horde_Mongo_Client
extends MongoClient
in package
implements
Serializable
Extend the base PECL MongoClient class by allowing it to be serialized.
Tags
Interfaces, Classes and Traits
- Serializable
Table of Contents
- $dbname : string
- Database name (Horde_Mongo_Client uses this single database by default to ease configuration).
- $_cArgs : array<string|int, mixed>
- Constructor args.
- __construct() : mixed
- checkIndices() : bool
- Checks that indices are up-to-date.
- createIndices() : mixed
- Create indices for the collection.
- dropDB() : mixed
- selectCollection() : mixed
- selectDB() : mixed
- serialize() : mixed
- unserialize() : mixed
Properties
$dbname
Database name (Horde_Mongo_Client uses this single database by default to ease configuration).
public
string
$dbname
= 'horde'
$_cArgs
Constructor args.
private
array<string|int, mixed>
$_cArgs
Methods
__construct()
public
__construct([mixed $server = null ][, array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $server : mixed = null
- $options : array<string|int, mixed> = array()
Tags
Return values
mixed —checkIndices()
Checks that indices are up-to-date.
public
checkIndices(mixed $collection, array<string|int, mixed> $indices) : bool
Parameters
- $collection : mixed
-
The collection name or a MongoCollection object.
- $indices : array<string|int, mixed>
-
The index definition (see ensureIndex()).
Return values
bool —True if the indices are up-to-date.
createIndices()
Create indices for the collection.
public
createIndices(mixed $collection, array<string|int, mixed> $indices) : mixed
Parameters
- $collection : mixed
-
The collection name or a MongoCollection object.
- $indices : array<string|int, mixed>
-
The index definition (see ensureIndex()).
Return values
mixed —dropDB()
public
dropDB(mixed $db) : mixed
Parameters
- $db : mixed
Tags
Return values
mixed —selectCollection()
public
selectCollection(mixed $db[, mixed $collection = null ]) : mixed
Parameters
- $db : mixed
- $collection : mixed = null
Tags
Return values
mixed —selectDB()
public
selectDB(mixed $name) : mixed
Parameters
- $name : mixed
Tags
Return values
mixed —serialize()
public
serialize() : mixed
Return values
mixed —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed