Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/cache/stores/mongodb/MongoDB/Command/ -> ListCollections.php (source)

[Source view]

Differences Between: [Versions 400 and 401]

(no description)

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

Defines 1 class

ListCollections:: (3 methods):
  __construct()
  execute()
  createOptions()


Class: ListCollections  - X-Ref

Wrapper for the listCollections command.

__construct($databaseName, array $options = [])   X-Ref
Constructs a listCollections command.

Supported options:

* filter (document): Query by which to filter collections.

* maxTimeMS (integer): The maximum amount of time to allow the query to
run.

* nameOnly (boolean): A flag to indicate whether the command should
return just the collection/view names and type or return both the name
and other information.

* session (MongoDB\Driver\Session): Client session.

Sessions are not supported for server versions < 3.6.

param: string $databaseName Database name
param: array  $options      Command options

execute(Server $server)   X-Ref
Execute the operation.

return: CachingIterator
param: Server $server

createOptions()   X-Ref
Create options for executing the command.

Note: read preference is intentionally omitted, as the spec requires that
the command be executed on the primary.

return: array