PHP Class Phalcon\Db\Adapter\MongoDB\Model\CollectionInfo

This class models the collection information returned by the listCollections command or, for legacy servers, queries on the "system.namespaces" collection. It provides methods to access options for the collection.
See also: MongoDB\Database::listCollections()
See also: https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
Afficher le fichier Open project: phalcon/incubator

Méthodes publiques

Méthode Description
__construct ( array $info ) Constructor.
__debugInfo ( ) : array Return the collection info as an array.
getCappedMax ( ) : integer | null Return the maximum number of documents to keep in the capped collection.
getCappedSize ( ) : integer | null Return the maximum size (in bytes) of the capped collection.
getName ( ) : string Return the collection name.
getOptions ( ) : array Return the collection options.
isCapped ( ) : boolean Return whether the collection is a capped collection.

Method Details

__construct() public méthode

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

__debugInfo() public méthode

Return the collection info as an array.
See also: http://php.net/oop5.magic#language.oop5.magic.debuginfo
public __debugInfo ( ) : array
Résultat array

getCappedMax() public méthode

Return the maximum number of documents to keep in the capped collection.
public getCappedMax ( ) : integer | null
Résultat integer | null

getCappedSize() public méthode

Return the maximum size (in bytes) of the capped collection.
public getCappedSize ( ) : integer | null
Résultat integer | null

getName() public méthode

Return the collection name.
public getName ( ) : string
Résultat string

getOptions() public méthode

Return the collection options.
public getOptions ( ) : array
Résultat array

isCapped() public méthode

Return whether the collection is a capped collection.
public isCapped ( ) : boolean
Résultat boolean