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/ -> FindOne.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: 142 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FindOne:: (3 methods):
  __construct()
  execute()
  getCommandDocument()


Class: FindOne  - X-Ref

Operation for finding a single document with the find command.

__construct(string $databaseName, string $collectionName, $filter, array $options = [])   X-Ref
Constructs a find command for finding a single document.

Supported options:

* collation (document): Collation specification.

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

Only string values are supported for server versions < 4.4.

* hint (string|document): The index to use. Specify either the index
name as a string or the index key pattern as a document. If specified,
then the query system will only consider plans using the hinted index.

* max (document): The exclusive upper bound for a specific index.

* maxScan (integer): Maximum number of documents or index keys to scan
when executing the query.

This option has been deprecated since version 1.4.

* maxTimeMS (integer): The maximum amount of time to allow the query to
run. If "$maxTimeMS" also exists in the modifiers document, this
option will take precedence.

* min (document): The inclusive upper bound for a specific index.

* modifiers (document): Meta-operators modifying the output or behavior
of a query.

* projection (document): Limits the fields to return for the matching
document.

* readConcern (MongoDB\Driver\ReadConcern): Read concern.

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

* returnKey (boolean): If true, returns only the index keys in the
resulting documents.

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

* showRecordId (boolean): Determines whether to return the record
identifier for each document. If true, adds a field $recordId to the
returned documents.

* skip (integer): The number of documents to skip before returning.

* sort (document): The order in which to return matching documents. If
"$orderby" also exists in the modifiers document, this option will
take precedence.

* let (document): Map of parameter names and values. Values must be
constant or closed expressions that do not reference document fields.
Parameters can then be accessed as variables in an aggregate
expression context (e.g. "$$var").

* typeMap (array): Type map for BSON deserialization.

param: string       $databaseName   Database name
param: string       $collectionName Collection name
param: array|object $filter         Query by which to filter documents
param: array        $options        Command options

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

return: array|object|null

getCommandDocument(Server $server)   X-Ref
Returns the command document for this operation.

return: array