[CS] Code Cleanup

horstoeko · Jan 18, 2025 · a5c8026 · a5c8026
1 parent 5381433
commit a5c8026
Show file tree

Hide file tree

Showing 18 changed files with 223 additions and 53 deletions.
diff --git a/build/phprectorconfig.php b/build/phprectorconfig.php
@@ -29,9 +29,9 @@
     ->withPhp73Sets()
     ->withPreparedSets(
         codeQuality: true,
+        codingStyle: true,
         //
         carbon: false,
-        codingStyle: false,
         deadCode: false,
         doctrineCodeQuality: false,
         earlyReturn: false,

diff --git a/examples/02_ZugferdDocumentPdfBuilder_EN16931.php b/examples/02_ZugferdDocumentPdfBuilder_EN16931.php
@@ -185,13 +185,16 @@
     function ($which) {
         if ($which === 'title') {
             return "DummyTitle";
-        }
+        }
+
         if ($which === 'author') {
             return "DummyAuthor";
-        }
+        }
+
         if ($which === 'subject') {
             return "DummySubject";
-        }
+        }
+
         if ($which === 'keywords') {
             return "DummyKeywords";
         }

diff --git a/examples/02_ZugferdDocumentPdfBuilder_XRECHNUNG.php b/examples/02_ZugferdDocumentPdfBuilder_XRECHNUNG.php
@@ -185,13 +185,16 @@
     function ($which) {
         if ($which === 'title') {
             return "DummyTitle";
-        }
+        }
+
         if ($which === 'author') {
             return "DummyAuthor";
-        }
+        }
+
         if ($which === 'subject') {
             return "DummySubject";
-        }
+        }
+
         if ($which === 'keywords') {
             return "DummyKeywords";
         }

diff --git a/make/genchangelog.php b/make/genchangelog.php
diff --git a/make/gencodelists.php b/make/gencodelists.php
@@ -82,6 +82,7 @@ function strIdentifier(string $str, bool $shortIdentifier): string
     $str = str_replace("\t", "", $str);
     $str = strtoupper($str);
     $str = preg_replace("/[^A-Za-z0-9\s]/", "", $str);
+
     $strArray = explode(" ", $str);
     if (count($strArray) == 1) {
         $strNew = $strArray[0];
@@ -90,13 +91,15 @@ function strIdentifier(string $str, bool $shortIdentifier): string
             if ($strNew !== "") {
                 $strNew .= "_";
             }
+
             if ($shortIdentifier) {
                 $strNew .= substr($item, 0, 4);
             } else {
                 $strNew .= $item;
             }
         }
     }
+
     $strNew = preg_replace('/__+/', '_', $strNew);
     $strNew = preg_replace('~\d~', '', $strNew, 5);
     $strNew = rtrim(ltrim($strNew, "_"), "_");

diff --git a/make/genmethoddocs.php b/make/genmethoddocs.php
@@ -200,6 +200,7 @@ public function getArray(): array
                     foreach ($types as $type) {
                         $parameterTypeString .= $type->getName() . '|';
                     }
+
                     $parameterTypeString = rtrim($parameterTypeString, '|');
                 } elseif ($parameterType instanceof ReflectionNamedType) {
                     $parameterTypeString = $parameterType->getName();
@@ -672,9 +673,11 @@ private function fixPhpType(string $string): string
         if (stripos($string, '[]') !== false) {
             $string = 'array';
         }
+
         if (stripos($string, 'array<') === 0) {
             $string = 'array';
         }
+
         if ($string === '$this') {
             $string = 'static';
         }
@@ -736,38 +739,38 @@ public static function generate(array $classes, array $ignoreInheritance = [])
     ZugferdQuickDescriptorXRechnung2::class => __DIR__ . '/Class-ZugferdQuickDescriptorXRechnung2.md',
     ZugferdQuickDescriptorXRechnung3::class => __DIR__ . '/Class-ZugferdQuickDescriptorXRechnung3.md',
 ], [
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::generateDocument',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::generateDocument',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::saveDocument',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::saveDocument',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::saveDocumentInline',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::saveDocumentInline',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::downloadString',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::downloadString',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAdditionalCreatorTool',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAdditionalCreatorTool',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAttachmentRelationshipType',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAttachmentRelationshipType',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAttachmentRelationshipTypeToData',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAttachmentRelationshipTypeToData',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAttachmentRelationshipTypeToAlternative',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAttachmentRelationshipTypeToAlternative',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAttachmentRelationshipTypeToSource',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAttachmentRelationshipTypeToSource',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::attachAdditionalFileByRealFile',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::attachAdditionalFileByRealFile',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::attachAdditionalFileByContent',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::attachAdditionalFileByContent',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setDeterministicModeEnabled',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setDeterministicModeEnabled',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setAuthorTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setAuthorTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setKeywordTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setKeywordTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setTitleTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setTitleTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setSubjectTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setSubjectTemplate',
-    'horstoeko\zugferd\ZugferdDocumentPdfBuilder::setMetaInformationCallback',
-    'horstoeko\zugferd\ZugferdDocumentPdfMerger::setMetaInformationCallback',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::generateDocument',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::generateDocument',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::saveDocument',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::saveDocument',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::saveDocumentInline',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::saveDocumentInline',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::downloadString',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::downloadString',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAdditionalCreatorTool',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAdditionalCreatorTool',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAttachmentRelationshipType',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAttachmentRelationshipType',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAttachmentRelationshipTypeToData',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAttachmentRelationshipTypeToData',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAttachmentRelationshipTypeToAlternative',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAttachmentRelationshipTypeToAlternative',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAttachmentRelationshipTypeToSource',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAttachmentRelationshipTypeToSource',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::attachAdditionalFileByRealFile',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::attachAdditionalFileByRealFile',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::attachAdditionalFileByContent',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::attachAdditionalFileByContent',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setDeterministicModeEnabled',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setDeterministicModeEnabled',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setAuthorTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setAuthorTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setKeywordTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setKeywordTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setTitleTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setTitleTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setSubjectTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setSubjectTemplate',
+    \horstoeko\zugferd\ZugferdDocumentPdfBuilder::class . '::setMetaInformationCallback',
+    \horstoeko\zugferd\ZugferdDocumentPdfMerger::class . '::setMetaInformationCallback',
 ]);
diff --git a/src/ZugferdDocumentBuilder.php b/src/ZugferdDocumentBuilder.php
@@ -271,6 +271,7 @@ public function setForeignCurrency(string $foreignCurrencyCode, float $foreignTa
             if ($this->getObjectHelper()->tryCallAndReturn($taxTotalAmount, "getCurrencyID") == $invoiceCurrencyCode) {
                 $taxTotalAmountInvoice = $taxTotalAmount;
             }
+
             if ($this->getObjectHelper()->tryCallAndReturn($taxTotalAmount, "getCurrencyID") == $foreignCurrencyCode) {
                 $taxTotalAmountForeign = $taxTotalAmount;
             }
@@ -2501,6 +2502,7 @@ public function setDocumentSummation(float $grandTotalAmount, float $duePayableA
             $invoiceCurrencyCode = $this->getObjectHelper()->tryCallByPathAndReturn($this->headerTradeSettlement, "getInvoiceCurrencyCode.value");
             $this->getObjectHelper()->tryCall($taxTotalAmount[0], 'setCurrencyID', $invoiceCurrencyCode);
         }
+
         return $this;
     }
 

diff --git a/src/ZugferdDocumentPdfBuilderAbstract.php b/src/ZugferdDocumentPdfBuilderAbstract.php
@@ -43,9 +43,13 @@ abstract class ZugferdDocumentPdfBuilderAbstract
      * 'Data', 'Alternative', 'Source', 'Supplement', 'Unspecified'
      */
     public const AF_RELATIONSHIP_DATA = "Data";
+
     public const AF_RELATIONSHIP_ALTERNATIVE = "Alternative";
+
     public const AF_RELATIONSHIP_SOURCE = "Source";
+
     public const AF_RELATIONSHIP_SUPPLEMENT = "Supplement";
+
     public const AF_RELATIONSHIP_UNSPECIFIED = "Unspecified";
 
     /**
@@ -566,6 +570,7 @@ private function updatePdfMetadata(): void
         $descNodes->title->children('rdf', true)->Alt->li = $pdfMetadataInfos['title'];
         $descNodes->creator->children('rdf', true)->Seq->li = $pdfMetadataInfos['author'];
         $descNodes->description->children('rdf', true)->Alt->li = $pdfMetadataInfos['subject'];
+
         $this->pdfWriter->addMetadataDescriptionNode($descDc->asXML());
 
         $descAdobe = $descriptionNodes[4];
@@ -668,7 +673,7 @@ private function isFile($pdfData): bool
     {
         try {
             return @is_file($pdfData);
-        } catch (Throwable $ex) {
+        } catch (Throwable $throwable) {
             return false;
         }
     }

diff --git a/src/ZugferdDocumentPdfMerger.php b/src/ZugferdDocumentPdfMerger.php
@@ -108,7 +108,7 @@ private function xmlDataIsFile(): bool
     {
         try {
             return @is_file($this->xmlDataOrFilename);
-        } catch (\TypeError $ex) {
+        } catch (\TypeError $typeError) {
             return false;
         }
     }