simplified html document interface, removed superfluous events

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

Author: ma4nn

README.md

@@ -12,8 +12,7 @@ Internally it uses the DomPDF library for PDF generation and TCPDF for merging.
 $pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
 
 // Create the document. You can return any kind of HTML content here.
-$document = new \Vianetz\Pdf\Model\HtmlDocument();
-$document->setHtmlContents('<strong>Hello</strong> World!');
+$document = new \Vianetz\Pdf\Model\HtmlDocument('<strong>Hello</strong> World!');
 
 // Add our document to the pdf. You can add as many documents as you like
 // as they will all be merged into one PDF file.

src/Model/HtmlDocument.php

@@ -22,22 +22,22 @@
 class HtmlDocument implements HtmlDocumentInterface
 {
     private string $htmlContents;
-    private string $pdfBackgroundFile = '';
-    private string $pdfBackgroundFileForFirstPage = '';
+    private ?string $pdfBackgroundFile = null;
+    private ?string $pdfBackgroundFileForFirstPage = null;
 
-    public function setHtmlContents(string $htmlContents): self
+    public function __construct(string $htmlContents, ?string $pdfBackgroundFile = null, ?string $pdfBackgroundFileForFirstPage = null)
     {
         $this->htmlContents = $htmlContents;
-
-        return $this;
+        $this->pdfBackgroundFile = $pdfBackgroundFile;
+        $this->pdfBackgroundFileForFirstPage = $pdfBackgroundFileForFirstPage;
     }
 
     public function getHtmlContents(): string
     {
         return $this->htmlContents;
     }
 
-    public function getPdfBackgroundFile(): string
+    public function getPdfBackgroundFile(): ?string
     {
         return $this->pdfBackgroundFile;
     }
@@ -47,7 +47,7 @@ public function setPdfBackgroundFile(string $pdfBackgroundFile): void
         $this->pdfBackgroundFile = $pdfBackgroundFile;
     }
 
-    public function getPdfBackgroundFileForFirstPage(): string
+    public function getPdfBackgroundFileForFirstPage(): ?string
     {
         return $this->pdfBackgroundFileForFirstPage;
     }
@@ -56,9 +56,4 @@ public function setPdfBackgroundFileForFirstPage(string $pdfBackgroundFileForFir
     {
         $this->pdfBackgroundFileForFirstPage = $pdfBackgroundFileForFirstPage;
     }
-
-    public function getDocumentType(): string
-    {
-        return '';
-    }
 }

src/Model/HtmlDocumentInterface.php

@@ -23,13 +23,7 @@ interface HtmlDocumentInterface
 {
     public function getHtmlContents(): string;
 
-    public function getPdfBackgroundFile(): string;
+    public function getPdfBackgroundFile(): ?string;
 
-    public function setPdfBackgroundFile(string $pdfFile): void;
-
-    public function getPdfBackgroundFileForFirstPage(): string;
-
-    public function setPdfBackgroundFileForFirstPage(string $pdfFile): void;
-
-    public function getDocumentType(): string;
+    public function getPdfBackgroundFileForFirstPage(): ?string;
 }

src/Model/Pdf.php

@@ -134,20 +134,16 @@ private function renderPdfContentsForAllDocuments(): void
             $this->eventManager->dispatch('vianetz_pdf_document_render_before', ['document' => $documentInstance]);
 
             if ($documentInstance instanceof HtmlDocumentInterface) {
-                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_before', ['document' => $documentInstance]);
-
                 $pdfContents = $this->generator->renderPdfDocument($documentInstance);
                 if (empty($pdfContents)) {
                     continue;
                 }
 
                 $hasData = true;
 
-                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_after', ['document' => $documentInstance]);
-
                 $this->pdfMerge->mergePdfString($pdfContents, $documentInstance->getPdfBackgroundFile(), $documentInstance->getPdfBackgroundFileForFirstPage());
 
-                $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_merge_after', [
+                $this->eventManager->dispatch('vianetz_pdf_document_merge_after', [
                     'merger' => $this->pdfMerge,
                     'document' => $documentInstance,
                 ]);

src/Test/PdfTest.php

@@ -22,18 +22,18 @@
 use PHPUnit\Framework\TestCase;
 use Vianetz\Pdf\Model\Config;
 use Vianetz\Pdf\Model\Generator\AbstractGenerator;
+use Vianetz\Pdf\Model\HtmlDocument;
 use Vianetz\Pdf\Model\PdfFactory;
 use Vianetz\Pdf\NoDataException;
 
 final class PdfTest extends TestCase
 {
     private const TMP_DIR = './tmp_dir/';
 
-    private function getDocumentMock(): \Vianetz\Pdf\Model\HtmlDocument
+    private function getDocumentMock(): HtmlDocument
     {
         /** @var \Vianetz\Pdf\Model\HtmlDocument $document */
-        $document = new \Vianetz\Pdf\Model\HtmlDocument();
-        $document->setHtmlContents('<html><body>This is the <strong>pdf-generator</strong> test!</body></html>');
+        $document = new HtmlDocument('<html><body>This is the <strong>pdf-generator</strong> test!</body></html>');
 
         return $document;
     }