Current Path : C:/xampp/htdocs/moodle/cache/stores/mongodb/MongoDB/Operation/ |
Current File : C:/xampp/htdocs/moodle/cache/stores/mongodb/MongoDB/Operation/FindOne.php |
<?php /* * Copyright 2015-2017 MongoDB, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ namespace MongoDB\Operation; use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException; use MongoDB\Driver\Server; use MongoDB\Exception\InvalidArgumentException; use MongoDB\Exception\UnsupportedException; use function current; /** * Operation for finding a single document with the find command. * * @api * @see \MongoDB\Collection::findOne() * @see http://docs.mongodb.org/manual/tutorial/query-documents/ * @see http://docs.mongodb.org/manual/reference/operator/query-modifier/ */ class FindOne implements Executable, Explainable { /** @var Find */ private $find; /** * Constructs a find command for finding a single document. * * Supported options: * * * collation (document): Collation specification. * * This is not supported for server versions < 3.4 and will result in an * exception at execution time if used. * * * comment (string): Attaches a comment to the query. If "$comment" also * exists in the modifiers document, this option will take precedence. * * * 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. * * This is not supported for server versions < 3.2 and will result in an * exception at execution time if used. * * * 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. * * Sessions are not supported for server versions < 3.6. * * * 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. * * * 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 * @throws InvalidArgumentException for parameter/option parsing errors */ public function __construct($databaseName, $collectionName, $filter, array $options = []) { $this->find = new Find( $databaseName, $collectionName, $filter, ['limit' => 1] + $options ); } /** * Execute the operation. * * @see Executable::execute() * @param Server $server * @return array|object|null * @throws UnsupportedException if collation or read concern is used and unsupported * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) { $cursor = $this->find->execute($server); $document = current($cursor->toArray()); return $document === false ? null : $document; } public function getCommandDocument(Server $server) { return $this->find->getCommandDocument($server); } }