Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/Model/ -> CollectionInfo.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

File Size: 203 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CollectionInfo:: (14 methods):
  __construct()
  __debugInfo()
  getCappedMax()
  getCappedSize()
  getIdIndex()
  getInfo()
  getName()
  getOptions()
  getType()
  isCapped()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()


Class: CollectionInfo  - X-Ref

Collection information model class.

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.

__construct(array $info)   X-Ref

param: array $info Collection info

__debugInfo()   X-Ref
Return the collection info as an array.

return: array

getCappedMax()   X-Ref
Return the maximum number of documents to keep in the capped collection.

return: integer|null

getCappedSize()   X-Ref
Return the maximum size (in bytes) of the capped collection.

return: integer|null

getIdIndex()   X-Ref
Return information about the _id index for the collection.


getInfo()   X-Ref
Return the "info" property of the server response.


getName()   X-Ref
Return the collection name.

return: string

getOptions()   X-Ref
Return the collection options.

return: array

getType()   X-Ref
Return the collection type.


isCapped()   X-Ref
Return whether the collection is a capped collection.

return: boolean

offsetExists($key)   X-Ref
Check whether a field exists in the collection information.

param: mixed $key
return: boolean

offsetGet($key)   X-Ref
Return the field's value from the collection information.

param: mixed $key
return: mixed

offsetSet($key, $value)   X-Ref
Not supported.

param: mixed $key
param: mixed $value
return: void

offsetUnset($key)   X-Ref
Not supported.

param: mixed $key
return: void