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
파일 보기 프로젝트 열기: phalcon/incubator

공개 메소드들

메소드 설명
__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 )