further improved interfaces

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

Author: ma4nn

src/Model/PdfInterface.php renamed to src/Model/CanSave.php

@@ -19,11 +19,8 @@
 
 namespace Vianetz\Pdf\Model;
 
-interface PdfInterface
+interface CanSave
 {
-    /** @throws \Vianetz\Pdf\NoDataException */
-    public function getContents(): string;
-
     /**
      * @api
      * @return bool true in case of success

src/Model/Generator/AbstractGenerator.php

@@ -20,7 +20,7 @@
 namespace Vianetz\Pdf\Model\Generator;
 
 use Vianetz\Pdf\Model\Config;
-use Vianetz\Pdf\Model\GeneratorInterface;
+use Vianetz\Pdf\Model\Pdfable;
 
 /**
  * A note on PDF merging:
@@ -32,21 +32,18 @@
  * A note on naming convention:
  * - "document" is the PDF contents of a source that serves as input for the generator (e.g. html string)
  */
-abstract class AbstractGenerator implements GeneratorInterface
+abstract class AbstractGenerator implements Pdfable // @todo rename Generator to Converter
 {
     public const DEBUG_FILE_NAME = 'vianetz_pdf_generator_debug.html';
     protected Config $config;
 
+    abstract public function convert(string $html): self;
+
     public function __construct(?Config $config = null)
     {
         $this->config = $config ?? new Config();
     }
 
-    protected function replaceSpecialChars(string $htmlContents): string
-    {
-        return $htmlContents;
-    }
-
     protected function writeDebugFile(string $fileContents): bool
     {
         if (! $this->config->isDebugMode()) {

src/Model/Generator/Dompdf.php

@@ -19,8 +19,6 @@
 
 namespace Vianetz\Pdf\Model\Generator;
 
-use Vianetz\Pdf\Model\HtmlDocumentInterface;
-
 /**
  * Known limitations of Dompdf:
  * - colspan is not working properly (table is moved to the top of the page)
@@ -36,15 +34,22 @@ final class Dompdf extends AbstractGenerator
     private \Dompdf\Dompdf $domPdf;
 
     /** @throws \Exception */
-    public function renderPdfDocument(HtmlDocumentInterface $documentModel): string
+    public function convert(string $html): self
     {
+        $this->writeDebugFile($html);
+
         $this->initPdf();
 
-        $this->domPdf->loadHtml($this->getHtmlContentsForDocument($documentModel));
+        $this->domPdf->loadHtml($html);
         $this->domPdf->render();
 
         $this->injectPageCount();
 
+        return $this;
+    }
+
+    public function toPdf(): string
+    {
         return $this->domPdf->output() ?? '';
     }
 
@@ -60,21 +65,6 @@ protected function initPdf(): self
         return $this;
     }
 
-    /**
-     * Return HTML contents for one single document that is later merged with the others.
-     *
-     * @throws \Exception
-     */
-    protected function getHtmlContentsForDocument(HtmlDocumentInterface $documentModel): string
-    {
-        $htmlContents = $documentModel->getContents();
-
-        $htmlContents = $this->replaceSpecialChars($htmlContents);
-        $this->writeDebugFile($htmlContents);
-
-        return $htmlContents;
-    }
-
     /**
      * @see \Dompdf\Options
      *

src/Model/GeneratorInterface.php

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

src/Model/HtmlDocumentInterface.php renamed to src/Model/HasBackgroundPdf.php

@@ -19,7 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-class HtmlDocument implements HtmlDocumentInterface
+class HtmlDocument implements HasBackgroundPdf, Htmlable
 {
     private string $htmlContents;
     private ?string $pdfBackgroundFile = null;
@@ -32,7 +32,7 @@ public function __construct(string $htmlContents, ?string $pdfBackgroundFile = n
         $this->pdfBackgroundFileForFirstPage = $pdfBackgroundFileForFirstPage;
     }
 
-    public function getContents(): string
+    public function toHtml(): string
     {
         return $this->htmlContents;
     }

src/Model/HtmlDocument.php

@@ -19,6 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-interface PdfDocumentInterface extends DocumentInterface
+interface Htmlable
 {
+    public function toHtml(): string;
 }

src/Model/PdfDocumentInterface.php renamed to src/Model/Htmlable.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * FPDI Merger class
- *
  * This class is responsible for merging individual PDF documents and eventually adding the background PDF template file.
  *
  * @section LICENSE
@@ -22,35 +22,30 @@
 namespace Vianetz\Pdf\Model\Merger;
 
 use setasign\Fpdi\PdfParser\StreamReader;
-use setasign\Fpdi\Tcpdf\Fpdi as FpdiModel;
+use setasign\Fpdi\Tcpdf\Fpdi as TcpdfFpdi;
 use Vianetz\Pdf\Model\Config;
 
 final class Fpdi extends AbstractMerger
 {
-    /** @var string */
     private const OUTPUT_MODE_STRING = 'S';
-
-    /** @var string */
     private const OUTPUT_FORMAT_LANDSCAPE = 'L';
-
-    /** @var string */
     private const OUTPUT_FORMAT_PORTRAIT = 'P';
 
-    private FpdiModel $fpdiModel;
+    private TcpdfFpdi $fpdiModel;
     private string $orientation = self::OUTPUT_FORMAT_PORTRAIT;
     private string $paper = 'a4';
 
-    public function __construct(?\Vianetz\Pdf\Model\Config $config = null)
+    public function __construct(?Config $config = null)
     {
-        $config ??= new \Vianetz\Pdf\Model\Config();
+        $config ??= new Config();
 
         if ($config->getPdfOrientation() === Config::PAPER_ORIENTATION_PORTRAIT) {
             $this->orientation = self::OUTPUT_FORMAT_PORTRAIT;
         } elseif ($config->getPdfOrientation() === Config::PAPER_ORIENTATION_LANDSCAPE) {
             $this->orientation = self::OUTPUT_FORMAT_LANDSCAPE;
         }
 
-        $this->fpdiModel = new FpdiModel($this->orientation, 'mm', $this->paper);
+        $this->fpdiModel = new TcpdfFpdi($this->orientation, 'mm', $this->paper);
 
         $this->fpdiModel->SetAuthor($config->getPdfAuthor());
         $this->fpdiModel->SetTitle($config->getPdfTitle());
@@ -81,7 +76,7 @@ public function importPageFromPdfString(string $pdfString, int $pageNumber): voi
         $this->importPageFromFile($this->createPdfStream($pdfString), $pageNumber);
     }
 
-    public function getPdfContents(): string
+    public function toPdf(): string
     {
         return $this->fpdiModel->Output('', self::OUTPUT_MODE_STRING);
     }

src/Model/Merger/Fpdi.php

@@ -21,10 +21,8 @@
 
 use setasign\Fpdi\PdfParser\StreamReader;
 
-interface MergerInterface
+interface MergerInterface extends Pdfable
 {
-    public function getPdfContents(): string;
-
     /** @param string|resource|StreamReader $file */
     public function importPageFromFile($file, int $pageNumber): void;
 

src/Model/MergerInterface.php

@@ -8,7 +8,7 @@
  * Usage:
  * 1) Instantiate (optionally with your custom generator class)
  * 2) addDocument($document)
- * 3) getContents() or saveToFile()
+ * 3) toPdf() or saveToFile()
  *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
@@ -27,18 +27,20 @@
 
 namespace Vianetz\Pdf\Model;
 
+use Vianetz\Pdf\Exception;
+use Vianetz\Pdf\Model\Generator\AbstractGenerator;
 use Vianetz\Pdf\NoDataException;
 
-class Pdf implements PdfInterface
+class Pdf implements CanSave, Pdfable
 {
-    private GeneratorInterface $generator;
+    private AbstractGenerator $generator;
     private PdfMerge $pdfMerge;
-    private ?string $contents = null;
+    private ?string $pdfContents = null;
 
     /**
      * Initialize empty array for PDF documents to print.
      *
-     * @var array<\Vianetz\Pdf\Model\HtmlDocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface>
+     * @var list<\Vianetz\Pdf\Model\Pdfable|\Vianetz\Pdf\Model\Htmlable>
      */
     private array $documents = [];
 
@@ -53,7 +55,7 @@ class Pdf implements PdfInterface
     final public function __construct(
         Config $config,
         EventManagerInterface $eventManager,
-        GeneratorInterface $generator,
+        AbstractGenerator $generator,
         MergerInterface $merger
     ) {
         $this->generator = $generator;
@@ -63,36 +65,35 @@ final public function __construct(
     }
 
     /** {@inheritDoc} */
-    final public function getContents(): string
+    final public function toPdf(): string
     {
-        if ($this->contents === null) {
+        if ($this->pdfContents === null) {
             $this->renderPdfContentsForAllDocuments();
-            $this->contents = $this->pdfMerge->getContents();
+            $this->pdfContents = $this->pdfMerge->toPdf();
         }
 
-        return $this->contents;
+        $this->eventManager->dispatch('vianetz_pdf_get_contents', ['contents' => $this->pdfContents]);
+
+        return $this->pdfContents;
     }
 
     /** {@inheritDoc} */
     final public function saveToFile(string $fileName): bool
     {
-        $pdfContents = $this->getContents();
+        $pdfContents = $this->toPdf();
 
         return @file_put_contents($fileName, $pdfContents) !== false;
     }
 
     /**
-     * Add a new document to generate.
-     *
-     * @param \Vianetz\Pdf\Model\HtmlDocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface $documentModel
-     *
      * @api
+     * @param \Vianetz\Pdf\Model\Pdfable|\Vianetz\Pdf\Model\Htmlable $documentModel
      */
     final public function addDocument($documentModel): self
     {
         $this->documents[] = $documentModel;
         // Reset cached pdf contents.
-        $this->contents = null;
+        $this->pdfContents = null;
 
         return $this;
     }
@@ -114,7 +115,7 @@ final public function countDocuments(): int
      */
     final public function render(): string
     {
-        return $this->getContents();
+        return $this->toPdf();
     }
 
     public function getConfig(): Config
@@ -125,7 +126,7 @@ public function getConfig(): Config
     /**
      * Return merged pdf contents of all documents and save it to single temporary files.
      *
-     * @throws \Vianetz\Pdf\NoDataException
+     * @throws \Vianetz\Pdf\NoDataException|\Vianetz\Pdf\Exception
      */
     private function renderPdfContentsForAllDocuments(): void
     {
@@ -136,19 +137,25 @@ private function renderPdfContentsForAllDocuments(): void
                 'merger' => $this->pdfMerge,
             ]);
 
-            if ($documentInstance instanceof HtmlDocumentInterface) {
-                $pdfContents = $this->generator->renderPdfDocument($documentInstance);
+            if ($documentInstance instanceof Htmlable) {
+                $pdfContents = $this->generator->convert($documentInstance->toHtml())->toPdf();
                 if (empty($pdfContents)) {
                     continue;
                 }
+            } elseif ($documentInstance instanceof Pdfable) {
+                $pdfContents = $documentInstance->toPdf();
+            } else {
+                throw new Exception('invalid document type');
+            }
 
-                $hasData = true;
-
+            if ($documentInstance instanceof HasBackgroundPdf) {
                 $this->pdfMerge->mergePdfString($pdfContents, $documentInstance->getPdfBackgroundFile(), $documentInstance->getPdfBackgroundFileForFirstPage());
-            } elseif ($documentInstance instanceof PdfDocumentInterface) {
-                $this->pdfMerge->mergePdfFile($documentInstance->getContents());
+            } else {
+                $this->pdfMerge->mergePdfString($pdfContents);
             }
 
+            $hasData = true;
+
             $this->eventManager->dispatch('vianetz_pdf_document_render_after', [
                 'document' => $documentInstance,
                 'merger' => $this->pdfMerge,