Deprecate DocumentRepository::clear (doctrine#2584)

lstrojny · Nov 24, 2023 · 99aa043 · 99aa043
1 parent b098ab9
commit 99aa043
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php b/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php
@@ -23,6 +23,7 @@
 use function assert;
 use function count;
 use function is_array;
+use function trigger_deprecation;
 
 /**
  * A DocumentRepository serves as a repository for documents with generic as well as
@@ -89,9 +90,18 @@ public function createAggregationBuilder(): AggregationBuilder
 
     /**
      * Clears the repository, causing all managed documents to become detached.
+     *
+     * @deprecated Deprecated in 2.6, will be removed in 3.0
      */
     public function clear(): void
     {
+        trigger_deprecation(
+            'doctrine/mongodb-odm',
+            '2.6',
+            'The %s() method is deprecated and will be removed in Doctrine ODM 3.0.',
+            __METHOD__,
+        );
+
         $this->dm->clear($this->class->rootDocumentName);
     }