Docs Menu

Docs HomePHP Library Manual

MongoDB\Model\IndexInfo Class

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\DatabaseInfoIterator ClassMongoDB\Model\IndexInfo::getKey() →