Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php
/*
< * Copyright 2018 MongoDB, Inc.
> * Copyright 2018-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\Command; 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 function current; use function is_array;
< use function MongoDB\server_supports_feature;
/** * Operation for the collMod command. * * @api * @see \MongoDB\Database::modifyCollection()
< * @see http://docs.mongodb.org/manual/reference/command/collMod/
> * @see https://mongodb.com/docs/manual/reference/command/collMod/
*/ class ModifyCollection implements Executable { /** @var string */ private $databaseName; /** @var string */ private $collectionName; /** @var array */ private $collectionOptions; /** @var array */ private $options; /** * Constructs a collMod command. * * Supported options: *
< * * session (MongoDB\Driver\Session): Client session.
> * * comment (mixed): BSON value to attach as a comment to this command.
*
< * Sessions are not supported for server versions < 3.6.
> * This is not supported for servers versions < 4.4. > * > * * session (MongoDB\Driver\Session): Client session.
* * * typeMap (array): Type map for BSON deserialization. This will only be * used for the returned command result document. * * * 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 or view to modify * @param array $collectionOptions Collection or view options to assign * @param array $options Command options * @throws InvalidArgumentException for parameter/option parsing errors */
< public function __construct($databaseName, $collectionName, array $collectionOptions, array $options = [])
> public function __construct(string $databaseName, string $collectionName, array $collectionOptions, array $options = [])
{ if (empty($collectionOptions)) { throw new InvalidArgumentException('$collectionOptions is empty'); } if (isset($options['session']) && ! $options['session'] instanceof Session) { throw InvalidArgumentException::invalidType('"session" option', $options['session'], Session::class); } if (isset($options['typeMap']) && ! is_array($options['typeMap'])) { throw InvalidArgumentException::invalidType('"typeMap" option', $options['typeMap'], 'array'); } 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->databaseName = $databaseName; > $this->collectionName = $collectionName;
$this->collectionOptions = $collectionOptions; $this->options = $options; } /** * Execute the operation. * * @see Executable::execute()
< * @param Server $server
* @return array|object Command result document * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) {
< if (isset($this->options['writeConcern']) && ! server_supports_feature($server, self::$wireVersionForWriteConcern)) { < throw UnsupportedException::writeConcernNotSupported(); < } < < $cursor = $server->executeWriteCommand($this->databaseName, new Command(['collMod' => $this->collectionName] + $this->collectionOptions), $this->createOptions());
> $cursor = $server->executeWriteCommand($this->databaseName, $this->createCommand(), $this->createOptions());
if (isset($this->options['typeMap'])) { $cursor->setTypeMap($this->options['typeMap']); } return current($cursor->toArray()); }
> private function createCommand(): Command /** > { * Create options for executing the command. > $cmd = ['collMod' => $this->collectionName] + $this->collectionOptions; * > * @see http://php.net/manual/en/mongodb-driver-server.executereadwritecommand.php > if (isset($this->options['comment'])) { * @return array > $cmd['comment'] = $this->options['comment']; */ > } private function createOptions() > { > return new Command($cmd); $options = []; > } >
< * @see http://php.net/manual/en/mongodb-driver-server.executereadwritecommand.php < * @return array
> * @see https://php.net/manual/en/mongodb-driver-server.executewritecommand.php
< private function createOptions()
> private function createOptions(): array
if (isset($this->options['writeConcern'])) { $options['writeConcern'] = $this->options['writeConcern']; } return $options; } }