Use default for Psalm ensureOverrideAttribute (#923)

zachborboa · web-flow · commit 056de7d13df6 · 2025-02-18T21:49:22.000-05:00
* Use default for Psalm ensureOverrideAttribute * Fix missing Override attributes Error: ../src/Curl/CaseInsensitiveArray.php:66:5: MissingOverrideAttribute: Method Curl\CaseInsensitiveArray::offsetset should have the "Override" attribute (see https://psalm.dev/358)
diff --git a/src/Curl/CaseInsensitiveArray.php b/src/Curl/CaseInsensitiveArray.php
@@ -63,6 +63,7 @@ public function __construct(?array $initial = null)
      * @return void
      * @see https://secure.php.net/manual/en/arrayaccess.offsetset.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
@@ -85,6 +86,7 @@ public function offsetSet($offset, $value)
      * @return bool   If the offset exists.
      * @see https://secure.php.net/manual/en/arrayaccess.offsetexists.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
@@ -101,6 +103,7 @@ public function offsetExists($offset)
      * @return void
      * @see https://secure.php.net/manual/en/arrayaccess.offsetunset.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
@@ -119,6 +122,7 @@ public function offsetUnset($offset)
      * @return mixed  The data stored at the offset.
      * @see https://secure.php.net/manual/en/arrayaccess.offsetget.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
@@ -132,6 +136,7 @@ public function offsetGet($offset)
      * @return int The number of elements stored in the array.
      * @see https://secure.php.net/manual/en/countable.count.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function count()
     {
@@ -144,6 +149,7 @@ public function count()
      * @return mixed Data at the current position.
      * @see https://secure.php.net/manual/en/iterator.current.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function current()
     {
@@ -156,6 +162,7 @@ public function current()
      * @return void
      * @see https://secure.php.net/manual/en/iterator.next.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function next()
     {
@@ -168,6 +175,7 @@ public function next()
      * @return mixed Case-sensitive key at current position.
      * @see https://secure.php.net/manual/en/iterator.key.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function key()
     {
@@ -181,6 +189,7 @@ public function key()
      * @return bool If the current position is valid.
      * @see https://secure.php.net/manual/en/iterator.valid.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function valid()
     {
@@ -193,6 +202,7 @@ public function valid()
      * @return void
      * @see https://secure.php.net/manual/en/iterator.rewind.php
      */
+    #[\Override]
     #[\ReturnTypeWillChange]
     public function rewind()
     {
diff --git a/src/Curl/Curl.php b/src/Curl/Curl.php
@@ -236,6 +236,7 @@ public function call()
     /**
      * Close
      */
+    #[\Override]
     public function close()
     {
         if (is_resource($this->curl) || $this->curl instanceof \CurlHandle) {
@@ -807,6 +808,7 @@ public function search($url, $data = [])
      * @param $key
      * @param $value
      */
+    #[\Override]
     public function setCookie($key, $value)
     {
         $this->setEncodedCookie($key, $value);
@@ -818,6 +820,7 @@ public function setCookie($key, $value)
      *
      * @param $cookies
      */
+    #[\Override]
     public function setCookies($cookies)
     {
         foreach ($cookies as $key => $value) {
@@ -868,6 +871,7 @@ public function setMaxFilesize($bytes)
      * @param       $string
      * @return bool
      */
+    #[\Override]
     public function setCookieString($string)
     {
         return $this->setOpt(CURLOPT_COOKIE, $string);
@@ -879,6 +883,7 @@ public function setCookieString($string)
      * @param       $cookie_file
      * @return bool
      */
+    #[\Override]
     public function setCookieFile($cookie_file)
     {
         return $this->setOpt(CURLOPT_COOKIEFILE, $cookie_file);
@@ -890,6 +895,7 @@ public function setCookieFile($cookie_file)
      * @param       $cookie_jar
      * @return bool
      */
+    #[\Override]
     public function setCookieJar($cookie_jar)
     {
         return $this->setOpt(CURLOPT_COOKIEJAR, $cookie_jar);
@@ -996,6 +1002,7 @@ private function getDefaultUserAgent()
      * @param $key
      * @param $value
      */
+    #[\Override]
     public function setHeader($key, $value)
     {
         $this->headers[$key] = $value;
@@ -1013,6 +1020,7 @@ public function setHeader($key, $value)
      *
      * @param $headers
      */
+    #[\Override]
     public function setHeaders($headers)
     {
         if (ArrayUtil::isArrayAssoc($headers)) {
@@ -1043,6 +1051,7 @@ public function setHeaders($headers)
      *
      * @param $mixed boolean|callable
      */
+    #[\Override]
     public function setJsonDecoder($mixed)
     {
         if ($mixed === false || is_callable($mixed)) {
@@ -1056,6 +1065,7 @@ public function setJsonDecoder($mixed)
      *
      * @param $mixed boolean|callable
      */
+    #[\Override]
     public function setXmlDecoder($mixed)
     {
         if ($mixed === false || is_callable($mixed)) {
@@ -1071,6 +1081,7 @@ public function setXmlDecoder($mixed)
      * @param       $value
      * @return bool
      */
+    #[\Override]
     public function setOpt($option, $value)
     {
         $required_options = [
@@ -1096,6 +1107,7 @@ public function setOpt($option, $value)
      * @param       $value
      * @return bool
      */
+    #[\Override]
     protected function setOptInternal($option, $value)
     {
         $success = curl_setopt($this->curl, $option, $value);
@@ -1115,6 +1127,7 @@ protected function setOptInternal($option, $value)
      *              returned, ignoring any future options in the options array.
      *              Similar to curl_setopt_array().
      */
+    #[\Override]
     public function setOpts($options)
     {
         if (!count($options)) {
@@ -1159,6 +1172,7 @@ private function setProtocolsInternal($protocols)
      *
      * @param $mixed
      */
+    #[\Override]
     public function setRetry($mixed)
     {
         if (is_callable($mixed)) {
@@ -1193,6 +1207,7 @@ private function setRedirectProtocolsInternal($redirect_protocols)
      * @param $url
      * @param $mixed_data
      */
+    #[\Override]
     public function setUrl($url, $mixed_data = '')
     {
         $built_url = Url::buildUrl($url, $mixed_data);
@@ -1235,6 +1250,7 @@ public function attemptRetry()
      *
      * @param $key
      */
+    #[\Override]
     public function unsetHeader($key)
     {
         unset($this->headers[$key]);
@@ -2132,6 +2148,7 @@ private function setStopInternal($callback = null)
      *
      * Used by MultiCurl::stop() when making multiple parallel requests.
      */
+    #[\Override]
     public function stop()
     {
         $this->headerCallbackData->stopRequest = true;
diff --git a/src/Curl/MultiCurl.php b/src/Curl/MultiCurl.php
@@ -348,6 +348,7 @@ public function addCurl(Curl $curl)
     /**
      * Close
      */
+    #[\Override]
     public function close()
     {
         foreach ($this->queuedCurls as $curl) {
@@ -376,6 +377,7 @@ public function setConcurrency($concurrency)
      * @param $key
      * @param $value
      */
+    #[\Override]
     public function setCookie($key, $value)
     {
         $this->cookies[$key] = $value;
@@ -386,6 +388,7 @@ public function setCookie($key, $value)
      *
      * @param $cookies
      */
+    #[\Override]
     public function setCookies($cookies)
     {
         foreach ($cookies as $key => $value) {
@@ -398,6 +401,7 @@ public function setCookies($cookies)
      *
      * @param $string
      */
+    #[\Override]
     public function setCookieString($string)
     {
         $this->setOpt(CURLOPT_COOKIE, $string);
@@ -408,6 +412,7 @@ public function setCookieString($string)
      *
      * @param $cookie_file
      */
+    #[\Override]
     public function setCookieFile($cookie_file)
     {
         $this->setOpt(CURLOPT_COOKIEFILE, $cookie_file);
@@ -418,6 +423,7 @@ public function setCookieFile($cookie_file)
      *
      * @param $cookie_jar
      */
+    #[\Override]
     public function setCookieJar($cookie_jar)
     {
         $this->setOpt(CURLOPT_COOKIEJAR, $cookie_jar);
@@ -431,6 +437,7 @@ public function setCookieJar($cookie_jar)
      * @param $key
      * @param $value
      */
+    #[\Override]
     public function setHeader($key, $value)
     {
         $this->headers[$key] = $value;
@@ -444,6 +451,7 @@ public function setHeader($key, $value)
      *
      * @param $headers
      */
+    #[\Override]
     public function setHeaders($headers)
     {
         if (ArrayUtil::isArrayAssoc($headers)) {
@@ -469,6 +477,7 @@ public function setHeaders($headers)
      *
      * @param $mixed boolean|callable
      */
+    #[\Override]
     public function setJsonDecoder($mixed)
     {
         if ($mixed === false) {
@@ -483,6 +492,7 @@ public function setJsonDecoder($mixed)
      *
      * @param $mixed boolean|callable
      */
+    #[\Override]
     public function setXmlDecoder($mixed)
     {
         if ($mixed === false) {
@@ -512,6 +522,7 @@ public function setProxies($proxies)
      * @param $option
      * @param $value
      */
+    #[\Override]
     public function setOpt($option, $value)
     {
         $this->options[$option] = $value;
@@ -536,6 +547,7 @@ public function setOpt($option, $value)
      *
      * @param $options
      */
+    #[\Override]
     public function setOpts($options)
     {
         foreach ($options as $option => $value) {
@@ -608,6 +620,7 @@ public function setRateLimit($rate_limit)
      *
      * @param $mixed
      */
+    #[\Override]
     public function setRetry($mixed)
     {
         $this->retry = $mixed;
@@ -619,6 +632,7 @@ public function setRetry($mixed)
      * @param $url
      * @param $mixed_data
      */
+    #[\Override]
     public function setUrl($url, $mixed_data = '')
     {
         $built_url = Url::buildUrl($url, $mixed_data);
@@ -748,6 +762,7 @@ public function start()
     /**
      * Stop
      */
+    #[\Override]
     public function stop()
     {
         // Remove any queued curl requests.
@@ -775,6 +790,7 @@ public function stop()
      *
      * @param $key
      */
+    #[\Override]
     public function unsetHeader($key)
     {
         unset($this->headers[$key]);
diff --git a/tests/psalm.xml b/tests/psalm.xml
@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <!-- TODO: Use errorLevel="1" -->
 <psalm
-    ensureOverrideAttribute="false"
     errorLevel="4"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

Original file line number	Diff line number	Diff line change
`@@ -236,6 +236,7 @@ public function call()`
`236`	`236`	`/**`
`237`	`237`	`* Close`
`238`	`238`	`*/`
	`239`	`+ #[\Override]`
`239`	`240`	`public function close()`
`240`	`241`	`{`
`241`	`242`	`if (is_resource($this->curl) \|\| $this->curl instanceof \CurlHandle) {`
`@@ -807,6 +808,7 @@ public function search($url, $data = [])`
`807`	`808`	`* @param $key`
`808`	`809`	`* @param $value`
`809`	`810`	`*/`
	`811`	`+ #[\Override]`
`810`	`812`	`public function setCookie($key, $value)`
`811`	`813`	`{`
`812`	`814`	`$this->setEncodedCookie($key, $value);`
`@@ -818,6 +820,7 @@ public function setCookie($key, $value)`
`818`	`820`	`*`
`819`	`821`	`* @param $cookies`
`820`	`822`	`*/`
	`823`	`+ #[\Override]`
`821`	`824`	`public function setCookies($cookies)`
`822`	`825`	`{`
`823`	`826`	`foreach ($cookies as $key => $value) {`
`@@ -868,6 +871,7 @@ public function setMaxFilesize($bytes)`
`868`	`871`	`* @param $string`
`869`	`872`	`* @return bool`
`870`	`873`	`*/`
	`874`	`+ #[\Override]`
`871`	`875`	`public function setCookieString($string)`
`872`	`876`	`{`
`873`	`877`	`return $this->setOpt(CURLOPT_COOKIE, $string);`
`@@ -879,6 +883,7 @@ public function setCookieString($string)`
`879`	`883`	`* @param $cookie_file`
`880`	`884`	`* @return bool`
`881`	`885`	`*/`
	`886`	`+ #[\Override]`
`882`	`887`	`public function setCookieFile($cookie_file)`
`883`	`888`	`{`
`884`	`889`	`return $this->setOpt(CURLOPT_COOKIEFILE, $cookie_file);`
`@@ -890,6 +895,7 @@ public function setCookieFile($cookie_file)`
`890`	`895`	`* @param $cookie_jar`
`891`	`896`	`* @return bool`
`892`	`897`	`*/`
	`898`	`+ #[\Override]`
`893`	`899`	`public function setCookieJar($cookie_jar)`
`894`	`900`	`{`
`895`	`901`	`return $this->setOpt(CURLOPT_COOKIEJAR, $cookie_jar);`
`@@ -996,6 +1002,7 @@ private function getDefaultUserAgent()`
`996`	`1002`	`* @param $key`
`997`	`1003`	`* @param $value`
`998`	`1004`	`*/`
	`1005`	`+ #[\Override]`
`999`	`1006`	`public function setHeader($key, $value)`
`1000`	`1007`	`{`
`1001`	`1008`	`$this->headers[$key] = $value;`
`@@ -1013,6 +1020,7 @@ public function setHeader($key, $value)`
`1013`	`1020`	`*`
`1014`	`1021`	`* @param $headers`
`1015`	`1022`	`*/`
	`1023`	`+ #[\Override]`
`1016`	`1024`	`public function setHeaders($headers)`
`1017`	`1025`	`{`
`1018`	`1026`	`if (ArrayUtil::isArrayAssoc($headers)) {`
`@@ -1043,6 +1051,7 @@ public function setHeaders($headers)`
`1043`	`1051`	`*`
`1044`	`1052`	`* @param $mixed boolean\|callable`
`1045`	`1053`	`*/`
	`1054`	`+ #[\Override]`
`1046`	`1055`	`public function setJsonDecoder($mixed)`
`1047`	`1056`	`{`
`1048`	`1057`	`if ($mixed === false \|\| is_callable($mixed)) {`
`@@ -1056,6 +1065,7 @@ public function setJsonDecoder($mixed)`
`1056`	`1065`	`*`
`1057`	`1066`	`* @param $mixed boolean\|callable`
`1058`	`1067`	`*/`
	`1068`	`+ #[\Override]`
`1059`	`1069`	`public function setXmlDecoder($mixed)`
`1060`	`1070`	`{`
`1061`	`1071`	`if ($mixed === false \|\| is_callable($mixed)) {`
`@@ -1071,6 +1081,7 @@ public function setXmlDecoder($mixed)`
`1071`	`1081`	`* @param $value`
`1072`	`1082`	`* @return bool`
`1073`	`1083`	`*/`
	`1084`	`+ #[\Override]`
`1074`	`1085`	`public function setOpt($option, $value)`
`1075`	`1086`	`{`
`1076`	`1087`	`$required_options = [`
`@@ -1096,6 +1107,7 @@ public function setOpt($option, $value)`
`1096`	`1107`	`* @param $value`
`1097`	`1108`	`* @return bool`
`1098`	`1109`	`*/`
	`1110`	`+ #[\Override]`
`1099`	`1111`	`protected function setOptInternal($option, $value)`
`1100`	`1112`	`{`
`1101`	`1113`	`$success = curl_setopt($this->curl, $option, $value);`
`@@ -1115,6 +1127,7 @@ protected function setOptInternal($option, $value)`
`1115`	`1127`	`* returned, ignoring any future options in the options array.`
`1116`	`1128`	`* Similar to curl_setopt_array().`
`1117`	`1129`	`*/`
	`1130`	`+ #[\Override]`
`1118`	`1131`	`public function setOpts($options)`
`1119`	`1132`	`{`
`1120`	`1133`	`if (!count($options)) {`
`@@ -1159,6 +1172,7 @@ private function setProtocolsInternal($protocols)`
`1159`	`1172`	`*`
`1160`	`1173`	`* @param $mixed`
`1161`	`1174`	`*/`
	`1175`	`+ #[\Override]`
`1162`	`1176`	`public function setRetry($mixed)`
`1163`	`1177`	`{`
`1164`	`1178`	`if (is_callable($mixed)) {`
`@@ -1193,6 +1207,7 @@ private function setRedirectProtocolsInternal($redirect_protocols)`
`1193`	`1207`	`* @param $url`
`1194`	`1208`	`* @param $mixed_data`
`1195`	`1209`	`*/`
	`1210`	`+ #[\Override]`
`1196`	`1211`	`public function setUrl($url, $mixed_data = '')`
`1197`	`1212`	`{`
`1198`	`1213`	`$built_url = Url::buildUrl($url, $mixed_data);`
`@@ -1235,6 +1250,7 @@ public function attemptRetry()`
`1235`	`1250`	`*`
`1236`	`1251`	`* @param $key`
`1237`	`1252`	`*/`
	`1253`	`+ #[\Override]`
`1238`	`1254`	`public function unsetHeader($key)`
`1239`	`1255`	`{`
`1240`	`1256`	`unset($this->headers[$key]);`
`@@ -2132,6 +2148,7 @@ private function setStopInternal($callback = null)`
`2132`	`2148`	`*`
`2133`	`2149`	`* Used by MultiCurl::stop() when making multiple parallel requests.`
`2134`	`2150`	`*/`
	`2151`	`+ #[\Override]`
`2135`	`2152`	`public function stop()`
`2136`	`2153`	`{`
`2137`	`2154`	`$this->headerCallbackData->stopRequest = true;`
Original file line number	Diff line number	Diff line change
`@@ -348,6 +348,7 @@ public function addCurl(Curl $curl)`
`348`	`348`	`/**`
`349`	`349`	`* Close`
`350`	`350`	`*/`
	`351`	`+ #[\Override]`
`351`	`352`	`public function close()`
`352`	`353`	`{`
`353`	`354`	`foreach ($this->queuedCurls as $curl) {`
`@@ -376,6 +377,7 @@ public function setConcurrency($concurrency)`
`376`	`377`	`* @param $key`
`377`	`378`	`* @param $value`
`378`	`379`	`*/`
	`380`	`+ #[\Override]`
`379`	`381`	`public function setCookie($key, $value)`
`380`	`382`	`{`
`381`	`383`	`$this->cookies[$key] = $value;`
`@@ -386,6 +388,7 @@ public function setCookie($key, $value)`
`386`	`388`	`*`
`387`	`389`	`* @param $cookies`
`388`	`390`	`*/`
	`391`	`+ #[\Override]`
`389`	`392`	`public function setCookies($cookies)`
`390`	`393`	`{`
`391`	`394`	`foreach ($cookies as $key => $value) {`
`@@ -398,6 +401,7 @@ public function setCookies($cookies)`
`398`	`401`	`*`
`399`	`402`	`* @param $string`
`400`	`403`	`*/`
	`404`	`+ #[\Override]`
`401`	`405`	`public function setCookieString($string)`
`402`	`406`	`{`
`403`	`407`	`$this->setOpt(CURLOPT_COOKIE, $string);`
`@@ -408,6 +412,7 @@ public function setCookieString($string)`
`408`	`412`	`*`
`409`	`413`	`* @param $cookie_file`
`410`	`414`	`*/`
	`415`	`+ #[\Override]`
`411`	`416`	`public function setCookieFile($cookie_file)`
`412`	`417`	`{`
`413`	`418`	`$this->setOpt(CURLOPT_COOKIEFILE, $cookie_file);`
`@@ -418,6 +423,7 @@ public function setCookieFile($cookie_file)`
`418`	`423`	`*`
`419`	`424`	`* @param $cookie_jar`
`420`	`425`	`*/`
	`426`	`+ #[\Override]`
`421`	`427`	`public function setCookieJar($cookie_jar)`
`422`	`428`	`{`
`423`	`429`	`$this->setOpt(CURLOPT_COOKIEJAR, $cookie_jar);`
`@@ -431,6 +437,7 @@ public function setCookieJar($cookie_jar)`
`431`	`437`	`* @param $key`
`432`	`438`	`* @param $value`
`433`	`439`	`*/`
	`440`	`+ #[\Override]`
`434`	`441`	`public function setHeader($key, $value)`
`435`	`442`	`{`
`436`	`443`	`$this->headers[$key] = $value;`
`@@ -444,6 +451,7 @@ public function setHeader($key, $value)`
`444`	`451`	`*`
`445`	`452`	`* @param $headers`
`446`	`453`	`*/`
	`454`	`+ #[\Override]`
`447`	`455`	`public function setHeaders($headers)`
`448`	`456`	`{`
`449`	`457`	`if (ArrayUtil::isArrayAssoc($headers)) {`
`@@ -469,6 +477,7 @@ public function setHeaders($headers)`
`469`	`477`	`*`
`470`	`478`	`* @param $mixed boolean\|callable`
`471`	`479`	`*/`
	`480`	`+ #[\Override]`
`472`	`481`	`public function setJsonDecoder($mixed)`
`473`	`482`	`{`
`474`	`483`	`if ($mixed === false) {`
`@@ -483,6 +492,7 @@ public function setJsonDecoder($mixed)`
`483`	`492`	`*`
`484`	`493`	`* @param $mixed boolean\|callable`
`485`	`494`	`*/`
	`495`	`+ #[\Override]`
`486`	`496`	`public function setXmlDecoder($mixed)`
`487`	`497`	`{`
`488`	`498`	`if ($mixed === false) {`
`@@ -512,6 +522,7 @@ public function setProxies($proxies)`
`512`	`522`	`* @param $option`
`513`	`523`	`* @param $value`
`514`	`524`	`*/`
	`525`	`+ #[\Override]`
`515`	`526`	`public function setOpt($option, $value)`
`516`	`527`	`{`
`517`	`528`	`$this->options[$option] = $value;`
`@@ -536,6 +547,7 @@ public function setOpt($option, $value)`
`536`	`547`	`*`
`537`	`548`	`* @param $options`
`538`	`549`	`*/`
	`550`	`+ #[\Override]`
`539`	`551`	`public function setOpts($options)`
`540`	`552`	`{`
`541`	`553`	`foreach ($options as $option => $value) {`
`@@ -608,6 +620,7 @@ public function setRateLimit($rate_limit)`
`608`	`620`	`*`
`609`	`621`	`* @param $mixed`
`610`	`622`	`*/`
	`623`	`+ #[\Override]`
`611`	`624`	`public function setRetry($mixed)`
`612`	`625`	`{`
`613`	`626`	`$this->retry = $mixed;`
`@@ -619,6 +632,7 @@ public function setRetry($mixed)`
`619`	`632`	`* @param $url`
`620`	`633`	`* @param $mixed_data`
`621`	`634`	`*/`
	`635`	`+ #[\Override]`
`622`	`636`	`public function setUrl($url, $mixed_data = '')`
`623`	`637`	`{`
`624`	`638`	`$built_url = Url::buildUrl($url, $mixed_data);`
`@@ -748,6 +762,7 @@ public function start()`
`748`	`762`	`/**`
`749`	`763`	`* Stop`
`750`	`764`	`*/`
	`765`	`+ #[\Override]`
`751`	`766`	`public function stop()`
`752`	`767`	`{`
`753`	`768`	`// Remove any queued curl requests.`
`@@ -775,6 +790,7 @@ public function stop()`
`775`	`790`	`*`
`776`	`791`	`* @param $key`
`777`	`792`	`*/`
	`793`	`+ #[\Override]`
`778`	`794`	`public function unsetHeader($key)`
`779`	`795`	`{`
`780`	`796`	`unset($this->headers[$key]);`