Deprecate ArrayStatement and ResultCacheStatement

morozov · morozov · commit e7c7cb178835 · 2020-06-07T09:27:38.000-07:00
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
@@ -16,6 +16,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
@@ -32,6 +32,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
 {

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@`
`16`	`16`	`use function count;`
`17`	`17`	`use function reset;`
`18`	`18`
	`19`	`+/**`
	`20`	`+ * @deprecated`
	`21`	`+ */`
`19`	`22`	`class ArrayStatement implements IteratorAggregate, ResultStatement, Result`
`20`	`23`	`{`
`21`	`24`	`/** @var mixed[] */`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@`
`32`	`32`	`*`
`33`	`33`	`* Also you have to realize that the cache will load the whole result into memory at once to ensure 2.`
`34`	`34`	`* This means that the memory usage for cached results might increase by using this feature.`
	`35`	`+ *`
	`36`	`+ * @deprecated`
`35`	`37`	`*/`
`36`	`38`	`class ResultCacheStatement implements IteratorAggregate, ResultStatement, Result`
`37`	`39`	`{`