Filter Chain Deprecations

See laminas#208 Signed-off-by: George Steel <[email protected]>
gsteel · Dec 17, 2024 · 116f9f5 · 116f9f5
1 parent 51e83ce
commit 116f9f5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1124,6 +1124,18 @@
     <DeprecatedClass>
       <code><![CDATA[AbstractFilter]]></code>
     </DeprecatedClass>
+    <DeprecatedConstant>
+      <code><![CDATA[self::DEFAULT_PRIORITY]]></code>
+      <code><![CDATA[self::DEFAULT_PRIORITY]]></code>
+      <code><![CDATA[static::DEFAULT_PRIORITY]]></code>
+      <code><![CDATA[static::DEFAULT_PRIORITY]]></code>
+    </DeprecatedConstant>
+    <DeprecatedMethod>
+      <code><![CDATA[getPluginManager]]></code>
+      <code><![CDATA[getPluginManager]]></code>
+      <code><![CDATA[setOptions]]></code>
+      <code><![CDATA[setPluginManager]]></code>
+    </DeprecatedMethod>
     <MixedPropertyTypeCoercion>
       <code><![CDATA[new PriorityQueue()]]></code>
     </MixedPropertyTypeCoercion>
@@ -2067,6 +2079,11 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="test/FilterChainTest.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getFilters]]></code>
+      <code><![CDATA[getFilters]]></code>
+      <code><![CDATA[setOptions]]></code>
+    </DeprecatedMethod>
     <PossiblyUnusedMethod>
       <code><![CDATA[staticUcaseFilter]]></code>
     </PossiblyUnusedMethod>

diff --git a/src/FilterChain.php b/src/FilterChain.php
@@ -40,6 +40,8 @@ class FilterChain extends AbstractFilter implements Countable, IteratorAggregate
 {
     /**
      * Default priority at which filters are added
+     *
+     * @deprecated This constant will be moved to `FilterChainInterface` in version 3.0
      */
     public const DEFAULT_PRIORITY = 1000;
 
@@ -68,6 +70,8 @@ public function __construct($options = null)
     }
 
     /**
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * @param  FilterChainConfiguration|Traversable $options
      * @return $this
      * @throws Exception\InvalidArgumentException
@@ -125,6 +129,8 @@ public function count()
     /**
      * Get plugin manager instance
      *
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * @return FilterPluginManager
      */
     public function getPluginManager()
@@ -141,6 +147,8 @@ public function getPluginManager()
     /**
      * Set plugin manager instance
      *
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * @return self
      */
     public function setPluginManager(FilterPluginManager $plugins)
@@ -152,6 +160,8 @@ public function setPluginManager(FilterPluginManager $plugins)
     /**
      * Retrieve a filter plugin by name
      *
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * @param string $name
      * @return FilterInterface|callable(mixed): mixed
      */
@@ -222,6 +232,8 @@ public function merge(FilterChain $filterChain)
     /**
      * Get all the filters
      *
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * @return PriorityQueue<FilterInterface|callable(mixed): mixed, int>
      */
     public function getFilters()
@@ -265,6 +277,8 @@ public function __clone()
     /**
      * Prepare filter chain for serialization
      *
+     * @deprecated This method will be removed in 3.0.0 without replacement
+     *
      * Plugin manager (property 'plugins') cannot
      * be serialized. On wakeup the property remains unset
      * and next invocation to getPluginManager() sets