improved code style and used more typehints

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

Author: ma4nn

README.md

@@ -5,13 +5,14 @@ Internally it uses the DomPDF library for PDF generation and TCPDF for merging.
 
 ## Usage
 
-### Create PDF document from HTML contents 
+### Create PDF document from HTML contents
+
 ```php
 // Create a new pdf instance.
 $pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
 
 // Create the document. You can return any kind of HTML content here.
-$document = new \Vianetz\Pdf\Model\Document();
+$document = new \Vianetz\Pdf\Model\HtmlDocument();
 $document->setHtmlContents('<strong>Hello</strong> World!');
 
 // Add our document to the pdf. You can add as many documents as you like

src/Model/EventManagerInterface.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * Event manager interface class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -27,9 +27,7 @@ interface EventManagerInterface
      * Calls all observer callbacks registered for this event
      * and multiple observers matching event name pattern
      *
-     * @param string $eventName
      * @param array<mixed,mixed> $data
-     * @return void
      */
-    public function dispatch($eventName, array $data = []);
+    public function dispatch(string $eventName, array $data = []): void;
 }

src/Model/Generator/Dompdf.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
@@ -17,7 +19,7 @@
 
 namespace Vianetz\Pdf\Model\Generator;
 
-use Vianetz\Pdf\Model\DocumentInterface;
+use Vianetz\Pdf\Model\HtmlDocumentInterface;
 
 /**
  * Known limitations of Dompdf:
@@ -34,7 +36,7 @@ final class Dompdf extends AbstractGenerator
     private \Dompdf\Dompdf $domPdf;
 
     /** @throws \Exception */
-    public function renderPdfDocument(DocumentInterface $documentModel): ?string
+    public function renderPdfDocument(HtmlDocumentInterface $documentModel): string
     {
         $this->initPdf();
 
@@ -43,7 +45,7 @@ public function renderPdfDocument(DocumentInterface $documentModel): ?string
 
         $this->injectPageCount();
 
-        return $this->domPdf->output();
+        return $this->domPdf->output() ?? '';
     }
 
     protected function initPdf(): self
@@ -63,7 +65,7 @@ protected function initPdf(): self
      *
      * @throws \Exception
      */
-    protected function getHtmlContentsForDocument(DocumentInterface $documentModel): string
+    protected function getHtmlContentsForDocument(HtmlDocumentInterface $documentModel): string
     {
         $htmlContents = $documentModel->getHtmlContents();
 

src/Model/GeneratorInterface.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * Pdf generator interface class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -19,17 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-/**
- * Interface Vianetz_Pdf_Model_Generator_Interface
- */
 interface GeneratorInterface
 {
-    /**
-     * Render the pdf document.
-     *
-     * @param DocumentInterface $documentModel
-     *
-     * @return string
-     */
-    public function renderPdfDocument(DocumentInterface $documentModel);
+    public function renderPdfDocument(HtmlDocumentInterface $documentModel): string;
 }

src/Model/Document.php renamed to src/Model/HtmlDocument.php

@@ -19,7 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-class Document implements DocumentInterface
+class HtmlDocument implements HtmlDocumentInterface
 {
     private string $htmlContents;
     private string $pdfBackgroundFile = '';

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

@@ -19,8 +19,7 @@
 
 namespace Vianetz\Pdf\Model;
 
-/** @todo rename to HtmlDocumentInterface */
-interface DocumentInterface
+interface HtmlDocumentInterface
 {
     public function getHtmlContents(): string;
 

src/Model/NullEventManager.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
@@ -19,10 +21,8 @@
 
 final class NullEventManager implements EventManagerInterface
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function dispatch($eventName, array $data = [])
+    /** {@inheritDoc} */
+    public function dispatch(string $eventName, array $data = []): void
     {
         // do nothing
     }

src/Model/Pdf.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * Vianetz Public Pdf Model
  *
@@ -29,35 +31,19 @@
 
 class Pdf implements PdfInterface
 {
-    /**
-     * The generator instance.
-     *
-     * @var GeneratorInterface
-     */
-    private $generator;
-
-    /** @var \Vianetz\Pdf\Model\PdfMerge */
-    private $pdfMerge;
-
-    /**
-     * The (cached) pdf contents.
-     *
-     * @var string|null
-     */
-    private $contents;
+    private GeneratorInterface $generator;
+    private PdfMerge $pdfMerge;
+    private ?string $contents = null;
 
     /**
      * Initialize empty array for PDF documents to print.
      *
-     * @var array<\Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface>
+     * @var array<\Vianetz\Pdf\Model\HtmlDocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface>
      */
-    private $documents = [];
+    private array $documents = [];
 
-    /** @var Config */
-    protected $config;
-
-    /** @var \Vianetz\Pdf\Model\EventManagerInterface */
-    protected $eventManager;
+    protected Config $config;
+    protected EventManagerInterface $eventManager;
 
     /**
      * Default constructor initializes pdf generator.
@@ -76,10 +62,8 @@ final public function __construct(
         $this->eventManager = $eventManager;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    final public function getContents()
+    /** {@inheritDoc} */
+    final public function getContents(): string
     {
         if ($this->contents === null) {
             $this->renderPdfContentsForAllDocuments();
@@ -89,10 +73,8 @@ final public function getContents()
         return $this->contents;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    final public function saveToFile($fileName)
+    /** {@inheritDoc} */
+    final public function saveToFile(string $fileName): bool
     {
         $pdfContents = $this->getContents();
 
@@ -102,7 +84,7 @@ final public function saveToFile($fileName)
     /**
      * Add a new document to generate.
      *
-     * @param \Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface $documentModel
+     * @param \Vianetz\Pdf\Model\HtmlDocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface $documentModel
      *
      * @api
      */
@@ -117,10 +99,8 @@ final public function addDocument($documentModel): self
 
     /**
      * Returns the number of documents added to the generator.
-     *
-     * @return int
      */
-    final public function countDocuments()
+    final public function countDocuments(): int
     {
         return count($this->documents);
     }
@@ -131,35 +111,29 @@ final public function countDocuments()
      * Note:
      * This method only exists for compatibility reasons to provide the same interface as the original Zend_Pdf
      * components.
-     *
-     * @return string
      */
-    final public function render()
+    final public function render(): string
     {
         return $this->getContents();
     }
 
-    /**
-     * @return \Vianetz\Pdf\Model\Config
-     */
-    public function getConfig()
+    public function getConfig(): Config
     {
         return $this->config;
     }
 
     /**
      * Return merged pdf contents of all documents and save it to single temporary files.
      *
-     * @return void
      * @throws \Vianetz\Pdf\NoDataException
      */
-    private function renderPdfContentsForAllDocuments()
+    private function renderPdfContentsForAllDocuments(): void
     {
         $hasData = false;
         foreach ($this->documents as $documentInstance) {
             $this->eventManager->dispatch('vianetz_pdf_document_render_before', ['document' => $documentInstance]);
 
-            if ($documentInstance instanceof DocumentInterface) {
+            if ($documentInstance instanceof HtmlDocumentInterface) {
                 $this->eventManager->dispatch('vianetz_pdf_' . $documentInstance->getDocumentType() . '_document_render_before', ['document' => $documentInstance]);
 
                 $pdfContents = $this->generator->renderPdfDocument($documentInstance);

src/Model/PdfDocument.php

@@ -1,18 +1,34 @@
 <?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;
 
 final class PdfDocument implements PdfDocumentInterface
 {
-    /** @var string */
-    private $pdfFile;
+    private string $pdfFile;
 
-    public function getPdfFile()
+    public function getPdfFile(): string
     {
         return $this->pdfFile;
     }
 
-    public function setPdfFile($pdfFile)
+    public function setPdfFile(string $pdfFile): void
     {
         $this->pdfFile = $pdfFile;
     }

src/Model/PdfDocumentInterface.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
@@ -19,14 +21,7 @@
 
 interface PdfDocumentInterface
 {
-    /**
-     * @return string
-     */
-    public function getPdfFile();
+    public function getPdfFile(): string;
 
-    /**
-     * @param string $pdfFile
-     * @return void
-     */
-    public function setPdfFile($pdfFile);
+    public function setPdfFile(string $pdfFile): void;
 }