Deprecate getters and setters in Callback filter

Signed-off-by: George Steel <[email protected]>
laminas · Jun 29, 2024 · a1f539c · a1f539c
1 parent 7465175
commit a1f539c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -118,6 +118,10 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Callback.php">
+    <DeprecatedMethod>
+      <code><![CDATA[setCallback]]></code>
+      <code><![CDATA[setCallbackParams]]></code>
+    </DeprecatedMethod>
     <MixedFunctionCall>
       <code><![CDATA[call_user_func_array($this->options['callback'], $params)]]></code>
     </MixedFunctionCall>
@@ -1528,6 +1532,11 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="test/CallbackTest.php">
+    <DeprecatedMethod>
+      <code><![CDATA[getCallbackParams]]></code>
+      <code><![CDATA[getCallbackParams]]></code>
+      <code><![CDATA[setCallbackParams]]></code>
+    </DeprecatedMethod>
     <InvalidArgument>
       <code><![CDATA['param']]></code>
       <code><![CDATA['param']]></code>

diff --git a/src/Callback.php b/src/Callback.php
@@ -46,9 +46,11 @@ public function __construct($callbackOrOptions = [], $callbackParams = [])
     /**
      * Sets a new callback for this filter
      *
+     * @deprecated since 2.37.0 - All option setters and getters will be removed in 3.0
+     *
      * @param  callable $callback
-     * @throws Exception\InvalidArgumentException
      * @return self
+     * @throws Exception\InvalidArgumentException
      */
     public function setCallback($callback)
     {
@@ -69,6 +71,8 @@ public function setCallback($callback)
     /**
      * Returns the set callback
      *
+     * @deprecated since 2.37.0 - All option setters and getters will be removed in 3.0
+     *
      * @return callable
      */
     public function getCallback()
@@ -79,6 +83,8 @@ public function getCallback()
     /**
      * Sets parameters for the callback
      *
+     * @deprecated since 2.37.0 - All option setters and getters will be removed in 3.0
+     *
      * @param  array $params
      * @return self
      */
@@ -91,6 +97,8 @@ public function setCallbackParams($params)
     /**
      * Get parameters for the callback
      *
+     * @deprecated since 2.37.0 - All option setters and getters will be removed in 3.0
+     *
      * @return array
      */
     public function getCallbackParams()