Deprecate ArrayStatement and ResultCacheStatement

doctrine · Jun 6, 2020 · dd55d05 · dd55d05
1 parent af83b31
commit dd55d05
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,9 @@
 # Upgrade to 2.11
 
+## Deprecated `ArrayStatement` and `ResultCacheStatement` classes.
+
+The `ArrayStatement` and `ResultCacheStatement` classes are deprecated. In a future major release they will be renamed and marked internal as implementation details of the caching layer.
+
 ## Deprecated `ResultStatement` interface
 
 1. The `ResultStatement` interface is deprecated. Use the `Driver\Result` and `Abstraction\Result` interfaces instead.

diff --git a/lib/Doctrine/DBAL/Cache/ArrayStatement.php b/lib/Doctrine/DBAL/Cache/ArrayStatement.php
@@ -15,6 +15,9 @@
 use function count;
 use function reset;
 
+/**
+ * @deprecated
+ */
 class ArrayStatement implements IteratorAggregate, ResultStatement, Result
 {
     /** @var mixed[] */

diff --git a/lib/Doctrine/DBAL/Cache/ResultCacheStatement.php b/lib/Doctrine/DBAL/Cache/ResultCacheStatement.php
@@ -31,6 +31,8 @@
  *
  * Also you have to realize that the cache will load the whole result into memory at once to ensure 2.
  * This means that the memory usage for cached results might increase by using this feature.
+ *
+ * @deprecated
  */
 class ResultCacheStatement implements IteratorAggregate, ResultStatement, Result
 {