Add final annotations to non-internal Operation classes (#1410)

GromNaN · web-flow · commit 89fb97ad2309 · 2024-09-17T12:47:56.000+02:00
diff --git a/src/Operation/Aggregate.php b/src/Operation/Aggregate.php
@@ -48,6 +48,8 @@
  *
  * @see \MongoDB\Collection::aggregate()
  * @see https://mongodb.com/docs/manual/reference/command/aggregate/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Aggregate implements Executable, Explainable
 {
diff --git a/src/Operation/BulkWrite.php b/src/Operation/BulkWrite.php
@@ -45,6 +45,8 @@
  * Operation for executing multiple write operations.
  *
  * @see \MongoDB\Collection::bulkWrite()
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class BulkWrite implements Executable
 {
diff --git a/src/Operation/Count.php b/src/Operation/Count.php
@@ -40,6 +40,8 @@
  *
  * @see \MongoDB\Collection::count()
  * @see https://mongodb.com/docs/manual/reference/command/count/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Count implements Executable, Explainable
 {
diff --git a/src/Operation/CountDocuments.php b/src/Operation/CountDocuments.php
@@ -36,6 +36,8 @@
  *
  * @see \MongoDB\Collection::countDocuments()
  * @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#countdocuments
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class CountDocuments implements Executable
 {
diff --git a/src/Operation/CreateCollection.php b/src/Operation/CreateCollection.php
@@ -40,6 +40,8 @@
  *
  * @see \MongoDB\Database::createCollection()
  * @see https://mongodb.com/docs/manual/reference/command/create/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class CreateCollection implements Executable
 {
diff --git a/src/Operation/CreateIndexes.php b/src/Operation/CreateIndexes.php
@@ -40,6 +40,8 @@
  * @see \MongoDB\Collection::createIndex()
  * @see \MongoDB\Collection::createIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/createIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class CreateIndexes implements Executable
 {
diff --git a/src/Operation/CreateSearchIndexes.php b/src/Operation/CreateSearchIndexes.php
@@ -36,6 +36,8 @@
  * @see \MongoDB\Collection::createSearchIndex()
  * @see \MongoDB\Collection::createSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/createSearchIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class CreateSearchIndexes implements Executable
 {
diff --git a/src/Operation/DatabaseCommand.php b/src/Operation/DatabaseCommand.php
@@ -31,6 +31,8 @@
  * Operation for executing a database command.
  *
  * @see \MongoDB\Database::command()
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DatabaseCommand implements Executable
 {
diff --git a/src/Operation/DeleteMany.php b/src/Operation/DeleteMany.php
@@ -28,6 +28,8 @@
  *
  * @see \MongoDB\Collection::deleteOne()
  * @see https://mongodb.com/docs/manual/reference/command/delete/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DeleteMany implements Executable, Explainable
 {
diff --git a/src/Operation/DeleteOne.php b/src/Operation/DeleteOne.php
@@ -28,6 +28,8 @@
  *
  * @see \MongoDB\Collection::deleteOne()
  * @see https://mongodb.com/docs/manual/reference/command/delete/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DeleteOne implements Executable, Explainable
 {
diff --git a/src/Operation/Distinct.php b/src/Operation/Distinct.php
@@ -39,6 +39,8 @@
  *
  * @see \MongoDB\Collection::distinct()
  * @see https://mongodb.com/docs/manual/reference/command/distinct/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Distinct implements Executable, Explainable
 {
diff --git a/src/Operation/DropCollection.php b/src/Operation/DropCollection.php
@@ -35,6 +35,8 @@
  * @see \MongoDB\Collection::drop()
  * @see \MongoDB\Database::dropCollection()
  * @see https://mongodb.com/docs/manual/reference/command/drop/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DropCollection implements Executable
 {
diff --git a/src/Operation/DropDatabase.php b/src/Operation/DropDatabase.php
@@ -33,6 +33,8 @@
  * @see \MongoDB\Client::dropDatabase()
  * @see \MongoDB\Database::drop()
  * @see https://mongodb.com/docs/manual/reference/command/dropDatabase/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DropDatabase implements Executable
 {
diff --git a/src/Operation/DropIndexes.php b/src/Operation/DropIndexes.php
@@ -34,6 +34,8 @@
  *
  * @see \MongoDB\Collection::dropIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/dropIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DropIndexes implements Executable
 {
diff --git a/src/Operation/DropSearchIndex.php b/src/Operation/DropSearchIndex.php
@@ -29,6 +29,8 @@
  *
  * @see \MongoDB\Collection::dropSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/dropSearchIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class DropSearchIndex implements Executable
 {
diff --git a/src/Operation/EstimatedDocumentCount.php b/src/Operation/EstimatedDocumentCount.php
@@ -34,6 +34,8 @@
  *
  * @see \MongoDB\Collection::estimatedDocumentCount()
  * @see https://mongodb.com/docs/manual/reference/command/count/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class EstimatedDocumentCount implements Executable, Explainable
 {
diff --git a/src/Operation/Explain.php b/src/Operation/Explain.php
@@ -34,6 +34,8 @@
  *
  * @see \MongoDB\Collection::explain()
  * @see https://mongodb.com/docs/manual/reference/command/explain/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Explain implements Executable
 {
diff --git a/src/Operation/Find.php b/src/Operation/Find.php
@@ -47,6 +47,8 @@
  * @see \MongoDB\Collection::find()
  * @see https://mongodb.com/docs/manual/tutorial/query-documents/
  * @see https://mongodb.com/docs/manual/reference/operator/query-modifier/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Find implements Executable, Explainable
 {
diff --git a/src/Operation/FindOne.php b/src/Operation/FindOne.php
@@ -30,6 +30,8 @@
  * @see \MongoDB\Collection::findOne()
  * @see https://mongodb.com/docs/manual/tutorial/query-documents/
  * @see https://mongodb.com/docs/manual/reference/operator/query-modifier/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class FindOne implements Executable, Explainable
 {
diff --git a/src/Operation/FindOneAndDelete.php b/src/Operation/FindOneAndDelete.php
@@ -29,6 +29,8 @@
  *
  * @see \MongoDB\Collection::findOneAndDelete()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class FindOneAndDelete implements Executable, Explainable
 {
diff --git a/src/Operation/FindOneAndReplace.php b/src/Operation/FindOneAndReplace.php
@@ -34,6 +34,8 @@
  *
  * @see \MongoDB\Collection::findOneAndReplace()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class FindOneAndReplace implements Executable, Explainable
 {
diff --git a/src/Operation/FindOneAndUpdate.php b/src/Operation/FindOneAndUpdate.php
@@ -33,6 +33,8 @@
  *
  * @see \MongoDB\Collection::findOneAndUpdate()
  * @see https://mongodb.com/docs/manual/reference/command/findAndModify/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class FindOneAndUpdate implements Executable, Explainable
 {
diff --git a/src/Operation/InsertMany.php b/src/Operation/InsertMany.php
@@ -37,6 +37,8 @@
  *
  * @see \MongoDB\Collection::insertMany()
  * @see https://mongodb.com/docs/manual/reference/command/insert/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class InsertMany implements Executable
 {
diff --git a/src/Operation/InsertOne.php b/src/Operation/InsertOne.php
@@ -35,6 +35,8 @@
  *
  * @see \MongoDB\Collection::insertOne()
  * @see https://mongodb.com/docs/manual/reference/command/insert/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class InsertOne implements Executable
 {
diff --git a/src/Operation/ListCollectionNames.php b/src/Operation/ListCollectionNames.php
@@ -29,6 +29,8 @@
  *
  * @see \MongoDB\Database::listCollectionNames()
  * @see https://mongodb.com/docs/manual/reference/command/listCollections/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListCollectionNames implements Executable
 {
diff --git a/src/Operation/ListCollections.php b/src/Operation/ListCollections.php
@@ -29,6 +29,8 @@
  *
  * @see \MongoDB\Database::listCollections()
  * @see https://mongodb.com/docs/manual/reference/command/listCollections/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListCollections implements Executable
 {
diff --git a/src/Operation/ListDatabaseNames.php b/src/Operation/ListDatabaseNames.php
@@ -32,6 +32,8 @@
  *
  * @see \MongoDB\Client::listDatabaseNames()
  * @see https://mongodb.com/docs/manual/reference/command/listDatabases/#mongodb-dbcommand-dbcmd.listDatabases
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListDatabaseNames implements Executable
 {
diff --git a/src/Operation/ListDatabases.php b/src/Operation/ListDatabases.php
@@ -29,7 +29,9 @@
  * Operation for the ListDatabases command.
  *
  * @see \MongoDB\Client::listDatabases()
- * @see https://mongodb.com/docs/manual/reference/command/listDatabases/#mongodb-dbcommand-dbcmd.listDatabases`
+ * @see https://mongodb.com/docs/manual/reference/command/listDatabases/#mongodb-dbcommand-dbcmd.listDatabases
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListDatabases implements Executable
 {
diff --git a/src/Operation/ListIndexes.php b/src/Operation/ListIndexes.php
@@ -35,6 +35,8 @@
  *
  * @see \MongoDB\Collection::listIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/listIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListIndexes implements Executable
 {
diff --git a/src/Operation/ListSearchIndexes.php b/src/Operation/ListSearchIndexes.php
@@ -34,6 +34,8 @@
  *
  * @see \MongoDB\Collection::listSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/listSearchIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ListSearchIndexes implements Executable
 {
diff --git a/src/Operation/MapReduce.php b/src/Operation/MapReduce.php
@@ -53,6 +53,8 @@
  * @see \MongoDB\Collection::mapReduce()
  * @see https://mongodb.com/docs/manual/reference/command/mapReduce/
  * @psalm-import-type MapReduceCallable from MapReduceResult
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class MapReduce implements Executable
 {
diff --git a/src/Operation/ModifyCollection.php b/src/Operation/ModifyCollection.php
@@ -32,6 +32,8 @@
  *
  * @see \MongoDB\Database::modifyCollection()
  * @see https://mongodb.com/docs/manual/reference/command/collMod/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ModifyCollection implements Executable
 {
diff --git a/src/Operation/RenameCollection.php b/src/Operation/RenameCollection.php
@@ -35,6 +35,8 @@
  * @see \MongoDB\Collection::rename()
  * @see \MongoDB\Database::renameCollection()
  * @see https://mongodb.com/docs/manual/reference/command/renameCollection/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class RenameCollection implements Executable
 {
diff --git a/src/Operation/ReplaceOne.php b/src/Operation/ReplaceOne.php
@@ -33,6 +33,8 @@
  *
  * @see \MongoDB\Collection::replaceOne()
  * @see https://mongodb.com/docs/manual/reference/command/update/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class ReplaceOne implements Executable
 {
diff --git a/src/Operation/UpdateMany.php b/src/Operation/UpdateMany.php
@@ -31,6 +31,8 @@
  *
  * @see \MongoDB\Collection::updateMany()
  * @see https://mongodb.com/docs/manual/reference/command/update/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class UpdateMany implements Executable, Explainable
 {
diff --git a/src/Operation/UpdateOne.php b/src/Operation/UpdateOne.php
@@ -31,6 +31,8 @@
  *
  * @see \MongoDB\Collection::updateOne()
  * @see https://mongodb.com/docs/manual/reference/command/update/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class UpdateOne implements Executable, Explainable
 {
diff --git a/src/Operation/UpdateSearchIndex.php b/src/Operation/UpdateSearchIndex.php
@@ -30,6 +30,8 @@
  *
  * @see \MongoDB\Collection::updateSearchIndexes()
  * @see https://mongodb.com/docs/manual/reference/command/updateSearchIndexes/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class UpdateSearchIndex implements Executable
 {
diff --git a/src/Operation/Watch.php b/src/Operation/Watch.php
@@ -56,6 +56,8 @@
  *
  * @see \MongoDB\Collection::watch()
  * @see https://mongodb.com/docs/manual/changeStreams/
+ *
+ * @final extending this class will not be supported in v2.0.0
  */
 class Watch implements Executable, /* @internal */ CommandSubscriber
 {

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,8 @@`
`48`	`48`	`*`
`49`	`49`	`* @see \MongoDB\Collection::aggregate()`
`50`	`50`	`* @see https://mongodb.com/docs/manual/reference/command/aggregate/`
	`51`	`+ *`
	`52`	`+ * @final extending this class will not be supported in v2.0.0`
`51`	`53`	`*/`
`52`	`54`	`class Aggregate implements Executable, Explainable`
`53`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@`
`45`	`45`	`* Operation for executing multiple write operations.`
`46`	`46`	`*`
`47`	`47`	`* @see \MongoDB\Collection::bulkWrite()`
	`48`	`+ *`
	`49`	`+ * @final extending this class will not be supported in v2.0.0`
`48`	`50`	`*/`
`49`	`51`	`class BulkWrite implements Executable`
`50`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@`
`40`	`40`	`*`
`41`	`41`	`* @see \MongoDB\Collection::count()`
`42`	`42`	`* @see https://mongodb.com/docs/manual/reference/command/count/`
	`43`	`+ *`
	`44`	`+ * @final extending this class will not be supported in v2.0.0`
`43`	`45`	`*/`
`44`	`46`	`class Count implements Executable, Explainable`
`45`	`47`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@`
`36`	`36`	`*`
`37`	`37`	`* @see \MongoDB\Collection::countDocuments()`
`38`	`38`	`* @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#countdocuments`
	`39`	`+ *`
	`40`	`+ * @final extending this class will not be supported in v2.0.0`
`39`	`41`	`*/`
`40`	`42`	`class CountDocuments implements Executable`
`41`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@`
`31`	`31`	`* Operation for executing a database command.`
`32`	`32`	`*`
`33`	`33`	`* @see \MongoDB\Database::command()`
	`34`	`+ *`
	`35`	`+ * @final extending this class will not be supported in v2.0.0`
`34`	`36`	`*/`
`35`	`37`	`class DatabaseCommand implements Executable`
`36`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@`
`28`	`28`	`*`
`29`	`29`	`* @see \MongoDB\Collection::deleteOne()`
`30`	`30`	`* @see https://mongodb.com/docs/manual/reference/command/delete/`
	`31`	`+ *`
	`32`	`+ * @final extending this class will not be supported in v2.0.0`
`31`	`33`	`*/`
`32`	`34`	`class DeleteMany implements Executable, Explainable`
`33`	`35`	`{`