[http foundation] mark bag's getters as mutation free (#268)

psalm · Jul 17, 2022 · 85b4f17 · 85b4f17
1 parent 28983de
commit 85b4f17
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 0 deletions.
diff --git a/src/Stubs/4/Component/HttpFoundation/ParameterBag.stubphp b/src/Stubs/4/Component/HttpFoundation/ParameterBag.stubphp
@@ -12,13 +12,17 @@ class ParameterBag implements \IteratorAggregate, \Countable
      *
      * @return mixed
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get(string $key, $default = null) {}
 
     /**
      * Returns the parameters.
      *
      * @return array An array of parameters
+
+     * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function all() {}
 }
diff --git a/src/Stubs/5/Component/HttpFoundation/InputBag.stubphp b/src/Stubs/5/Component/HttpFoundation/InputBag.stubphp
@@ -14,6 +14,7 @@ final class InputBag extends ParameterBag
      * @psalm-param D $default
      * @psalm-return D|T
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get(string $key, $default = null) {}
 
@@ -25,6 +26,7 @@ final class InputBag extends ParameterBag
      * @return array An array of parameters
      *
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function all(string $key = null) {}
 }
diff --git a/src/Stubs/5/Component/HttpFoundation/ParameterBag.stubphp b/src/Stubs/5/Component/HttpFoundation/ParameterBag.stubphp
@@ -12,6 +12,7 @@ class ParameterBag implements \IteratorAggregate, \Countable
      *
      * @return mixed
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get(string $key, $default = null) {}
 
@@ -23,6 +24,7 @@ class ParameterBag implements \IteratorAggregate, \Countable
      * @return array An array of parameters
      *
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function all(string $key = null) {}
 }
diff --git a/src/Stubs/6/Component/HttpFoundation/InputBag.stubphp b/src/Stubs/6/Component/HttpFoundation/InputBag.stubphp
@@ -14,6 +14,7 @@ final class InputBag extends ParameterBag
      * @psalm-param D $default
      * @psalm-return D|T
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get(string $key, $default = null) {}
 
@@ -25,6 +26,7 @@ final class InputBag extends ParameterBag
      * @return array An array of parameters
      *
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function all(string $key = null) {}
 }
diff --git a/src/Stubs/6/Component/HttpFoundation/ParameterBag.stubphp b/src/Stubs/6/Component/HttpFoundation/ParameterBag.stubphp
@@ -12,6 +12,7 @@ class ParameterBag implements \IteratorAggregate, \Countable
      *
      * @return mixed
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get(string $key, $default = null) {}
 
@@ -23,6 +24,7 @@ class ParameterBag implements \IteratorAggregate, \Countable
      * @return array An array of parameters
      *
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function all(string $key = null) {}
 }
diff --git a/src/Stubs/common/Component/HttpFoundation/Request.stubphp b/src/Stubs/common/Component/HttpFoundation/Request.stubphp
@@ -26,6 +26,7 @@ class Request
      * @param mixed  $default The default value if the parameter key does not exist
      *
      * @psalm-taint-source input
+     * @psalm-mutation-free
      */
     public function get($key, $default = null) {}
 }