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 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\Command\ListCollections as ListCollectionsCommand; use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException; use MongoDB\Driver\Server; use MongoDB\Exception\InvalidArgumentException; use MongoDB\Model\CollectionInfoCommandIterator; use MongoDB\Model\CollectionInfoIterator; /** * 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 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 = [])
{
< $this->databaseName = (string) $databaseName;
> $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 new CollectionInfoCommandIterator($this->listCollections->execute($server), $this->databaseName); } }