Added more typehints

Author: TavoNiievez

src/Codeception/Module/SOAP.php

@@ -4,16 +4,17 @@
 
 namespace Codeception\Module;
 
-use Codeception\Lib\Interfaces\DependsOnModule;
-use Codeception\Module;
-use Codeception\TestInterface;
 use Codeception\Exception\ModuleException;
 use Codeception\Exception\ModuleRequireException;
 use Codeception\Lib\Framework;
 use Codeception\Lib\InnerBrowser;
+use Codeception\Lib\Interfaces\DependsOnModule;
+use Codeception\Module;
+use Codeception\TestInterface;
 use Codeception\Util\Soap as SoapUtils;
 use Codeception\Util\XmlStructure;
 use DOMDocument;
+use ErrorException;
 use PHPUnit\Framework\Assert;
 use Symfony\Component\BrowserKit\AbstractBrowser;
 
@@ -124,7 +125,7 @@ protected function onReconfigure(): void
 
     public function _depends()
     {
-        return [\Codeception\Lib\InnerBrowser::class => $this->dependencyMessage];
+        return [InnerBrowser::class => $this->dependencyMessage];
     }
 
     public function _inject(InnerBrowser $connectionModule): void
@@ -151,7 +152,7 @@ private function getXmlResponse(): DOMDocument
         return $this->xmlResponse;
     }
 
-    private function getXmlStructure(): \Codeception\Util\XmlStructure
+    private function getXmlStructure(): XmlStructure
     {
         if (!$this->xmlStructure) {
             $this->xmlStructure = new XmlStructure($this->getXmlResponse());
@@ -182,9 +183,9 @@ private function getXmlStructure(): \Codeception\Util\XmlStructure
      *   </soapenv:Header>
      * ```
      *
-     * @param $header
+     * @param string $header
      */
-    public function haveSoapHeader($header, array $params = []): void
+    public function haveSoapHeader(string $header, array $params = []): void
     {
         $soap_schema_url = $this->config['schema_url'];
         $xml = $this->xmlRequest;
@@ -211,10 +212,10 @@ public function haveSoapHeader($header, array $params = []): void
      *   ->name->val('notdavert');
      * ```
      *
-     * @param $request
-     * @param $body
+     * @param string $action
+     * @param object|string $body
      */
-    public function sendSoapRequest($action, $body = ''): void
+    public function sendSoapRequest(string $action, $body = ''): void
     {
         $soap_schema_url = $this->config['schema_url'];
         $xml = $this->xmlRequest;
@@ -268,9 +269,9 @@ public function sendSoapRequest($action, $body = ''): void
      *
      * ```
      *
-     * @param $xml
+     * @param string $xml
      */
-    public function seeSoapResponseEquals($xml): void
+    public function seeSoapResponseEquals(string $xml): void
     {
         $xml = SoapUtils::toXml($xml);
         $this->assertEquals($xml->C14N(), $this->getXmlResponse()->C14N());
@@ -293,12 +294,12 @@ public function seeSoapResponseEquals($xml): void
      * $I->seeSoapRequestIncludes($dom);
      * ```
      *
-     * @param $xml
+     * @param string $xml
      */
-    public function seeSoapResponseIncludes($xml): void
+    public function seeSoapResponseIncludes(string $xml): void
     {
         $xml = $this->canonicalize($xml);
-        $this->assertStringContainsString($xml, $this->getXmlResponse()->C14N(), "found in XML Response");
+        $this->assertStringContainsString($xml, $this->getXmlResponse()->C14N(), 'found in XML Response');
     }
 
 
@@ -308,9 +309,9 @@ public function seeSoapResponseIncludes($xml): void
      *
      * Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
      *
-     * @param $xml
+     * @param string $xml
      */
-    public function dontSeeSoapResponseEquals($xml): void
+    public function dontSeeSoapResponseEquals(string $xml): void
     {
         $xml = SoapUtils::toXml($xml);
         Assert::assertXmlStringNotEqualsXmlString($xml->C14N(), $this->getXmlResponse()->C14N());
@@ -322,9 +323,9 @@ public function dontSeeSoapResponseEquals($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 $xml
+     * @param string $xml
      */
-    public function dontSeeSoapResponseIncludes($xml): void
+    public function dontSeeSoapResponseIncludes(string $xml): void
     {
         $xml = $this->canonicalize($xml);
         $this->assertStringNotContainsString($xml, $this->getXmlResponse()->C14N(), "found in XML Response");
@@ -347,9 +348,9 @@ public function dontSeeSoapResponseIncludes($xml): void
      * This method does not use schema for validation.
      * This method does not require path from root to match the structure.
      *
-     * @param $xml
+     * @param string $xml
      */
-    public function seeSoapResponseContainsStructure($xml): void
+    public function seeSoapResponseContainsStructure(string $xml): void
     {
         $xml = SoapUtils::toXml($xml);
         $this->debugSection("Structure", $xml->saveXML());
@@ -358,9 +359,9 @@ public function seeSoapResponseContainsStructure($xml): void
 
     /**
      * Opposite to `seeSoapResponseContainsStructure`
-     * @param $xml
+     * @param string $xml
      */
-    public function dontSeeSoapResponseContainsStructure($xml): void
+    public function dontSeeSoapResponseContainsStructure(string $xml): void
     {
         $xml = SoapUtils::toXml($xml);
         $this->debugSection("Structure", $xml->saveXML());
@@ -375,9 +376,9 @@ public function dontSeeSoapResponseContainsStructure($xml): void
      * $I->seeSoapResponseContainsXPath('//root/user[@id=1]');
      * ```
      *
-     * @param $xPath
+     * @param string $xPath
      */
-    public function seeSoapResponseContainsXPath($xPath): void
+    public function seeSoapResponseContainsXPath(string $xPath): void
     {
         $this->assertTrue($this->getXmlStructure()->matchesXpath($xPath));
     }
@@ -390,9 +391,9 @@ public function seeSoapResponseContainsXPath($xPath): void
      * $I->dontSeeSoapResponseContainsXPath('//root/user[@id=1]');
      * ```
      *
-     * @param $xPath
+     * @param string $xPath
      */
-    public function dontSeeSoapResponseContainsXPath($xPath): void
+    public function dontSeeSoapResponseContainsXPath(string $xPath): void
     {
         $this->assertFalse($this->getXmlStructure()->matchesXpath($xPath));
     }
@@ -401,9 +402,9 @@ public function dontSeeSoapResponseContainsXPath($xPath): void
     /**
      * Checks response code from server.
      *
-     * @param $code
+     * @param string $code
      */
-    public function seeSoapResponseCodeIs($code): void
+    public function seeSoapResponseCodeIs(string $code): void
     {
         $this->assertEquals(
             $code,
@@ -417,9 +418,9 @@ public function seeSoapResponseCodeIs($code): void
      * Element is matched by either CSS or XPath
      *
      * @version 1.1
-     * @param $cssOrXPath
+     * @param string $cssOrXPath
      */
-    public function grabTextContentFrom($cssOrXPath): string
+    public function grabTextContentFrom(string $cssOrXPath): string
     {
         $el = $this->getXmlStructure()->matchElement($cssOrXPath);
         return $el->textContent;
@@ -430,10 +431,10 @@ public function grabTextContentFrom($cssOrXPath): string
      * Element is matched by either CSS or XPath
      *
      * @version 1.1
-     * @param $cssOrXPath
-     * @param $attribute
+     * @param string $cssOrXPath
+     * @param string $attribute
      */
-    public function grabAttributeFrom($cssOrXPath, $attribute): string
+    public function grabAttributeFrom(string $cssOrXPath, string $attribute): string
     {
         $el = $this->getXmlStructure()->matchElement($cssOrXPath);
         $elHasAttribute = $el->hasAttribute($attribute);
@@ -448,7 +449,7 @@ protected function getSchema()
         return $this->config['schema'];
     }
 
-    protected function canonicalize($xml): string
+    protected function canonicalize(string $xml): string
     {
         return SoapUtils::toXml($xml)->C14N();
     }
@@ -471,7 +472,7 @@ protected function buildRequest(): DOMDocument
         return $xml;
     }
 
-    protected function processRequest($action, $body): void
+    protected function processRequest(string $action, string $body): void
     {
         $this->getClient()->request(
             'POST',
@@ -490,13 +491,13 @@ protected function processRequest($action, $body): void
     /**
      * @return string|bool
      */
-    protected function processInternalRequest($action, $body)
+    protected function processInternalRequest(string $action, string $body)
     {
         ob_start();
         try {
             $this->getClient()->setServerParameter('HTTP_HOST', 'localhost');
             $this->processRequest($action, $body);
-        } catch (\ErrorException $e) {
+        } catch (ErrorException $e) {
             // Zend_Soap outputs warning as an exception
             if (strpos($e->getMessage(), 'Warning: Cannot modify header information') === false) {
                 ob_end_clean();
@@ -508,7 +509,7 @@ protected function processInternalRequest($action, $body)
         return $response;
     }
 
-    protected function processExternalRequest($action, $body): string
+    protected function processExternalRequest(string $action, string $body): string
     {
         $this->processRequest($action, $body);
         return $this->client->getInternalResponse()->getContent();

tests/unit/Codeception/Module/SoapTest.php

@@ -131,7 +131,7 @@ public function testSeeXmlIncludesWithBuilder()
                 ->attr('a2', '2')
                 ->attr('a1', '1')
                 ->val('123');
-        $this->module->seeSoapResponseIncludes($xml);
+        $this->module->seeSoapResponseIncludes((string) $xml);
     }
 
     public function testGrabTextFrom()