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\Command;
> use MongoDB\Command\ListCollections as ListCollectionsCommand;
use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException; use MongoDB\Driver\Server;
< use MongoDB\Driver\Session;
use MongoDB\Exception\InvalidArgumentException;
< use MongoDB\Model\CachingIterator;
use MongoDB\Model\CollectionInfoCommandIterator; use MongoDB\Model\CollectionInfoIterator;
< use function is_array; < use function is_integer; < use function is_object;
/** * Operation for the listCollections command. * * @api * @see \MongoDB\Database::listCollections()
< * @see http://docs.mongodb.org/manual/reference/command/listCollections/
> * @see https://mongodb.com/docs/manual/reference/command/listCollections/
*/ class ListCollections implements Executable { /** @var string */ private $databaseName;
< /** @var array */ < private $options;
> /** @var ListCollectionsCommand */ > private $listCollections;
/** * Constructs a listCollections command. * * Supported options: *
> * * authorizedCollections (boolean): Determines which collections are * * filter (document): Query by which to filter collections. > * returned based on the user privileges. * > * * * maxTimeMS (integer): The maximum amount of time to allow the query to > * For servers < 4.0, this option is ignored. * run. > * * > * * comment (mixed): BSON value to attach as a comment to this command. * * session (MongoDB\Driver\Session): Client session. > * * > * This is not supported for servers versions < 4.4. * Sessions are not supported for server versions < 3.6. > *
< * Sessions are not supported for server versions < 3.6. < *
* @param array $options Command options * @throws InvalidArgumentException for parameter/option parsing errors */
< public function __construct($databaseName, array $options = [])
> public function __construct(string $databaseName, array $options = [])
{
< if (isset($options['filter']) && ! is_array($options['filter']) && ! is_object($options['filter'])) { < throw InvalidArgumentException::invalidType('"filter" option', $options['filter'], 'array or object'); < } < < if (isset($options['maxTimeMS']) && ! is_integer($options['maxTimeMS'])) { < throw InvalidArgumentException::invalidType('"maxTimeMS" option', $options['maxTimeMS'], 'integer'); < } < < if (isset($options['session']) && ! $options['session'] instanceof Session) { < throw InvalidArgumentException::invalidType('"session" option', $options['session'], Session::class); < } < < $this->databaseName = (string) $databaseName; < $this->options = $options;
> $this->databaseName = $databaseName; > $this->listCollections = new ListCollectionsCommand($databaseName, ['nameOnly' => false] + $options);
} /** * Execute the operation. * * @see Executable::execute()
< * @param Server $server
* @return CollectionInfoIterator * @throws DriverRuntimeException for other driver errors (e.g. connection errors) */ public function execute(Server $server) {
< return $this->executeCommand($server); < } < < /** < * Create options for executing the command. < * < * Note: read preference is intentionally omitted, as the spec requires that < * the command be executed on the primary. < * < * @see http://php.net/manual/en/mongodb-driver-server.executecommand.php < * @return array < */ < private function createOptions() < { < $options = []; < < if (isset($this->options['session'])) { < $options['session'] = $this->options['session']; < } < < return $options; < } < < /** < * Returns information for all collections in this database using the < * listCollections command. < * < * @param Server $server < * @return CollectionInfoCommandIterator < * @throws DriverRuntimeException for other driver errors (e.g. connection errors) < */ < private function executeCommand(Server $server) < { < $cmd = ['listCollections' => 1]; < < if (! empty($this->options['filter'])) { < $cmd['filter'] = (object) $this->options['filter']; < } < < if (isset($this->options['maxTimeMS'])) { < $cmd['maxTimeMS'] = $this->options['maxTimeMS']; < } < < $cursor = $server->executeReadCommand($this->databaseName, new Command($cmd), $this->createOptions()); < $cursor->setTypeMap(['root' => 'array', 'document' => 'array']); < < return new CollectionInfoCommandIterator(new CachingIterator($cursor));
> return new CollectionInfoCommandIterator($this->listCollections->execute($server), $this->databaseName);
} }