streamlined html and pdf document interfaces

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

Author: ma4nn

src/Model/DocumentInterface.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * @section LICENSE
+ * This file is created by vianetz <[email protected]>.
+ * The code is distributed under the GPL license.
+ *
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to [email protected] so we can send you a copy immediately.
+ *
+ * @package     Vianetz\Pdf
+ * @author      Christoph Massmann, <[email protected]>
+ * @link        https://www.vianetz.com
+ * @copyright   Copyright (c) since 2006 vianetz - Dipl.-Ing. C. Massmann (https://www.vianetz.com)
+ * @license     http://www.gnu.org/licenses/gpl-3.0.txt GNU GENERAL PUBLIC LICENSE
+ */
+
+namespace Vianetz\Pdf\Model;
+
+interface DocumentInterface
+{
+    public function getContents(): string;
+}

src/Model/Generator/AbstractGenerator.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * Pdf generator abstract class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -19,72 +19,37 @@
 
 namespace Vianetz\Pdf\Model\Generator;
 
+use Vianetz\Pdf\Model\Config;
 use Vianetz\Pdf\Model\GeneratorInterface;
 
 /**
- * Class Vianetz_Pdf_Model_Abstract
- *
  * A note on PDF merging:
  * - each generator instance generates the PDF of one source
  * - the merge() method in this class takes care of the merging of the single files
  * This is necessary because the documents may contain source dependent information in header/footer like invoice id,
  * addresses, etc. that cannot be determined correctly if you put all in one file.
  *
  * A note on naming convention:
- * - "document" means the PDF representation of a source that serves as input for the generator
+ * - "document" is the PDF contents of a source that serves as input for the generator (e.g. html string)
  */
 abstract class AbstractGenerator implements GeneratorInterface
 {
-    /** @var string */
-    const DEBUG_FILE_NAME = 'vianetz_pdf_generator_debug.html';
+    public const DEBUG_FILE_NAME = 'vianetz_pdf_generator_debug.html';
+    protected Config $config;
 
-    /** @var \Vianetz\Pdf\Model\Config $config */
-    protected $config;
-
-    /**
-     * Constructor initializes configuration values.
-     *
-     * @param \Vianetz\Pdf\Model\Config|null $config
-     */
-    public function __construct(\Vianetz\Pdf\Model\Config $config = null)
+    public function __construct(?Config $config = null)
     {
-        if (empty($config) === true) {
-            $config = new \Vianetz\Pdf\Model\Config();
-        }
-
-        $this->config = $config;
-
-        $this->initGenerator();
+        $this->config = $config ?? new Config();
     }
 
-    /**
-     * Initialize the generator instance.
-     *
-     * @return \Vianetz\Pdf\Model\Generator\AbstractGenerator
-     */
-    protected function initGenerator()
+    protected function replaceSpecialChars(string $htmlContents): string
     {
-        // By default we do nothing..
-        return $this;
-    }
-
-    /**
-     * Replace special characters for DomPDF library.
-     *
-     * @param string $htmlContents
-     *
-     * @return string
-     */
-    protected function replaceSpecialChars($htmlContents)
-    {
-        // Nothing to do at the moment.
-
         return $htmlContents;
     }
 
     protected function writeDebugFile(string $fileContents): bool
     {
-        if ($this->config->isDebugMode() === false) {
+        if (! $this->config->isDebugMode()) {
             return false;
         }
 

src/Model/Generator/Dompdf.php

@@ -67,7 +67,7 @@ protected function initPdf(): self
      */
     protected function getHtmlContentsForDocument(HtmlDocumentInterface $documentModel): string
     {
-        $htmlContents = $documentModel->getHtmlContents();
+        $htmlContents = $documentModel->getContents();
 
         $htmlContents = $this->replaceSpecialChars($htmlContents);
         $this->writeDebugFile($htmlContents);

src/Model/HtmlDocument.php

@@ -32,7 +32,7 @@ public function __construct(string $htmlContents, ?string $pdfBackgroundFile = n
         $this->pdfBackgroundFileForFirstPage = $pdfBackgroundFileForFirstPage;
     }
 
-    public function getHtmlContents(): string
+    public function getContents(): string
     {
         return $this->htmlContents;
     }
@@ -42,18 +42,8 @@ public function getPdfBackgroundFile(): ?string
         return $this->pdfBackgroundFile;
     }
 
-    public function setPdfBackgroundFile(string $pdfBackgroundFile): void
-    {
-        $this->pdfBackgroundFile = $pdfBackgroundFile;
-    }
-
     public function getPdfBackgroundFileForFirstPage(): ?string
     {
         return $this->pdfBackgroundFileForFirstPage;
     }
-
-    public function setPdfBackgroundFileForFirstPage(string $pdfBackgroundFileForFirstPage): void
-    {
-        $this->pdfBackgroundFileForFirstPage = $pdfBackgroundFileForFirstPage;
-    }
 }

src/Model/HtmlDocumentInterface.php

@@ -19,10 +19,8 @@
 
 namespace Vianetz\Pdf\Model;
 
-interface HtmlDocumentInterface
+interface HtmlDocumentInterface extends DocumentInterface
 {
-    public function getHtmlContents(): string;
-
     public function getPdfBackgroundFile(): ?string;
 
     public function getPdfBackgroundFileForFirstPage(): ?string;

src/Model/Merger/AbstractMerger.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * Pdf generator abstract class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.

src/Model/MergerInterface.php

@@ -2,8 +2,6 @@
 declare(strict_types=1);
 
 /**
- * Pdf merger interface class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.

src/Model/NullEventManager.php renamed to src/Model/NoneEventManager.php

@@ -19,7 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-final class NullEventManager implements EventManagerInterface
+final class NoneEventManager implements EventManagerInterface
 {
     /** {@inheritDoc} */
     public function dispatch(string $eventName, array $data = []): void

src/Model/Pdf.php

@@ -131,7 +131,10 @@ private function renderPdfContentsForAllDocuments(): void
     {
         $hasData = false;
         foreach ($this->documents as $documentInstance) {
-            $this->eventManager->dispatch('vianetz_pdf_document_render_before', ['document' => $documentInstance]);
+            $this->eventManager->dispatch('vianetz_pdf_document_render_before', [
+                'document' => $documentInstance,
+                'merger' => $this->pdfMerge,
+            ]);
 
             if ($documentInstance instanceof HtmlDocumentInterface) {
                 $pdfContents = $this->generator->renderPdfDocument($documentInstance);
@@ -142,16 +145,14 @@ private function renderPdfContentsForAllDocuments(): void
                 $hasData = true;
 
                 $this->pdfMerge->mergePdfString($pdfContents, $documentInstance->getPdfBackgroundFile(), $documentInstance->getPdfBackgroundFileForFirstPage());
-
-                $this->eventManager->dispatch('vianetz_pdf_document_merge_after', [
-                    'merger' => $this->pdfMerge,
-                    'document' => $documentInstance,
-                ]);
             } elseif ($documentInstance instanceof PdfDocumentInterface) {
-                $this->pdfMerge->mergePdfFile($documentInstance->getPdfFile());
+                $this->pdfMerge->mergePdfFile($documentInstance->getContents());
             }
 
-            $this->eventManager->dispatch('vianetz_pdf_document_render_after', ['document' => $documentInstance]);
+            $this->eventManager->dispatch('vianetz_pdf_document_render_after', [
+                'document' => $documentInstance,
+                'merger' => $this->pdfMerge,
+            ]);
         }
 
         if (! $hasData) {

src/Model/PdfDocument.php

@@ -19,17 +19,17 @@
 
 namespace Vianetz\Pdf\Model;
 
-final class PdfDocument implements PdfDocumentInterface
+class PdfDocument implements PdfDocumentInterface
 {
-    private string $pdfFile;
+    protected string $pdfFile;
 
-    public function getPdfFile(): string
+    public function __construct(string $pdfFile)
     {
-        return $this->pdfFile;
+        $this->pdfFile = $pdfFile;
     }
 
-    public function setPdfFile(string $pdfFile): void
+    public function getContents(): string
     {
-        $this->pdfFile = $pdfFile;
+        return $this->pdfFile;
     }
 }