replaced logic for attachment file with a separate pdf document

Signed-off-by: Christoph Massmann <[email protected]>

Author: ma4nn

src/Model/Document.php

@@ -21,26 +21,15 @@
 
 class Document implements DocumentInterface
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     private $htmlContents;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     private $pdfBackgroundFile = '';
 
-    /**
-     * @var string
-     */
+    /** @var string */
     private $pdfBackgroundFileForFirstPage = '';
 
-    /**
-     * @var string
-     */
-    private $pdfAttachmentFile = '';
-
     /**
      * @param string $htmlContents
      *
@@ -94,23 +83,6 @@ public function setPdfBackgroundFileForFirstPage($pdfFile)
         $this->pdfBackgroundFileForFirstPage = $pdfFile;
     }
 
-    /**
-     * @return string
-     */
-    public function getPdfAttachmentFile()
-    {
-        return $this->pdfAttachmentFile;
-    }
-
-    /**
-     * @param string $pdfFile
-     * @return void
-     */
-    public function setPdfAttachmentFile($pdfFile)
-    {
-        $this->pdfAttachmentFile = $pdfFile;
-    }
-
     /**
      * @return string
      */

src/Model/DocumentInterface.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * Pdf document interface class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -20,7 +18,7 @@
 namespace Vianetz\Pdf\Model;
 
 /**
- * Interface DocumentInterface
+ * @todo rename to HtmlDocumentInterface
  */
 interface DocumentInterface
 {
@@ -53,17 +51,6 @@ public function getPdfBackgroundFileForFirstPage();
      */
     public function setPdfBackgroundFileForFirstPage($pdfFile);
 
-    /**
-     * @return string
-     */
-    public function getPdfAttachmentFile();
-
-    /**
-     * @param string $pdfFile
-     * @return void
-     */
-    public function setPdfAttachmentFile($pdfFile);
-
     /**
      * @return string
      */

src/Model/Pdf.php

@@ -36,9 +36,7 @@ class Pdf implements PdfInterface
      */
     private $generator;
 
-    /**
-     * @var \Vianetz\Pdf\Model\PdfMerge
-     */
+    /** @var \Vianetz\Pdf\Model\PdfMerge */
     private $pdfMerge;
 
     /**
@@ -51,18 +49,14 @@ class Pdf implements PdfInterface
     /**
      * Initialize empty array for PDF documents to print.
      *
-     * @var array<\Vianetz\Pdf\Model\DocumentInterface>
+     * @var array<\Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface>
      */
-    private $documents = array();
+    private $documents = [];
 
-    /**
-     * @var Config
-     */
+    /** @var Config */
     protected $config;
 
-    /**
-     * @var \Vianetz\Pdf\Model\EventManagerInterface
-     */
+    /** @var \Vianetz\Pdf\Model\EventManagerInterface */
     protected $eventManager;
 
     /**
@@ -108,10 +102,12 @@ final public function saveToFile($fileName)
     /**
      * Add a new document to generate.
      *
+     * @param \Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface
+     *
      * @api
      * @return Pdf
      */
-    final public function addDocument(DocumentInterface $documentModel)
+    final public function addDocument($documentModel)
     {
         $this->documents[] = $documentModel;
         // Reset cached pdf contents.
@@ -162,30 +158,31 @@ private function renderPdfContentsForAllDocuments()
     {
         $hasData = false;
         foreach ($this->documents as $documentInstance) {
-            if (! $documentInstance instanceof DocumentInterface) {
-                continue;
-            }
-
             $this->eventManager->dispatch('vianetz_pdf_document_render_before', ['document' => $documentInstance]);
-            $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_before', ['document' => $documentInstance]);
 
-            $pdfContents = $this->generator->renderPdfDocument($documentInstance);
-            if (empty($pdfContents)) {
-                continue;
-            }
+            if ($documentInstance instanceof DocumentInterface) {
+                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_before', ['document' => $documentInstance]);
 
-            $hasData = true;
+                $pdfContents = $this->generator->renderPdfDocument($documentInstance);
+                if (empty($pdfContents)) {
+                    continue;
+                }
 
-            $this->eventManager->dispatch('vianetz_pdf_document_render_after', ['document' => $documentInstance]);
-            $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_after', ['document' => $documentInstance]);
+                $hasData = true;
+
+                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_after', ['document' => $documentInstance]);
 
-            $this->pdfMerge->mergePdfString($pdfContents, $documentInstance->getPdfBackgroundFile(), $documentInstance->getPdfBackgroundFileForFirstPage());
+                $this->pdfMerge->mergePdfString($pdfContents, $documentInstance->getPdfBackgroundFile(), $documentInstance->getPdfBackgroundFileForFirstPage());
 
-            if (! empty($documentInstance->getPdfAttachmentFile())) {
-                $this->pdfMerge->mergePdfFile($documentInstance->getPdfAttachmentFile());
+                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_merge_after', [
+                    'merger' => $this->pdfMerge,
+                    'document' => $documentInstance,
+                ]);
+            } elseif ($documentInstance instanceof PdfDocumentInterface) {
+                $this->pdfMerge->mergePdfFile($documentInstance->getPdfFile());
             }
 
-            $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_merge_after', ['merger' => $this->pdfMerge, 'document' => $documentInstance]);
+            $this->eventManager->dispatch('vianetz_pdf_document_render_after', ['document' => $documentInstance]);
         }
 
         if (! $hasData) {

src/Model/PdfDocument.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Vianetz\Pdf\Model;
+
+final class PdfDocument implements PdfDocumentInterface
+{
+    /** @var string */
+    private $pdfFile;
+
+    public function getPdfFile()
+    {
+        return $this->pdfFile;
+    }
+
+    public function setPdfFile($pdfFile)
+    {
+        $this->pdfFile = $pdfFile;
+    }
+}

src/Test/DocumentTest.php renamed to src/Model/PdfDocumentInterface.php

@@ -15,21 +15,18 @@
  * @license     http://www.gnu.org/licenses/gpl-3.0.txt GNU GENERAL PUBLIC LICENSE
  */
 
-namespace Vianetz\Pdf\Test;
+namespace Vianetz\Pdf\Model;
 
-use PHPUnit\Framework\TestCase;
-use Vianetz\Pdf\Model\Document;
-
-final class DocumentTest extends TestCase
+interface PdfDocumentInterface
 {
     /**
-     * @return void
+     * @return string
      */
-    public function testSetPdfAttachmentFile()
-    {
-        $document = new Document();
-        $document->setPdfAttachmentFile('attachment1.pdf');
+    public function getPdfFile();
 
-        $this->assertEquals('attachment1.pdf', $document->getPdfAttachmentFile());
-    }
-}
+    /**
+     * @param string $pdfFile
+     * @return void
+     */
+    public function setPdfFile($pdfFile);
+}