Merge pull request #148 from horstoeko/Issue_147

#147 Added "setAttachmentRelationshipType" to ZugferdDocumentPdfBuild…
horstoeko · Oct 24, 2024 · 8180c5a · 8180c5a
2 parents 78a896e + 0da33d0
commit 8180c5a
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 9 deletions.
diff --git a/examples/En16931PdfBuilder.php b/examples/En16931PdfBuilder.php
@@ -31,8 +31,6 @@
     ->addNewPosition("1")
     ->setDocumentPositionNote("Bemerkung zu Zeile 1")
     ->setDocumentPositionProductDetails("Trennblätter A4", "", "TB100A4", null, "0160", "4012345001235")
-    ->addDocumentPositionProductCharacteristic("Farbe", "Gelb")
-    ->addDocumentPositionProductClassification("ClassCode", "ClassName", "ListId", "ListVersionId")
     ->setDocumentPositionProductOriginTradeCountry("CN")
     ->setDocumentPositionGrossPrice(9.9000)
     ->setDocumentPositionNetPrice(9.9000)
@@ -42,8 +40,6 @@
     ->addNewPosition("2")
     ->setDocumentPositionNote("Bemerkung zu Zeile 2")
     ->setDocumentPositionProductDetails("Joghurt Banane", "", "ARNR2", null, "0160", "4000050986428")
-    ->addDocumentPositionProductCharacteristic("Suesstoff", "Nein")
-    ->addDocumentPositionProductClassification("ClassCode", "ClassName", "ListId", "ListVersionId")
     ->SetDocumentPositionGrossPrice(5.5000)
     ->SetDocumentPositionNetPrice(5.5000)
     ->SetDocumentPositionQuantity(50, "H87")
@@ -59,4 +55,4 @@
 }
 
 $documentPdfBuilder = new ZugferdDocumentPdfBuilder($document, $existingPdf);
-$documentPdfBuilder->generateDocument()->saveDocument($mergeToPdf);
+$documentPdfBuilder->setAttachmentRelationshipType('Alternative')->generateDocument()->saveDocument($mergeToPdf);
diff --git a/src/ZugferdDocumentPdfBuilderAbstract.php b/src/ZugferdDocumentPdfBuilderAbstract.php
@@ -38,6 +38,13 @@ abstract class ZugferdDocumentPdfBuilderAbstract
      */
     private $additionalCreatorTool = "";
 
+    /**
+     * The relationship type to use for the XML attachment. Detault is Data
+     *
+     * @var string
+     */
+    private $attachmentRelationshipType = 'Data';
+
     /**
      * Instance of the pdfwriter
      *
@@ -68,7 +75,7 @@ public function __construct(string $pdfData)
     /**
      * Generates the final document
      *
-     * @return self
+     * @return static
      */
     public function generateDocument()
     {
@@ -83,7 +90,7 @@ public function generateDocument()
      * @param  string $toFilename
      * The full qualified filename to which the generated PDF (with attachment)
      * is stored
-     * @return self
+     * @return static
      */
     public function saveDocument(string $toFilename)
     {
@@ -119,7 +126,7 @@ public function downloadString(string $toFilename): string
      *
      * @param  string $additionalCreatorTool
      * The name of the creator
-     * @return self
+     * @return static
      */
     public function setAdditionalCreatorTool(string $additionalCreatorTool)
     {
@@ -136,12 +143,43 @@ public function setAdditionalCreatorTool(string $additionalCreatorTool)
     public function getCreatorToolName(): string
     {
         $toolName = sprintf('Factur-X PHP library v%s by HorstOeko', ZugferdPackageVersion::getInstalledVersion());
+
         if ($this->additionalCreatorTool) {
             return $this->additionalCreatorTool . ' / ' . $toolName;
         }
+
         return $toolName;
     }
 
+    /**
+     * Set the type of relationship for the XML attachment. Allowed
+     * types are 'Data', 'Alternative'
+     *
+     * @param  string $relationshipType
+     * @return static
+     */
+    public function setAttachmentRelationshipType(string $relationshipType)
+    {
+        if (!in_array($relationshipType, ['Data', 'Alternative'])) {
+            $relationshipType = 'Data';
+        }
+
+        $this->attachmentRelationshipType = $relationshipType;
+
+        return $this;
+    }
+
+    /**
+     * Returns the relationship type for the XML attachment. This
+     * can return 'Data', 'Alternative'
+     *
+     * @return string
+     */
+    public function getAttachmentRelationshipType(): string
+    {
+        return $this->attachmentRelationshipType;
+    }
+
     /**
      * Get the content of XML to attach
      *
@@ -190,7 +228,7 @@ private function startCreatePdf(): void
             $documentBuilderXmlDataRef,
             $this->getXmlAttachmentFilename(),
             'Factur-X Invoice',
-            'Data',
+            $this->getAttachmentRelationshipType(),
             'text#2Fxml'
         );