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
Datei anzeigen Open project: phalcon/incubator

Public Methods

Method 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 method

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

__debugInfo() public method

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

getCappedMax() public method

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

getCappedSize() public method

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

getName() public method

Return the collection name.
public getName ( ) : string
return string

getOptions() public method

Return the collection options.
public getOptions ( ) : array
return array

isCapped() public method

Return whether the collection is a capped collection.
public isCapped ( ) : boolean
return boolean