Merge pull request #36 from horstoeko/kositvalidator

Prototype of the ZugferdKositValidator-Class. At present, this feature is still to be considered experimental.

.gitignore

@@ -64,7 +64,7 @@ _backup*
 /nbproject/
 
 !/setup/.htaccess
-.vscode 
+.vscode
 .idea
 
 /vendor/
@@ -83,4 +83,6 @@ _backup*
 /composer.lock
 /examples/fullpdf.pdf
 /examples/factur-x.xml
+/examples/filetovalidate-report.xml
+/examples/filetovalidate-report.html
 myfile_dbg.xml

README.md

@@ -424,3 +424,7 @@ $mergeToPdf = dirname(__FILE__) . "/fullpdf.pdf";
 
 (new ZugferdDocumentPdfMerger($existingXml, $existingPdf))->generateDocument()->saveDocument($mergeToPdf);
 ```
+
+### Validation
+
+This library offers several options for checking and validating a document. Please visit the corresponding page in our [Wiki](https://github.com/horstoeko/zugferd/wiki/Validation).

composer.json

@@ -41,6 +41,7 @@
         "setasign/fpdf": "^1",
         "setasign/fpdi": "^2",
         "symfony/yaml": "^5|^6",
+        "symfony/process": "^5|^6",
         "horstoeko/stringmanagement": "^1",
         "horstoeko/mimedb": "^1"
     },

examples/KositValidator.php

@@ -0,0 +1,56 @@
+<?php
+
+use horstoeko\zugferd\ZugferdDocumentReader;
+use horstoeko\zugferd\ZugferdKositValidator;
+use horstoeko\zugferd\ZugferdDocumentPdfReader;
+
+require dirname(__FILE__) . "/../vendor/autoload.php";
+
+/**
+ * Helper function for outputting the errors
+ *
+ * @param ZugferdKositValidator $kositValidator
+ * @return void
+ */
+function showValidationResult(ZugferdKositValidator $kositValidator)
+{
+    if ($kositValidator->hasProcessErrors()) {
+        echo "\033[01;31mProcess failed\e[0m\n";
+        foreach ($kositValidator->getProcessErrors() as $processError) {
+            echo " - " . $processError["message"] . PHP_EOL;
+        }
+    } elseif ($kositValidator->hasValidationErrors()) {
+        echo "\033[01;31mValidation failed\e[0m\n";
+        foreach ($kositValidator->getValidationErrors() as $validationError) {
+            echo " - " . $validationError["message"] . PHP_EOL;
+        }
+    } else {
+        echo "\033[01;32mValidation passed\e[0m\n";
+    }
+}
+
+/* ----------------------------------------------------------------------------------
+   - Get instance of the Validator
+   ---------------------------------------------------------------------------------- */
+
+$kositValidator = new ZugferdKositValidator();
+
+/* ----------------------------------------------------------------------------------
+   - Validation of a document read by ZugferdDocumentPdfReader
+   ---------------------------------------------------------------------------------- */
+
+$document = ZugferdDocumentPdfReader::readAndGuessFromFile(dirname(__FILE__) . "/invoice_1.pdf");
+$kositValidator->setDocument($document)->disableCleanup()->validate();
+
+showValidationResult($kositValidator);
+
+/* ----------------------------------------------------------------------------------
+   - Validation of a document read by ZugferdDocumentReader
+   ---------------------------------------------------------------------------------- */
+
+$document = ZugferdDocumentReader::readAndGuessFromFile(dirname(__FILE__) . "/../tests/assets/en16931_simple_invalid.xml");
+
+$kositValidator = new ZugferdKositValidator($document);
+$kositValidator->setDocument($document)->disableCleanup()->validate();
+
+showValidationResult($kositValidator);