You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
112 lines
3.8 KiB
112 lines
3.8 KiB
<?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\UpdateResult;
|
|
use MongoDB\Driver\Server;
|
|
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
|
|
use MongoDB\Exception\InvalidArgumentException;
|
|
use MongoDB\Exception\UnsupportedException;
|
|
|
|
/**
|
|
* Operation for updating a single document with the update command.
|
|
*
|
|
* @api
|
|
* @see \MongoDB\Collection::updateOne()
|
|
* @see http://docs.mongodb.org/manual/reference/command/update/
|
|
*/
|
|
class UpdateOne implements Executable, Explainable
|
|
{
|
|
private $update;
|
|
|
|
/**
|
|
* Constructs an update command.
|
|
*
|
|
* Supported options:
|
|
*
|
|
* * arrayFilters (document array): A set of filters specifying to which
|
|
* array elements an update should apply.
|
|
*
|
|
* This is not supported for server versions < 3.6 and will result in an$
|
|
* exception at execution time if used.
|
|
*
|
|
* * 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
|
|
* 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.
|
|
*
|
|
* * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
|
|
*
|
|
* @param string $databaseName Database name
|
|
* @param string $collectionName Collection name
|
|
* @param array|object $filter Query by which to filter documents
|
|
* @param array|object $update Update to apply to the matched document
|
|
* @param array $options Command options
|
|
* @throws InvalidArgumentException for parameter/option parsing errors
|
|
*/
|
|
public function __construct($databaseName, $collectionName, $filter, $update, array $options = [])
|
|
{
|
|
if ( ! is_array($update) && ! is_object($update)) {
|
|
throw InvalidArgumentException::invalidType('$update', $update, 'array or object');
|
|
}
|
|
|
|
if ( ! \MongoDB\is_first_key_operator($update)) {
|
|
throw new InvalidArgumentException('First key in $update argument is not an update operator');
|
|
}
|
|
|
|
$this->update = new Update(
|
|
$databaseName,
|
|
$collectionName,
|
|
$filter,
|
|
$update,
|
|
['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);
|
|
}
|
|
|
|
public function getCommandDocument(Server $server)
|
|
{
|
|
return $this->update->getCommandDocument($server);
|
|
}
|
|
}
|
|
|