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/Operation/ -> Explain.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: 171 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Explain:: (5 methods):
  __construct()
  execute()
  createCommand()
  createOptions()
  isFindAndModify()


Class: Explain  - X-Ref

Operation for the explain command.

__construct(string $databaseName, Explainable $explainable, array $options = [])   X-Ref
Constructs an explain command for explainable operations.

Supported options:

* comment (mixed): BSON value to attach as a comment to this command.

This is not supported for servers versions < 4.4.

* readPreference (MongoDB\Driver\ReadPreference): Read preference.

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

* typeMap (array): Type map for BSON deserialization. This will be used
used for the returned command result document.

* verbosity (string): The mode in which the explain command will be run.

param: string      $databaseName Database name
param: Explainable $explainable  Operation to explain
param: array       $options      Command options

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

return: array|object

createCommand(Server $server)   X-Ref
Create the explain command.


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


isFindAndModify(Explainable $explainable)   X-Ref
No description