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

Author: GromNaN

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {

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
 {