Current Path : C:/xampp/htdocs/moodle/cache/stores/mongodb/MongoDB/Operation/ |
Current File : C:/xampp/htdocs/moodle/cache/stores/mongodb/MongoDB/Operation/InsertOne.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\BulkWrite as Bulk; use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException; use MongoDB\Driver\Server; use MongoDB\Driver\Session; use MongoDB\Driver\WriteConcern; use MongoDB\Exception\InvalidArgumentException; use MongoDB\Exception\UnsupportedException; use MongoDB\InsertOneResult; use function is_array; use function is_bool; use function is_object; use function MongoDB\server_supports_feature; /** * Operation for inserting a single document with the insert command. * * @api * @see \MongoDB\Collection::insertOne() * @see http://docs.mongodb.org/manual/reference/command/insert/ */ class InsertOne implements Executable { /** @var integer */ private static $wireVersionForDocumentLevelValidation = 4; /** @var string */ private $databaseName; /** @var string */ private $collectionName; /** @var array|object */ private $document; /** @var array */ private $options; /** * Constructs an insert command. * * Supported options: * * * bypassDocumentValidation (boolean): If true, allows the write to * circumvent document level validation. * * For servers < 3.2, this option is ignored as document level validation * is not available. * * * session (MongoDB\Driver\Session): Client session. * * Sessions are not supported for server versions < 3.6. * * * writeConcern (MongoDB\Driver\WriteConcern): Write concern. * * @param string $databaseName Database name * @param string $collectionName Collection name * @param array|object $document Document to insert * @param array $options Command options * @throws InvalidArgumentException for parameter/option parsing errors */ public function __construct($databaseName, $collectionName, $document, array $options = []) { if (! is_array($document) && ! is_object($document)) { throw InvalidArgumentException::invalidType('$document', $document, 'array or object'); } if (isset($options['bypassDocumentValidation']) && ! is_bool($options['bypassDocumentValidation'])) { throw InvalidArgumentException::invalidType('"bypassDocumentValidation" option', $options['bypassDocumentValidation'], 'boolean'); } if (isset($options['session']) && ! $options['session'] instanceof Session) { throw InvalidArgumentException::invalidType('"session" option', $options['session'], Session::class); } if (isset($options['writeConcern']) && ! $options['writeConcern'] instanceof WriteConcern) { throw InvalidArgumentException::invalidType('"writeConcern" option', $options['writeConcern'], WriteConcern::class); } if (isset($options['writeConcern']) && $options['writeConcern']->isDefault()) { unset($options['writeConcern']); } $this->databaseName = (string) $databaseName; $this->collectionName = (string) $collectionName; $this->document = $document; $this->options = $options; } /** * Execute the operation. * * @see Executable::execute() * @param Server $server * @return InsertOneResult * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) { $options = []; $inTransaction = isset($this->options['session']) && $this->options['session']->isInTransaction(); if (isset($this->options['writeConcern']) && $inTransaction) { throw UnsupportedException::writeConcernNotSupportedInTransaction(); } if (! empty($this->options['bypassDocumentValidation']) && server_supports_feature($server, self::$wireVersionForDocumentLevelValidation) ) { $options['bypassDocumentValidation'] = $this->options['bypassDocumentValidation']; } $bulk = new Bulk($options); $insertedId = $bulk->insert($this->document); $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $this->createOptions()); return new InsertOneResult($writeResult, $insertedId); } /** * Create options for executing the bulk write. * * @see http://php.net/manual/en/mongodb-driver-server.executebulkwrite.php * @return array */ private function createOptions() { $options = []; if (isset($this->options['session'])) { $options['session'] = $this->options['session']; } if (isset($this->options['writeConcern'])) { $options['writeConcern'] = $this->options['writeConcern']; } return $options; } }