PHP Класс Phalcon\Db\Adapter\MongoDB\Model\IndexInfo

This class models the index information returned by the listIndexes command or, for legacy servers, queries on the "system.indexes" collection. It provides methods to access common index options, and allows access to other options through the ArrayAccess interface (write methods are not supported). For information on keys and index options, see the referenced db.collection.createIndex() documentation.
См. также: MongoDB\Collection::listIndexes()
См. также: https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst
См. также: http://docs.mongodb.org/manual/reference/method/db.collection.createIndex/
Наследование: implements ArrayAcces\ArrayAccess
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( array $info ) Constructor.
__debugInfo ( ) : array Return the collection info as an array.
getKey ( ) : array Return the index key.
getName ( ) : string Return the index name.
getNamespace ( ) : string Return the index namespace (e.g. "db.collection").
getVersion ( ) : integer Return the index version.
isSparse ( ) : boolean Return whether this is a sparse index.
isTtl ( ) : boolean Return whether this is a TTL index.
isUnique ( ) : boolean Return whether this is a unique index.
offsetExists ( mixed $key ) : boolean Check whether a field exists in the index information.
offsetGet ( mixed $key ) : mixed Return the field's value from the index information.
offsetSet ( $key, $value ) Not supported.
offsetUnset ( $key ) Not supported.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( array $info )
$info array Index info

__debugInfo() публичный Метод

Return the collection info as an array.
См. также: http://php.net/oop5.magic#language.oop5.magic.debuginfo
public __debugInfo ( ) : array
Результат array

getKey() публичный Метод

Return the index key.
public getKey ( ) : array
Результат array

getName() публичный Метод

Return the index name.
public getName ( ) : string
Результат string

getNamespace() публичный Метод

Return the index namespace (e.g. "db.collection").
public getNamespace ( ) : string
Результат string

getVersion() публичный Метод

Return the index version.
public getVersion ( ) : integer
Результат integer

isSparse() публичный Метод

Return whether this is a sparse index.
См. также: http://docs.mongodb.org/manual/core/index-sparse/
public isSparse ( ) : boolean
Результат boolean

isTtl() публичный Метод

Return whether this is a TTL index.
См. также: http://docs.mongodb.org/manual/core/index-ttl/
public isTtl ( ) : boolean
Результат boolean

isUnique() публичный Метод

Return whether this is a unique index.
См. также: http://docs.mongodb.org/manual/core/index-unique/
public isUnique ( ) : boolean
Результат boolean

offsetExists() публичный Метод

Check whether a field exists in the index information.
См. также: http://php.net/arrayaccess.offsetexists
public offsetExists ( mixed $key ) : boolean
$key mixed
Результат boolean

offsetGet() публичный Метод

This method satisfies the Enumerating Indexes specification's requirement that index fields be made accessible under their original names. It may also be used to access fields that do not have a helper method.
См. также: http://php.net/arrayaccess.offsetget
См. также: https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst#getting-full-index-information
public offsetGet ( mixed $key ) : mixed
$key mixed
Результат mixed

offsetSet() публичный Метод

Not supported.
См. также: http://php.net/arrayaccess.offsetset
public offsetSet ( $key, $value )

offsetUnset() публичный Метод

Not supported.
См. также: http://php.net/arrayaccess.offsetunset
public offsetUnset ( $key )