PHPLIB-953 Make internal classes and Operation classes final (#1392)

* PHPLIB-953 Make internal classes final

* Make all Operation classes final

* Add UPGRADE-2.0

Author: GromNaN

UPGRADE-2.0.md

@@ -36,7 +36,7 @@
  * @internal
  * @see https://mongodb.com/docs/manual/reference/command/listCollections/
  */
-class ListCollections implements Executable
+final class ListCollections implements Executable
 {
     /**
      * Constructs a listCollections command.

src/Command/ListCollections.php

@@ -37,7 +37,7 @@
  * @internal
  * @see https://mongodb.com/docs/manual/reference/command/listDatabases/
  */
-class ListDatabases implements Executable
+final class ListDatabases implements Executable
 {
     /**
      * Constructs a listDatabases command.

src/Command/ListDatabases.php

@@ -39,7 +39,7 @@
  *
  * @internal
  */
-class CollectionWrapper
+final class CollectionWrapper
 {
     private Collection $chunksCollection;
 

src/GridFS/CollectionWrapper.php

@@ -38,7 +38,7 @@
  *
  * @internal
  */
-class ReadableStream
+final class ReadableStream
 {
     private ?string $buffer = null;
 

src/GridFS/ReadableStream.php

@@ -49,7 +49,7 @@
  * @see Bucket::openDownloadStream()
  * @psalm-type ContextOptions = array{collectionWrapper: CollectionWrapper, file: object}|array{collectionWrapper: CollectionWrapper, filename: string, options: array}
  */
-class StreamWrapper
+final class StreamWrapper
 {
     /** @var resource|null Stream context (set by PHP) */
     public $context;
@@ -89,7 +89,7 @@ public static function register(string $protocol = 'gridfs'): void
             stream_wrapper_unregister($protocol);
         }
 
-        stream_wrapper_register($protocol, static::class, STREAM_IS_URL);
+        stream_wrapper_register($protocol, self::class, STREAM_IS_URL);
     }
 
     /**

src/GridFS/StreamWrapper.php

@@ -35,7 +35,7 @@
  *
  * @internal
  */
-class WritableStream
+final class WritableStream
 {
     private const DEFAULT_CHUNK_SIZE_BYTES = 261120;
 

src/GridFS/WritableStream.php

@@ -40,7 +40,7 @@
  * @template TValue
  * @template-implements Iterator<TKey, TValue>
  */
-class CachingIterator implements Countable, Iterator
+final class CachingIterator implements Countable, Iterator
 {
     private const FIELD_KEY = 0;
     private const FIELD_VALUE = 1;

src/Model/CachingIterator.php

@@ -34,7 +34,7 @@
  * @template TCallbackValue
  * @template-implements Iterator<TKey, TCallbackValue>
  */
-class CallbackIterator implements Iterator
+final class CallbackIterator implements Iterator
 {
     /** @var callable(TValue, TKey): TCallbackValue */
     private $callback;

src/Model/CallbackIterator.php

@@ -51,7 +51,7 @@
  * @template TValue of array|object
  * @template-extends IteratorIterator<int, TValue, CursorInterface<int, TValue>&Iterator<int, TValue>>
  */
-class ChangeStreamIterator extends IteratorIterator implements CommandSubscriber
+final class ChangeStreamIterator extends IteratorIterator implements CommandSubscriber
 {
     private int $batchPosition = 0;
 

src/Model/ChangeStreamIterator.php

@@ -32,7 +32,7 @@
  * @see https://mongodb.com/docs/manual/reference/command/listCollections/
  * @template-extends IteratorIterator<int, array, Traversable<int, array>>
  */
-class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
+final class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
 {
     /** @param Traversable<int, array> $iterator */
     public function __construct(Traversable $iterator, private ?string $databaseName = null)

src/Model/CollectionInfoCommandIterator.php

@@ -32,7 +32,7 @@
  * @see \MongoDB\Client::listDatabases()
  * @see https://mongodb.com/docs/manual/reference/command/listDatabases/
  */
-class DatabaseInfoLegacyIterator implements DatabaseInfoIterator
+final class DatabaseInfoLegacyIterator implements DatabaseInfoIterator
 {
     public function __construct(private array $databases)
     {

src/Model/DatabaseInfoLegacyIterator.php

@@ -36,7 +36,7 @@
  * @see https://mongodb.com/docs/manual/reference/system-collections/
  * @template-extends IteratorIterator<int, array, Traversable<int, array>>
  */
-class IndexInfoIteratorIterator extends IteratorIterator implements IndexInfoIterator
+final class IndexInfoIteratorIterator extends IteratorIterator implements IndexInfoIterator
 {
     /** @param Traversable<int, array> $iterator */
     public function __construct(Traversable $iterator, private ?string $ns = null)

src/Model/IndexInfoIteratorIterator.php

@@ -38,7 +38,7 @@
  * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst
  * @see https://mongodb.com/docs/manual/reference/method/db.collection.createIndex/
  */
-class IndexInput implements Serializable
+final class IndexInput implements Serializable
 {
     /**
      * @param array $index Index specification

src/Model/IndexInput.php

@@ -34,7 +34,7 @@
  * @see https://github.com/mongodb/specifications/blob/master/source/index-management/index-management.rst#search-indexes
  * @see https://mongodb.com/docs/manual/reference/method/db.collection.createSearchIndex/
  */
-class SearchIndexInput implements Serializable
+final class SearchIndexInput implements Serializable
 {
     /**
      * @param array{definition: array|object, name?: string, type?: string} $index Search index specification

src/Model/SearchIndexInput.php

@@ -49,7 +49,7 @@
  * @see \MongoDB\Collection::aggregate()
  * @see https://mongodb.com/docs/manual/reference/command/aggregate/
  */
-class Aggregate implements Executable, Explainable
+final class Aggregate implements Executable, Explainable
 {
     private bool $isWrite;
 

src/Operation/Aggregate.php

@@ -46,7 +46,7 @@
  *
  * @see \MongoDB\Collection::bulkWrite()
  */
-class BulkWrite implements Executable
+final class BulkWrite implements Executable
 {
     public const DELETE_MANY = 'deleteMany';
     public const DELETE_ONE  = 'deleteOne';

src/Operation/BulkWrite.php

@@ -41,7 +41,7 @@
  * @see \MongoDB\Collection::count()
  * @see https://mongodb.com/docs/manual/reference/command/count/
  */
-class Count implements Executable, Explainable
+final class Count implements Executable, Explainable
 {
     /**
      * Constructs a count command.

src/Operation/Count.php

@@ -37,7 +37,7 @@
  * @see \MongoDB\Collection::countDocuments()
  * @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#countdocuments
  */
-class CountDocuments implements Executable
+final class CountDocuments implements Executable
 {
     private array $aggregateOptions;
 

src/Operation/CountDocuments.php

@@ -41,7 +41,7 @@
  * @see \MongoDB\Database::createCollection()
  * @see https://mongodb.com/docs/manual/reference/command/create/
  */
-class CreateCollection implements Executable
+final class CreateCollection implements Executable
 {
     public const USE_POWER_OF_2_SIZES = 1;
     public const NO_PADDING = 2;

src/Operation/CreateCollection.php

@@ -48,7 +48,7 @@
  * @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-encrypted-collection-helper
  * @see https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/manage-collections/
  */
-class CreateEncryptedCollection implements Executable
+final class CreateEncryptedCollection implements Executable
 {
     private const WIRE_VERSION_FOR_QUERYABLE_ENCRYPTION_V2 = 21;
 

src/Operation/CreateEncryptedCollection.php

@@ -41,7 +41,7 @@
  * @see \MongoDB\Collection::createIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/createIndexes/
  */
-class CreateIndexes implements Executable
+final class CreateIndexes implements Executable
 {
     private const WIRE_VERSION_FOR_COMMIT_QUORUM = 9;
 

src/Operation/CreateIndexes.php

@@ -37,7 +37,7 @@
  * @see \MongoDB\Collection::createSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/createSearchIndexes/
  */
-class CreateSearchIndexes implements Executable
+final class CreateSearchIndexes implements Executable
 {
     private array $indexes = [];
 

src/Operation/CreateSearchIndexes.php

@@ -32,7 +32,7 @@
  *
  * @see \MongoDB\Database::command()
  */
-class DatabaseCommand implements Executable
+final class DatabaseCommand implements Executable
 {
     private Command $command;
 

src/Operation/DatabaseCommand.php

@@ -42,7 +42,7 @@
  * @internal
  * @see https://mongodb.com/docs/manual/reference/command/delete/
  */
-class Delete implements Executable, Explainable
+final class Delete implements Executable, Explainable
 {
     private const WIRE_VERSION_FOR_HINT = 9;
 

src/Operation/Delete.php

@@ -29,7 +29,7 @@
  * @see \MongoDB\Collection::deleteOne()
  * @see https://mongodb.com/docs/manual/reference/command/delete/
  */
-class DeleteMany implements Executable, Explainable
+final class DeleteMany implements Executable, Explainable
 {
     private Delete $delete;
 

src/Operation/DeleteMany.php

@@ -29,7 +29,7 @@
  * @see \MongoDB\Collection::deleteOne()
  * @see https://mongodb.com/docs/manual/reference/command/delete/
  */
-class DeleteOne implements Executable, Explainable
+final class DeleteOne implements Executable, Explainable
 {
     private Delete $delete;
 

src/Operation/DeleteOne.php

@@ -40,7 +40,7 @@
  * @see \MongoDB\Collection::distinct()
  * @see https://mongodb.com/docs/manual/reference/command/distinct/
  */
-class Distinct implements Executable, Explainable
+final class Distinct implements Executable, Explainable
 {
     /**
      * Constructs a distinct command.

src/Operation/Distinct.php

@@ -36,7 +36,7 @@
  * @see \MongoDB\Database::dropCollection()
  * @see https://mongodb.com/docs/manual/reference/command/drop/
  */
-class DropCollection implements Executable
+final class DropCollection implements Executable
 {
     private const ERROR_CODE_NAMESPACE_NOT_FOUND = 26;
 

src/Operation/DropCollection.php

@@ -34,7 +34,7 @@
  * @see \MongoDB\Database::drop()
  * @see https://mongodb.com/docs/manual/reference/command/dropDatabase/
  */
-class DropDatabase implements Executable
+final class DropDatabase implements Executable
 {
     /**
      * Constructs a dropDatabase command.

src/Operation/DropDatabase.php

@@ -37,7 +37,7 @@
  * @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#drop-collection-helper
  * @see https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/manage-collections/
  */
-class DropEncryptedCollection implements Executable
+final class DropEncryptedCollection implements Executable
 {
     private DropCollection $dropCollection;
 

src/Operation/DropEncryptedCollection.php

@@ -35,7 +35,7 @@
  * @see \MongoDB\Collection::dropIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/dropIndexes/
  */
-class DropIndexes implements Executable
+final class DropIndexes implements Executable
 {
     /**
      * Constructs a dropIndexes command.

src/Operation/DropIndexes.php

@@ -30,7 +30,7 @@
  * @see \MongoDB\Collection::dropSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/dropSearchIndexes/
  */
-class DropSearchIndex implements Executable
+final class DropSearchIndex implements Executable
 {
     private const ERROR_CODE_NAMESPACE_NOT_FOUND = 26;
 

src/Operation/DropSearchIndex.php

@@ -35,7 +35,7 @@
  * @see \MongoDB\Collection::estimatedDocumentCount()
  * @see https://mongodb.com/docs/manual/reference/command/count/
  */
-class EstimatedDocumentCount implements Executable, Explainable
+final class EstimatedDocumentCount implements Executable, Explainable
 {
     private array $options;
 

src/Operation/EstimatedDocumentCount.php

@@ -35,7 +35,7 @@
  * @see \MongoDB\Collection::explain()
  * @see https://mongodb.com/docs/manual/reference/command/explain/
  */
-class Explain implements Executable
+final class Explain implements Executable
 {
     public const VERBOSITY_ALL_PLANS = 'allPlansExecution';
     public const VERBOSITY_EXEC_STATS = 'executionStats';

src/Operation/Explain.php

@@ -48,7 +48,7 @@
  * @see https://mongodb.com/docs/manual/tutorial/query-documents/
  * @see https://mongodb.com/docs/manual/reference/operator/query-modifier/
  */
-class Find implements Executable, Explainable
+final class Find implements Executable, Explainable
 {
     public const NON_TAILABLE = 1;
     public const TAILABLE = 2;

src/Operation/Find.php

@@ -51,7 +51,7 @@
  * @internal
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
  */
-class FindAndModify implements Executable, Explainable
+final class FindAndModify implements Executable, Explainable
 {
     private const WIRE_VERSION_FOR_HINT = 9;
 

src/Operation/FindAndModify.php

@@ -31,7 +31,7 @@
  * @see https://mongodb.com/docs/manual/tutorial/query-documents/
  * @see https://mongodb.com/docs/manual/reference/operator/query-modifier/
  */
-class FindOne implements Executable, Explainable
+final class FindOne implements Executable, Explainable
 {
     private Find $find;
 

src/Operation/FindOne.php

@@ -30,7 +30,7 @@
  * @see \MongoDB\Collection::findOneAndDelete()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
  */
-class FindOneAndDelete implements Executable, Explainable
+final class FindOneAndDelete implements Executable, Explainable
 {
     private FindAndModify $findAndModify;
 

src/Operation/FindOneAndDelete.php

@@ -35,7 +35,7 @@
  * @see \MongoDB\Collection::findOneAndReplace()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
  */
-class FindOneAndReplace implements Executable, Explainable
+final class FindOneAndReplace implements Executable, Explainable
 {
     public const RETURN_DOCUMENT_BEFORE = 1;
     public const RETURN_DOCUMENT_AFTER = 2;

src/Operation/FindOneAndReplace.php

@@ -34,7 +34,7 @@
  * @see \MongoDB\Collection::findOneAndUpdate()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
  */
-class FindOneAndUpdate implements Executable, Explainable
+final class FindOneAndUpdate implements Executable, Explainable
 {
     public const RETURN_DOCUMENT_BEFORE = 1;
     public const RETURN_DOCUMENT_AFTER = 2;

src/Operation/FindOneAndUpdate.php

@@ -38,7 +38,7 @@
  * @see \MongoDB\Collection::insertMany()
  * @see https://mongodb.com/docs/manual/reference/command/insert/
  */
-class InsertMany implements Executable
+final class InsertMany implements Executable
 {
     /** @var list<object|array> */
     private array $documents;

src/Operation/InsertMany.php

@@ -36,7 +36,7 @@
  * @see \MongoDB\Collection::insertOne()
  * @see https://mongodb.com/docs/manual/reference/command/insert/
  */
-class InsertOne implements Executable
+final class InsertOne implements Executable
 {
     private array|object $document;