Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php
/*
< * Copyright 2015-2017 MongoDB, Inc.
> * Copyright 2015-present 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
> * https://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 MongoDB\UpdateResult;
>
use function is_array; use function is_object; use function MongoDB\is_first_key_operator; use function MongoDB\is_pipeline; /** * Operation for replacing a single document with the update command. * * @api * @see \MongoDB\Collection::replaceOne()
< * @see http://docs.mongodb.org/manual/reference/command/update/
> * @see https://mongodb.com/docs/manual/reference/command/update/
*/ class ReplaceOne implements Executable { /** @var Update */ private $update; /** * Constructs an update 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. < *
* * collation (document): Collation specification. *
< * This is not supported for server versions < 3.4 and will result in an
> * * comment (mixed): BSON value to attach as a comment to this command. > * > * This is not supported for servers 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. > * > * This is not supported for server versions < 4.2 and will result in an
* exception at execution time if used. * * * session (MongoDB\Driver\Session): Client session. *
< * Sessions are not supported for server versions < 3.6. < *
* * upsert (boolean): When true, a new document is created if no document * matches the query. The default is false. *
> * * let (document): Map of parameter names and values. Values must be * * writeConcern (MongoDB\Driver\WriteConcern): Write concern. > * constant or closed expressions that do not reference document fields. * > * Parameters can then be accessed as variables in an aggregate * @param string $databaseName Database name > * expression context (e.g. "$$var"). * @param string $collectionName Collection name > *
* @param array|object $filter Query by which to filter documents * @param array|object $replacement Replacement document * @param array $options Command options * @throws InvalidArgumentException for parameter/option parsing errors */
< public function __construct($databaseName, $collectionName, $filter, $replacement, array $options = [])
> public function __construct(string $databaseName, string $collectionName, $filter, $replacement, array $options = [])
{ if (! is_array($replacement) && ! is_object($replacement)) { throw InvalidArgumentException::invalidType('$replacement', $replacement, 'array or object'); } if (is_first_key_operator($replacement)) { throw new InvalidArgumentException('First key in $replacement argument is an update operator'); } if (is_pipeline($replacement)) { throw new InvalidArgumentException('$replacement argument is a pipeline'); } $this->update = new Update( $databaseName, $collectionName, $filter, $replacement, ['multi' => false] + $options ); } /** * Execute the operation. * * @see Executable::execute()
< * @param Server $server
* @return UpdateResult * @throws UnsupportedException if collation is used and unsupported * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) { return $this->update->execute($server); } }