Navigation

Enumeration Classes

MongoDB\Model\CollectionInfo

Definition

MongoDB\Model\CollectionInfo

This class models information about a collection. Instances of this class are returned by traversing a MongoDB\Model\CollectionInfoIterator, which is returned by MongoDB\Database::listCollections().


MongoDB\Model\CollectionInfoIterator

Definition

MongoDB\Model\CollectionInfoIterator

This interface extends PHP’s Iterator interface. An instance of this interface is returned by MongoDB\Database::listCollections().

Methods

This interface adds no new methods to Iterator, but specifies that current() will return an instance of MongoDB\Model\CollectionInfo.


MongoDB\Model\DatabaseInfo

Definition

MongoDB\Model\DatabaseInfo

This class models information about a database. Instances of this class are returned by traversing a MongoDB\Model\DatabaseInfoIterator, which is returned by MongoDB\Client::listDatabases().


MongoDB\Model\DatabaseInfoIterator

Definition

MongoDB\Model\DatabaseInfoIterator

This interface extends PHP’s Iterator interface. An instance of this interface is returned by MongoDB\Client::listDatabases().

Methods

This interface adds no new methods to Iterator, but specifies that current() will return an instance of MongoDB\Model\DatabaseInfo.


MongoDB\Model\IndexInfo

MongoDB\Model\IndexInfo

This class models information about an index. Instances of this class are returned by traversing a MongoDB\Model\IndexInfoIterator, which is returned by MongoDB\Collection::listIndexes().

This class implements PHP’s ArrayAccess interface. This provides a mechanism for accessing index fields for which there exists no helper method. isset() may be used to check for the existence of a field before accessing it with [].

Note

The MongoDB\Model\IndexInfo class is immutable. Attempting to modify it via the ArrayAccess interface will result in a MongoDB\Exception\BadMethodCallException.


MongoDB\Model\IndexInfoIterator

Definition

MongoDB\Model\IndexInfoIterator

This interface extends PHP’s Iterator interface. An instance of this interface is returned by MongoDB\Collection::listIndexes().

Methods

This interface adds no new methods to Iterator, but specifies that current() will return an instance of MongoDB\Model\IndexInfo.