Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/cache/stores/mongodb/MongoDB/Model/ -> CollectionInfo.php (source)

[Source view]

Differences Between: [Versions 311 and 401]

(no description)

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

Defines 1 class

CollectionInfo:: (11 methods):
  __construct()
  __debugInfo()
  getCappedMax()
  getCappedSize()
  getName()
  getOptions()
  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

getName()   X-Ref
Return the collection name.

return: string

getOptions()   X-Ref
Return the collection options.

return: array

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

offsetUnset($key)   X-Ref
Not supported.

param: mixed $key