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.
113 lines
3.9 KiB
113 lines
3.9 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\Driver\Server;
|
|
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
|
|
use MongoDB\Exception\InvalidArgumentException;
|
|
use MongoDB\Exception\UnsupportedException;
|
|
|
|
/**
|
|
* Operation for deleting a document with the findAndModify command.
|
|
*
|
|
* @api
|
|
* @see \MongoDB\Collection::findOneAndDelete()
|
|
* @see http://docs.mongodb.org/manual/reference/command/findAndModify/
|
|
*/
|
|
class FindOneAndDelete implements Executable, Explainable
|
|
{
|
|
private $findAndModify;
|
|
|
|
/**
|
|
* Constructs a findAndModify command for deleting a 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.
|
|
*
|
|
* * maxTimeMS (integer): The maximum amount of time to allow the query to
|
|
* run.
|
|
*
|
|
* * projection (document): Limits the fields to return for the matching
|
|
* document.
|
|
*
|
|
* * session (MongoDB\Driver\Session): Client session.
|
|
*
|
|
* Sessions are not supported for server versions < 3.6.
|
|
*
|
|
* * sort (document): Determines which document the operation modifies if
|
|
* the query selects multiple documents.
|
|
*
|
|
* * typeMap (array): Type map for BSON deserialization.
|
|
*
|
|
* * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
|
|
*
|
|
* This is not supported for server versions < 3.2 and will result in an
|
|
* exception at execution time if used.
|
|
*
|
|
* @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 = [])
|
|
{
|
|
if ( ! is_array($filter) && ! is_object($filter)) {
|
|
throw InvalidArgumentException::invalidType('$filter', $filter, 'array or object');
|
|
}
|
|
|
|
if (isset($options['projection']) && ! is_array($options['projection']) && ! is_object($options['projection'])) {
|
|
throw InvalidArgumentException::invalidType('"projection" option', $options['projection'], 'array or object');
|
|
}
|
|
|
|
if (isset($options['projection'])) {
|
|
$options['fields'] = $options['projection'];
|
|
}
|
|
|
|
unset($options['projection']);
|
|
|
|
$this->findAndModify = new FindAndModify(
|
|
$databaseName,
|
|
$collectionName,
|
|
['query' => $filter, 'remove' => true] + $options
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Execute the operation.
|
|
*
|
|
* @see Executable::execute()
|
|
* @param Server $server
|
|
* @return array|object|null
|
|
* @throws UnsupportedException if collation or write concern is used and unsupported
|
|
* @throws DriverRuntimeException for other driver errors (e.g. connection errors)
|
|
*/
|
|
public function execute(Server $server)
|
|
{
|
|
return $this->findAndModify->execute($server);
|
|
}
|
|
|
|
public function getCommandDocument(Server $server)
|
|
{
|
|
return $this->findAndModify->getCommandDocument($server);
|
|
}
|
|
}
|
|
|