[CS] Removed useless test asserts, Fix code issues reported by PHPStan

horstoeko · Dec 27, 2024 · 54c0e1d · 54c0e1d
1 parent 41e8098
commit 54c0e1d
Show file tree

Hide file tree

Showing 26 changed files with 7 additions and 125 deletions.
diff --git a/build/phpstan.neon b/build/phpstan.neon
@@ -9,3 +9,6 @@ parameters:
         - ../src/codelistsenum/*
         - ../tests/testcases/issues/Issue32Test.php
         - ../src/quick/ZugferdQuickDescriptor.php
+        - ../tests/traits/HandlesXmlTests.php
+    ignoreErrors:
+        - identifier: parameterByRef.unusedType
diff --git a/src/ZugferdDocument.php b/src/ZugferdDocument.php
@@ -153,7 +153,7 @@ public function getProfileDefinitionParameter(string $parameterName)
     {
         $profileDefinition = $this->getProfileDefinition();
 
-        if (is_array($profileDefinition) && isset($profileDefinition[$parameterName])) {
+        if (isset($profileDefinition[$parameterName])) {
             return $profileDefinition[$parameterName];
         }
 

diff --git a/src/ZugferdDocumentPdfMerger.php b/src/ZugferdDocumentPdfMerger.php
@@ -140,7 +140,7 @@ private function getProfileDefinitionParameter(string $parameterName)
     {
         $profileDefinition = $this->getProfileDefinition();
 
-        if (is_array($profileDefinition) && isset($profileDefinition[$parameterName])) {
+        if (isset($profileDefinition[$parameterName])) {
             return $profileDefinition[$parameterName];
         }
 

diff --git a/src/ZugferdDocumentReader.php b/src/ZugferdDocumentReader.php
@@ -3230,12 +3230,12 @@ public function nextDocumentPositionAdditionalReferencedDocument(): bool
      * @param  string|null   $typeCode         __BT-X-30, From EXTENDED__ Type of referenced document (See codelist UNTDID 1001)
      * @param  string|null   $uriId            __BT-X-28, From EXTENDED__ The Uniform Resource Locator (URL) at which the external document is available. A means of finding the resource including the primary access method intended for it, e.g. http: // or ftp: //. The location of the external document must be used if the buyer needs additional information to support the amounts billed. External documents are not part of the invoice. Access to external documents can involve certain risks.
      * @param  string|null   $lineId           __BT-X-29, From EXTENDED__ The referenced position identifier in the additional document
-     * @param  string|null   $name             __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc.
+     * @param  array|null    $name             __BT-X-299, From EXTENDED__ A description of the document, e.g. Hourly billing, usage or consumption report, etc.
      * @param  string|null   $refTypeCode      __BT-X-32, From EXTENDED__ The identifier for the identification scheme of the identifier of the item invoiced. If it is not clear to the recipient which scheme is used for the identifier, an identifier of the scheme should be used, which must be selected from UNTDID 1153 in accordance with the code list entries.
      * @param  DateTime|null $issueDate        __BT-X-33, From EXTENDED__ Document date
      * @return ZugferdDocumentReader
      */
-    public function getDocumentPositionAdditionalReferencedDocument(?string &$issuerAssignedId, ?string &$typeCode, ?string &$uriId, ?string &$lineId, ?string &$name, ?string &$refTypeCode, ?DateTime &$issueDate): ZugferdDocumentReader
+    public function getDocumentPositionAdditionalReferencedDocument(?string &$issuerAssignedId, ?string &$typeCode, ?string &$uriId, ?string &$lineId, ?array &$name, ?string &$refTypeCode, ?DateTime &$issueDate): ZugferdDocumentReader
     {
         $tradeLineItem = $this->getInvoiceValueByPath("getSupplyChainTradeTransaction.getIncludedSupplyChainTradeLineItem", []);
         $tradeLineItem = $tradeLineItem[$this->positionPointer];

diff --git a/src/ZugferdDocumentValidator.php b/src/ZugferdDocumentValidator.php
@@ -27,15 +27,11 @@ class ZugferdDocumentValidator
 {
     /**
      * The invoice document reference
-     *
-     * @var ZugferdDocument
      */
     private $document;
 
     /**
      * The validator instance
-     *
-     * @var \Symfony\Component\Validator\Validator\ValidatorInterface;
      */
     private $validator = null;
 

diff --git a/src/ZugferdProfileResolver.php b/src/ZugferdProfileResolver.php
@@ -57,10 +57,6 @@ public static function resolve(string $xmlContent): array
             throw new ZugferdUnknownXmlContentException();
         }
 
-        /**
-         * @var int $profile
-         * @var array $profiledef
-         */
         foreach (ZugferdProfiles::PROFILEDEF as $profile => $profiledef) {
             if ($typeelement[0] == $profiledef["contextparameter"]) {
                 return [$profile, $profiledef];

diff --git a/tests/testcases/BuilderEn16931Test.php b/tests/testcases/BuilderEn16931Test.php
@@ -2111,7 +2111,6 @@ public function testWriteFile(): void
     public function testToString(): void
     {
         $xmlContent = (string)self::$document;
-        $this->assertIsString($xmlContent);
         $this->assertStringStartsWith("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rsm:CrossIndustryInvoice", $xmlContent);
     }
 

diff --git a/tests/testcases/BuilderExtendedTest.php b/tests/testcases/BuilderExtendedTest.php
@@ -2034,7 +2034,6 @@ public function testWriteFile(): void
     public function testToString(): void
     {
         $xmlContent = (string)self::$document;
-        $this->assertIsString($xmlContent);
         $this->assertStringStartsWith("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rsm:CrossIndustryInvoice", $xmlContent);
     }
 

diff --git a/tests/testcases/BuilderMinimumTest.php b/tests/testcases/BuilderMinimumTest.php
@@ -2009,7 +2009,6 @@ public function testWriteFile(): void
     public function testToString(): void
     {
         $xmlContent = (string)self::$document;
-        $this->assertIsString($xmlContent);
         $this->assertStringStartsWith("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<rsm:CrossIndustryInvoice", $xmlContent);
     }
 

diff --git a/tests/testcases/DocumentTest.php b/tests/testcases/DocumentTest.php
@@ -13,7 +13,6 @@ class DocumentTest extends TestCase
     public function testDocumentCreationMinimum(): void
     {
         $doc = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_MINIMUM);
-        $this->assertNotNull($doc);
         $this->assertEquals(ZugferdProfiles::PROFILE_MINIMUM, $doc->getProfileId());
         $this->assertArrayHasKey("contextparameter", $doc->getProfileDefinition());
         $this->assertArrayHasKey("name", $doc->getProfileDefinition());
@@ -24,7 +23,6 @@ public function testDocumentCreationMinimum(): void
     public function testDocumentCreationBasic(): void
     {
         $doc = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_BASIC);
-        $this->assertNotNull($doc);
         $this->assertEquals(ZugferdProfiles::PROFILE_BASIC, $doc->getProfileId());
         $this->assertArrayHasKey("contextparameter", $doc->getProfileDefinition());
         $this->assertArrayHasKey("name", $doc->getProfileDefinition());
@@ -35,7 +33,6 @@ public function testDocumentCreationBasic(): void
     public function testDocumentCreationBasicWl(): void
     {
         $doc = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_BASICWL);
-        $this->assertNotNull($doc);
         $this->assertEquals(ZugferdProfiles::PROFILE_BASICWL, $doc->getProfileId());
         $this->assertArrayHasKey("contextparameter", $doc->getProfileDefinition());
         $this->assertArrayHasKey("name", $doc->getProfileDefinition());
@@ -46,7 +43,6 @@ public function testDocumentCreationBasicWl(): void
     public function testDocumentCreationEn16931(): void
     {
         $doc = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_EN16931);
-        $this->assertNotNull($doc);
         $this->assertEquals(ZugferdProfiles::PROFILE_EN16931, $doc->getProfileId());
         $this->assertArrayHasKey("contextparameter", $doc->getProfileDefinition());
         $this->assertArrayHasKey("name", $doc->getProfileDefinition());
@@ -57,7 +53,6 @@ public function testDocumentCreationEn16931(): void
     public function testDocumentCreationExtended(): void
     {
         $doc = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_EXTENDED);
-        $this->assertNotNull($doc);
         $this->assertEquals(ZugferdProfiles::PROFILE_EXTENDED, $doc->getProfileId());
         $this->assertArrayHasKey("contextparameter", $doc->getProfileDefinition());
         $this->assertArrayHasKey("name", $doc->getProfileDefinition());

diff --git a/tests/testcases/PdfBuilderEn16931Test.php b/tests/testcases/PdfBuilderEn16931Test.php
@@ -114,7 +114,6 @@ public function testBuildFromSourcePdfFile(): void
 
         $pdfContent = $pdfBuilder->downloadString(self::$destPdfFilename);
 
-        $this->assertIsString($pdfContent);
         $this->assertNotEquals('', $pdfContent);
         $this->assertStringStartsNotWith('%PDF-1.4', $pdfContent);
     }
@@ -149,7 +148,6 @@ public function testBuildFromSourcePdfString(): void
 
         $pdfContent = $pdfBuilder->downloadString(self::$destPdfFilename);
 
-        $this->assertIsString($pdfContent);
         $this->assertNotEquals('', $pdfContent);
         $this->assertStringStartsNotWith('%PDF-1.4', $pdfContent);
     }
@@ -164,7 +162,6 @@ public function testPdfMetaData(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails); //"FPDF 1.84"
         $this->assertArrayHasKey("CreationDate", $pdfDetails); //"2020-12-09T05:19:39+00:00"
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -367,7 +364,6 @@ public function testAdditionalFilesAreEmbedded(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfFilespecs = $pdfParsed->getObjectsByType('Filespec');
 
-        $this->assertIsArray($pdfFilespecs);
         $this->assertEquals(2, count($pdfFilespecs));
         $this->assertArrayHasKey("8_0", $pdfFilespecs);
         $this->assertArrayHasKey("10_0", $pdfFilespecs);
@@ -469,7 +465,6 @@ public function testAttachAdditionalFileByContentAllValid(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfFilespecs = $pdfParsed->getObjectsByType('Filespec');
 
-        $this->assertIsArray($pdfFilespecs);
         $this->assertEquals(2, count($pdfFilespecs));
         $this->assertArrayHasKey("8_0", $pdfFilespecs);
         $this->assertArrayHasKey("10_0", $pdfFilespecs);
@@ -545,7 +540,6 @@ public function testDeterministicMode(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -596,7 +590,6 @@ public function testCustomMetaInformation(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -645,7 +638,6 @@ public function testCustomMetaInformation(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -695,7 +687,6 @@ public function testCustomMetaInformation(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -746,7 +737,6 @@ public function testCustomMetaInformation(): void
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -820,7 +810,6 @@ function ($which) use (&$whichArray) {
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -884,7 +873,6 @@ function ($which) {
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);
@@ -936,7 +924,6 @@ function ($which) {
         $pdfParsed = $pdfParser->parseFile(self::$destPdfFilename);
         $pdfDetails = $pdfParsed->getDetails();
 
-        $this->assertIsArray($pdfDetails);
         $this->assertArrayHasKey("Producer", $pdfDetails);
         $this->assertArrayHasKey("CreationDate", $pdfDetails);
         $this->assertArrayHasKey("Title", $pdfDetails);

diff --git a/tests/testcases/PdfReaderEn16931AllowanceChargeTest.php b/tests/testcases/PdfReaderEn16931AllowanceChargeTest.php
@@ -318,12 +318,10 @@ public function testDocumentShipToGeneral(): void
     {
         self::$document->getDocumentShipTo($shiptoname, $shiptoids, $shiptodescription);
         $this->assertNotNull($shiptoname);
-        $this->assertIsString($shiptoname);
         $this->assertEquals("", $shiptoname);
         $this->assertIsArray($shiptoids);
         $this->assertEmpty($shiptoids);
         $this->assertNotNull($shiptodescription);
-        $this->assertIsString($shiptodescription);
         $this->assertEquals("", $shiptodescription);
     }
 
@@ -788,32 +786,27 @@ public function testDocumentDespatchAdviceReferencedDocument(): void
         self::$document->getDocumentDespatchAdviceReferencedDocument($despatchdocid, $despatchdocdate);
         $this->assertEquals("", $despatchdocid);
         $this->assertNull($despatchdocdate);
-        $this->assertNotInstanceOf("DateTime", $despatchdocdate);
     }
 
     public function testDocumentReceivingAdviceReferencedDocument(): void
     {
         self::$document->getDocumentReceivingAdviceReferencedDocument($recadvid, $recadvdate);
         $this->assertEquals("", $recadvid);
         $this->assertNull($recadvdate);
-        $this->assertNotInstanceOf("DateTime", $recadvdate);
     }
 
     public function testDocumentDeliveryNoteReferencedDocument(): void
     {
         self::$document->getDocumentDeliveryNoteReferencedDocument($deliverynoterefdocid, $deliverynoterefdocdate);
         $this->assertEquals("", $deliverynoterefdocid);
         $this->assertNull($deliverynoterefdocdate);
-        $this->assertNotInstanceOf("DateTime", $deliverynoterefdocdate);
     }
 
     public function testDocumentBillingPeriod(): void
     {
         self::$document->getDocumentBillingPeriod($docbillingperiodstart, $docbillingperiodend);
         $this->assertNull($docbillingperiodstart);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodstart);
         $this->assertNull($docbillingperiodend);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodend);
     }
 
     public function testDocumentAllowanceCharges(): void

diff --git a/tests/testcases/PdfReaderEn16931Test.php b/tests/testcases/PdfReaderEn16931Test.php
@@ -310,12 +310,10 @@ public function testDocumentShipToGeneral(): void
     {
         self::$document->getDocumentShipTo($shiptoname, $shiptoids, $shiptodescription);
         $this->assertNotNull($shiptoname);
-        $this->assertIsString($shiptoname);
         $this->assertEquals("", $shiptoname);
         $this->assertIsArray($shiptoids);
         $this->assertEmpty($shiptoids);
         $this->assertNotNull($shiptodescription);
-        $this->assertIsString($shiptodescription);
         $this->assertEquals("", $shiptodescription);
     }
 
@@ -780,32 +778,27 @@ public function testDocumentDespatchAdviceReferencedDocument(): void
         self::$document->getDocumentDespatchAdviceReferencedDocument($despatchdocid, $despatchdocdate);
         $this->assertEquals("", $despatchdocid);
         $this->assertNull($despatchdocdate);
-        $this->assertNotInstanceOf("DateTime", $despatchdocdate);
     }
 
     public function testDocumentReceivingAdviceReferencedDocument(): void
     {
         self::$document->getDocumentReceivingAdviceReferencedDocument($recadvid, $recadvdate);
         $this->assertEquals("", $recadvid);
         $this->assertNull($recadvdate);
-        $this->assertNotInstanceOf("DateTime", $recadvdate);
     }
 
     public function testDocumentDeliveryNoteReferencedDocument(): void
     {
         self::$document->getDocumentDeliveryNoteReferencedDocument($deliverynoterefdocid, $deliverynoterefdocdate);
         $this->assertEquals("", $deliverynoterefdocid);
         $this->assertNull($deliverynoterefdocdate);
-        $this->assertNotInstanceOf("DateTime", $deliverynoterefdocdate);
     }
 
     public function testDocumentBillingPeriod(): void
     {
         self::$document->getDocumentBillingPeriod($docbillingperiodstart, $docbillingperiodend);
         $this->assertNull($docbillingperiodstart);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodstart);
         $this->assertNull($docbillingperiodend);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodend);
     }
 
     public function testDocumentAllowanceCharges(): void

diff --git a/tests/testcases/PdfReaderExtended2Test.php b/tests/testcases/PdfReaderExtended2Test.php
@@ -780,23 +780,20 @@ public function testDocumentDespatchAdviceReferencedDocument(): void
         self::$document->getDocumentDespatchAdviceReferencedDocument($despatchdocid, $despatchdocdate);
         $this->assertEquals("DESPADV002", $despatchdocid);
         $this->assertNull($despatchdocdate);
-        $this->assertNotInstanceOf("DateTime", $despatchdocdate);
     }
 
     public function testDocumentReceivingAdviceReferencedDocument(): void
     {
         self::$document->getDocumentReceivingAdviceReferencedDocument($recadvid, $recadvdate);
         $this->assertEquals("RECEIV-ADV002", $recadvid);
         $this->assertNull($recadvdate);
-        $this->assertNotInstanceOf("DateTime", $recadvdate);
     }
 
     public function testDocumentDeliveryNoteReferencedDocument(): void
     {
         self::$document->getDocumentDeliveryNoteReferencedDocument($deliverynoterefdocid, $deliverynoterefdocdate);
         $this->assertEquals("", $deliverynoterefdocid);
         $this->assertNull($deliverynoterefdocdate);
-        $this->assertNotInstanceOf("DateTime", $deliverynoterefdocdate);
     }
 
     public function testDocumentBillingPeriod(): void

diff --git a/tests/testcases/PdfReaderExtendedTest.php b/tests/testcases/PdfReaderExtendedTest.php
@@ -795,32 +795,27 @@ public function testDocumentDespatchAdviceReferencedDocument(): void
         self::$document->getDocumentDespatchAdviceReferencedDocument($despatchdocid, $despatchdocdate);
         $this->assertEquals("", $despatchdocid);
         $this->assertNull($despatchdocdate);
-        $this->assertNotInstanceOf("DateTime", $despatchdocdate);
     }
 
     public function testDocumentReceivingAdviceReferencedDocument(): void
     {
         self::$document->getDocumentReceivingAdviceReferencedDocument($recadvid, $recadvdate);
         $this->assertEquals("", $recadvid);
         $this->assertNull($recadvdate);
-        $this->assertNotInstanceOf("DateTime", $recadvdate);
     }
 
     public function testDocumentDeliveryNoteReferencedDocument(): void
     {
         self::$document->getDocumentDeliveryNoteReferencedDocument($deliverynoterefdocid, $deliverynoterefdocdate);
         $this->assertEquals("L87654321012", $deliverynoterefdocid);
         $this->assertNull($deliverynoterefdocdate);
-        $this->assertNotInstanceOf("DateTime", $deliverynoterefdocdate);
     }
 
     public function testDocumentBillingPeriod(): void
     {
         self::$document->getDocumentBillingPeriod($docbillingperiodstart, $docbillingperiodend);
         $this->assertNull($docbillingperiodstart);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodstart);
         $this->assertNull($docbillingperiodend);
-        $this->assertNotInstanceOf("DateTime", $docbillingperiodend);
     }
 
     public function testDocumentAllowanceCharges(): void