refactored fpdi merger and config model a bit to use typehints

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

Author: ma4nn

src/Model/Config.php

@@ -2,8 +2,6 @@
 declare(strict_types=1);
 
 /**
- * Vianetz Pdf Options Model
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -32,7 +30,7 @@ final class Config
     private string $pdfAuthor = '';
     private string $pdfTitle = '';
     private bool $isDebugMode = false;
-    private string $tempDir;
+    private string $tempDir = '';
     private string $chrootDir = '/';
 
     public function __construct()

src/Model/Merger/AbstractMerger.php

@@ -25,19 +25,13 @@ abstract class AbstractMerger implements MergerInterface
 {
     /**
      * Add the background pdf (if enabled and file exists).
-     *
-     * @param string $pdfBackgroundFile
-     *
-     * @return \Vianetz\Pdf\Model\Merger\AbstractMerger
      */
-    public function importBackgroundTemplateFile($pdfBackgroundFile)
+    public function importBackgroundTemplateFile(string $pdfBackgroundFile): void
     {
         if (empty($pdfBackgroundFile) || ! file_exists($pdfBackgroundFile)) {
-            return $this;
+            return;
         }
 
         $this->importPageFromFile($pdfBackgroundFile, 1); // We assume the background pdf has only one page.
-
-        return $this;
     }
 }

src/Model/Merger/Fpdi.php

@@ -28,28 +28,21 @@
 final class Fpdi extends AbstractMerger
 {
     /** @var string */
-    const OUTPUT_MODE_STRING = 'S';
+    private const OUTPUT_MODE_STRING = 'S';
 
     /** @var string */
-    const OUTPUT_FORMAT_LANDSCAPE = 'L';
+    private const OUTPUT_FORMAT_LANDSCAPE = 'L';
 
     /** @var string */
-    const OUTPUT_FORMAT_PORTRAIT = 'P';
+    private const OUTPUT_FORMAT_PORTRAIT = 'P';
 
-    /** @var FpdiModel */
-    private $fpdiModel;
+    private FpdiModel $fpdiModel;
+    private string $orientation = self::OUTPUT_FORMAT_PORTRAIT;
+    private string $paper = 'a4';
 
-    /** @var string */
-    private $orientation = self::OUTPUT_FORMAT_PORTRAIT;
-
-    /** @var string */
-    private $paper = 'a4';
-
-    public function __construct(\Vianetz\Pdf\Model\Config $config = null)
+    public function __construct(?\Vianetz\Pdf\Model\Config $config = null)
     {
-        if (empty($config)) {
-            $config = new \Vianetz\Pdf\Model\Config();
-        }
+        $config ??= new \Vianetz\Pdf\Model\Config();
 
         if ($config->getPdfOrientation() === Config::PAPER_ORIENTATION_PORTRAIT) {
             $this->orientation = self::OUTPUT_FORMAT_PORTRAIT;
@@ -70,63 +63,41 @@ public function __construct(\Vianetz\Pdf\Model\Config $config = null)
     /**
      * Import the specified page number from the given file into the current pdf model.
      *
-     * @param string|StreamReader $pdfFile
-     * @param int $pageNumber
+     * @param string|resource|StreamReader $file
      *
-     * @return void
+     * @throws \setasign\Fpdi\PdfParser\PdfParserException
+     * @throws \setasign\Fpdi\PdfReader\PdfReaderException
      */
-    public function importPageFromFile($pdfFile, $pageNumber)
+    public function importPageFromFile($file, int $pageNumber): void
     {
-        $this->fpdiModel->setSourceFile($pdfFile);
+        $this->fpdiModel->setSourceFile($file);
         $pageId = $this->fpdiModel->importPage($pageNumber);
         $this->fpdiModel->useTemplate($pageId);
     }
 
-    /**
-     * @param string $pdfString
-     * @param int $pageNumber
-     *
-     * @return void
-     */
-    public function importPageFromPdfString($pdfString, $pageNumber)
+    public function importPageFromPdfString(string $pdfString, int $pageNumber): void
     {
         $this->importPageFromFile($this->createPdfStream($pdfString), $pageNumber);
     }
 
-    /**
-     * @return string
-     */
-    public function getPdfContents()
+    public function getPdfContents(): string
     {
         return $this->fpdiModel->Output('', self::OUTPUT_MODE_STRING);
     }
 
-    /**
-     * @param string $pdfString
-     *
-     * @return integer
-     */
-    public function countPages($pdfString)
+    public function countPages(string $pdfString): int
     {
         return $this->fpdiModel->setSourceFile($this->createPdfStream($pdfString));
     }
 
-    /**
-     * @return \Vianetz\Pdf\Model\Merger\Fpdi
-     */
-    public function addPage()
+    public function addPage(): self
     {
         $this->fpdiModel->addPage($this->orientation, $this->paper);
 
         return $this;
     }
 
-    /**
-     * @param string $pdfString
-     *
-     * @return \setasign\Fpdi\PdfParser\StreamReader
-     */
-    private function createPdfStream($pdfString)
+    private function createPdfStream(string $pdfString): \setasign\Fpdi\PdfParser\StreamReader
     {
         return StreamReader::createByString($pdfString);
     }

src/Model/MergerInterface.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * Pdf merger interface class
  *
@@ -19,47 +21,20 @@
 
 namespace Vianetz\Pdf\Model;
 
+use setasign\Fpdi\PdfParser\StreamReader;
+
 interface MergerInterface
 {
-    /**
-     * Return the merged PDF contents as string.
-     *
-     * @return string
-     */
-    public function getPdfContents();
+    public function getPdfContents(): string;
 
-    /**
-     * @param string $fileName
-     * @param integer $pageNumber
-     *
-     * @return void
-     */
-    public function importPageFromFile($fileName, $pageNumber);
+    /** @param string|resource|StreamReader $file */
+    public function importPageFromFile($file, int $pageNumber): void;
 
-    /**
-     * @param string $pdfString
-     * @param integer $pageNumber
-     *
-     * @return void
-     */
-    public function importPageFromPdfString($pdfString, $pageNumber);
+    public function importPageFromPdfString(string $pdfString, int $pageNumber): void;
 
-    /**
-     * @param string $fileName
-     *
-     * @return integer
-     */
-    public function countPages($fileName);
+    public function countPages(string $fileName): int;
 
-    /**
-     * @return \Vianetz\Pdf\Model\MergerInterface
-     */
-    public function addPage();
+    public function addPage(): self;
 
-    /**
-     * @param string $pdfBackgroundFile
-     *
-     * @return void
-     */
-    public function importBackgroundTemplateFile($pdfBackgroundFile);
+    public function importBackgroundTemplateFile(string $pdfBackgroundFile): void;
 }