Add missing types to method signatures

Author: Naktibalda

src/Codeception/Constraint/JsonContains.php

@@ -16,14 +16,8 @@
 
 class JsonContains extends Constraint
 {
-    /**
-     * @var array
-     */
-    protected $expected;
-
-    public function __construct(array $expected)
+    public function __construct(protected array $expected)
     {
-        $this->expected = $expected;
     }
 
     /**

src/Codeception/Constraint/JsonType.php

@@ -13,26 +13,17 @@
 
 class JsonType extends Constraint
 {
-    /**
-     * @var array
-     */
-    protected $jsonType;
-    /**
-     * @var bool
-     */
-    private $match;
-
-    public function __construct(array $jsonType, bool $match = true)
+    public function __construct(
+        protected array $jsonType,
+        private bool $match = true)
     {
-        $this->jsonType = $jsonType;
-        $this->match = $match;
     }
 
     /**
      * Evaluates the constraint for parameter $other. Returns true if the
      * constraint is met, false otherwise.
      *
-     * @param mixed $jsonArray Value or object to evaluate.
+     * @param array|JsonArray $jsonArray Value or object to evaluate.
      */
     protected function matches($jsonArray): bool
     {

src/Codeception/Module/REST.php

@@ -22,7 +22,10 @@
 use Codeception\Util\JsonArray;
 use Codeception\Util\JsonType;
 use Codeception\Util\Soap as XmlUtils;
+use Codeception\Util\XmlBuilder;
 use Codeception\Util\XmlStructure;
+use DOMDocument;
+use DOMNode;
 use Exception;
 use JsonException;
 use JsonSchema\Constraints\Constraint as JsonConstraint;
@@ -121,17 +124,13 @@ class REST extends Module implements DependsOnModule, PartedModule, API, Conflic
 
     protected int $DEFAULT_SHORTEN_VALUE = 150;
 
-    /**
-     * @var HttpKernelBrowser|AbstractBrowser
-     */
-    public $client;
+    public HttpKernelBrowser|AbstractBrowser|null $client;
 
     public bool $isFunctional = false;
 
     protected ?InnerBrowser $connectionModule = null;
 
-    /** @var array */
-    public $params = [];
+    public array|string|ArrayAccess|JsonSerializable $params = [];
 
     public ?string $response = null;
 
@@ -150,7 +149,7 @@ protected function resetVariables(): void
 
     public function _conflicts(): string
     {
-        return \Codeception\Lib\Interfaces\API::class;
+        return API::class;
     }
 
     public function _depends(): array
@@ -202,7 +201,7 @@ protected function getRunningClient(): AbstractBrowser
     }
 
     /**
-     * Sets a HTTP header to be used for all subsequent requests. Use [`deleteHeader`](#deleteHeader) to unset it.
+     * Sets na HTTP header to be used for all subsequent requests. Use [`deleteHeader`](#deleteHeader) to unset it.
      *
      * ```php
      * <?php
@@ -219,7 +218,7 @@ public function haveHttpHeader(string $name, string $value): void
     }
 
     /**
-     * Deletes a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
+     * Deletes an HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
      * so that subsequent requests will not send it anymore.
      *
      * Example:
@@ -245,7 +244,6 @@ public function deleteHeader(string $name): void
      * Checks over the given HTTP header and (optionally)
      * its value, asserting that are there
      *
-     * @param $value
      * @part json
      * @part xml
      */
@@ -266,7 +264,6 @@ public function seeHttpHeader(string $name, $value = null): void
      * Checks over the given HTTP header and (optionally)
      * its value, asserting that are not there
      *
-     * @param $value
      * @part json
      * @part xml
      */
@@ -286,7 +283,7 @@ public function dontSeeHttpHeader(string $name, $value = null): void
     /**
      * Checks that http response header is received only once.
      * HTTP RFC2616 allows multiple response headers with the same name.
-     * You can check that you didn't accidentally sent the same header twice.
+     * You can check that you didn't accidentally send the same header twice.
      *
      * ``` php
      * <?php
@@ -306,7 +303,7 @@ public function seeHttpHeaderOnce(string $name): void
      * Returns the value of the specified header name
      *
      * @param bool $first Whether to return the first value or all header values
-     * @return string|array The first header value if $first is true, an array of values otherwise
+     * @return string|array|null The first header value if $first is true, an array of values otherwise
      * @part json
      * @part xml
      */
@@ -386,7 +383,7 @@ public function amNTLMAuthenticated(string $username, string $password): void
     }
 
     /**
-     * Allows to send REST request using AWS Authorization
+     * Allows sending REST request using AWS Authorization
      *
      * Only works with PhpBrowser
      * Example Config:
@@ -460,7 +457,6 @@ public function amAWSAuthenticated(array $additionalAWSConfig = []): void
      * ]]);
      * ```
      *
-     * @param array|string|JsonSerializable $params
      * @param array $files A list of filenames or "mocks" of $_FILES (each entry being an array with the following
      *                     keys: name, type, error, size, tmp_name (pointing to the real file path). Each key works
      *                     as the "name" attribute of a file input field.
@@ -470,7 +466,10 @@ public function amAWSAuthenticated(array $additionalAWSConfig = []): void
      * @part json
      * @part xml
      */
-    public function sendPost(string $url, $params = [], array $files = [])
+    public function sendPost(
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $params = [],
+        array $files = []): ?string
     {
         return $this->execute('POST', $url, $params, $files);
     }
@@ -481,7 +480,7 @@ public function sendPost(string $url, $params = [], array $files = [])
      * @part json
      * @part xml
      */
-    public function sendHead(string $url, array $params = [])
+    public function sendHead(string $url, array $params = []): ?string
     {
         return $this->execute('HEAD', $url, $params);
     }
@@ -511,7 +510,7 @@ public function sendOptions(string $url, array $params = []): void
      * @part json
      * @part xml
      */
-    public function sendGet(string $url, array $params = [])
+    public function sendGet(string $url, array $params = []): ?string
     {
         return $this->execute('GET', $url, $params);
     }
@@ -524,11 +523,14 @@ public function sendGet(string $url, array $params = [])
      * $response = $I->sendPut('/message/1', ['subject' => 'Read this!']);
      * ```
      *
-     * @param array|string|JsonSerializable $params
      * @part json
      * @part xml
      */
-    public function sendPut(string $url, $params = [], array $files = [])
+    public function sendPut(
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $params = [],
+        array $files = []
+    ): ?string
     {
         return $this->execute('PUT', $url, $params, $files);
     }
@@ -541,11 +543,14 @@ public function sendPut(string $url, $params = [], array $files = [])
      * $response = $I->sendPatch('/message/1', ['subject' => 'Read this!']);
      * ```
      *
-     * @param array|string|JsonSerializable $params
      * @part json
      * @part xml
      */
-    public function sendPatch(string $url, $params = [], array $files = [])
+    public function sendPatch(
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $params = [],
+        array $files = []
+    ): ?string
     {
         return $this->execute('PATCH', $url, $params, $files);
     }
@@ -561,19 +566,26 @@ public function sendPatch(string $url, $params = [], array $files = [])
      * @part json
      * @part xml
      */
-    public function sendDelete(string $url, array $params = [], array $files = [])
+    public function sendDelete(
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $params = [],
+        array $files = []
+    ): ?string
     {
         return $this->execute('DELETE', $url, $params, $files);
     }
 
     /**
      * Sends a HTTP request.
      *
-     * @param array|string|JsonSerializable $params
      * @part json
      * @part xml
      */
-    public function send(string $method, string $url, $params = [], array $files = [])
+    public function send(
+        string $method,
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $params = [],
+        array $files = []): ?string
     {
         return $this->execute(strtoupper($method), $url, $params, $files);
     }
@@ -640,13 +652,13 @@ public function sendUnlink(string $url, array $linkEntries): void
     }
 
     /**
-     * @param $method
-     * @param $url
-     * @param array|string|object $parameters
-     * @param array $files
      * @throws ModuleException|ExternalUrlException|JsonException
      */
-    protected function execute($method, $url, $parameters = [], $files = [])
+    protected function execute(
+        string $method,
+        string $url,
+        array|string|ArrayAccess|JsonSerializable $parameters = [],
+        array $files = []): ?string
     {
         // allow full url to be requested
         if (!$url) {
@@ -692,6 +704,9 @@ protected function execute($method, $url, $parameters = [], $files = [])
 
             $this->response = $this->connectionModule->_request($method, $url, $parameters, $files);
         } else {
+            /**
+             * @var string $parameters
+             */
             $requestData = $parameters;
             if ($this->isBinaryData($requestData)) {
                 $requestData = $this->binaryToDebugString($requestData);
@@ -739,7 +754,10 @@ protected function binaryToDebugString(string $data): string
         return '[binary-data length:' . strlen($data) . ' md5:' . md5($data) . ']';
     }
 
-    protected function encodeApplicationJson(string $method, $parameters)
+    protected function encodeApplicationJson(
+        string $method,
+        array|string|ArrayAccess|JsonSerializable $parameters,
+    ): array|string
     {
         if (
             array_key_exists('Content-Type', $this->connectionModule->headers)
@@ -901,15 +919,15 @@ public function dontSeeResponseContains(string $text): void
      *
      * ``` php
      * <?php
-     * // response: {name: john, email: [email protected]}
-     * $I->seeResponseContainsJson(array('name' => 'john'));
+     * // response: {"name": "john", "email": "[email protected]"}
+     * $I->seeResponseContainsJson(['name' => 'john']);
      *
-     * // response {user: john, profile: { email: [email protected] }}
-     * $I->seeResponseContainsJson(array('email' => '[email protected]'));
+     * // response {"user": "john", "profile": {"email": "[email protected]"}}
+     * $I->seeResponseContainsJson(['email' => '[email protected]']);
      *
      * ```
      *
-     * This method recursively checks if one array can be found inside of another.
+     * This method recursively checks if one array can be found inside another.
      *
      * @part json
      */
@@ -1313,13 +1331,13 @@ public function dontSeeResponseContainsJson(array $json = []): void
      *
      * ```php
      * <?php
-     * // {'user_id': 1, 'email' => '[email protected]'}
+     * // {"user_id": 1, "email" => "[email protected]"}
      * $I->seeResponseMatchesJsonType([
      *      'user_id' => 'string:>0:<1000', // multiple filters can be used
      *      'email' => 'string:regex(~\@~)' // we just check that @ char is included
      * ]);
      *
-     * // {'user_id': '1'}
+     * // {"user_id"'": "1"}
      * $I->seeResponseMatchesJsonType([
      *      'user_id' => 'string:>0', // works with strings as well
      * ]);
@@ -1513,10 +1531,9 @@ public function dontSeeXmlResponseMatchesXpath(string $xPath): void
      * Finds and returns text contents of element.
      * Element is matched by either CSS or XPath
      *
-     * @param mixed $cssOrXPath
      * @part xml
      */
-    public function grabTextContentFromXmlElement($cssOrXPath): string
+    public function grabTextContentFromXmlElement(string $cssOrXPath): string
     {
         $el = (new XmlStructure($this->connectionModule->_getResponseContent()))->matchElement($cssOrXPath);
         return $el->textContent;
@@ -1542,12 +1559,9 @@ public function grabAttributeFromXmlElement(string $cssOrXPath, string $attribut
      * Checks XML response equals provided XML.
      * Comparison is done by canonicalizing both xml`s.
      *
-     * Parameters can be passed either as DOMDocument, DOMNode, XML string, or array (if no attributes).
-     *
-     * @param mixed $xml
      * @part xml
      */
-    public function seeXmlResponseEquals($xml): void
+    public function seeXmlResponseEquals(DOMDocument|string $xml): void
     {
         Assert::assertXmlStringEqualsXmlString($this->connectionModule->_getResponseContent(), $xml);
     }
@@ -1557,12 +1571,10 @@ public function seeXmlResponseEquals($xml): void
      * Checks XML response does not equal to provided XML.
      * Comparison is done by canonicalizing both xml`s.
      *
-     * Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
-     *
      * @param mixed $xml
      * @part xml
      */
-    public function dontSeeXmlResponseEquals($xml): void
+    public function dontSeeXmlResponseEquals(DOMDocument|string $xml): void
     {
         Assert::assertXmlStringNotEqualsXmlString(
             $this->connectionModule->_getResponseContent(),
@@ -1582,10 +1594,9 @@ public function dontSeeXmlResponseEquals($xml): void
      * $I->seeXmlResponseIncludes("<result>1</result>");
      * ```
      *
-     * @param mixed $xml
      * @part xml
      */
-    public function seeXmlResponseIncludes($xml): void
+    public function seeXmlResponseIncludes(DOMNode|XmlBuilder|array|string $xml): void
     {
         $this->assertStringContainsString(
             XmlUtils::toXml($xml)->C14N(),
@@ -1599,10 +1610,9 @@ public function seeXmlResponseIncludes($xml): void
      * Comparison is done by canonicalizing both xml`s.
      * Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
      *
-     * @param mixed $xml
      * @part xml
      */
-    public function dontSeeXmlResponseIncludes($xml): void
+    public function dontSeeXmlResponseIncludes(DOMNode|XmlBuilder|array|string $xml): void
     {
         $this->assertStringNotContainsString(
             XmlUtils::toXml($xml)->C14N(),