small refactorings, made debug file appending, improved README

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

Author: ma4nn

README.md

@@ -1,18 +1,11 @@
-vianetz Pdf Library
-=====================
+# vianetz Pdf Library
 
-Description
------------
-This library offers an easy-to-use API for PDF generation and merging.
+This library offers an easy-to-use API for PDF generation and merging.  
+Internally it uses the DomPDF library for PDF generation and TCPDF for merging.
 
-Requirements
-------------
-- PHP >= 7
+## Usage
 
-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();
@@ -29,7 +22,7 @@ $pdf->addDocument($document);
 $pdf->saveToFile('test.pdf');
 ```
 
-#### Merge a PDF file and a PDF string into one PDF file
+### Merge a PDF file and a PDF string into one PDF file
 ```php
 // Load some random PDF contents
 $pdfString = file_get_contents('test1.pdf');
@@ -46,30 +39,24 @@ $pdfMerge->mergePdfFile('test2.pdf');
 $pdfMerge->saveToFile('result.pdf');
 ```
 
-Frequently Asked Questions
---------------------------
-Please find the Frequently Asked Questions [on our website](https://www.vianetz.com/en/faq).
+### Tips & Tricks
+
+- The string literal `__PDF_TPC__` will be replaced with the total page count
+
+## Frequently Asked Questions
+Please find the Frequently Asked Questions [on my website](https://www.vianetz.com/en/faq).
 
-Support
--------
+## Support
 If you have any issues or suggestions with this extension, please do not hesitate to
 [contact me](https://www.vianetz.com/en/contacts).
 
-Credits
--------
+## Credits
 Of course this extension would not have been possible without the great open source eco-system.
 Therewith credits go to:
 - [DomPDF](https://github.com/dompdf/dompdf)
 - [FPDI](https://github.com/Setasign/FPDI)
 
-Developer
----------
-Christoph Massmann  
-[www.vianetz.com](https://www.vianetz.com)  
-[@vianetz](https://twitter.com/vianetz)
-
-Licence
--------
+## License
 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)  
 See also LICENSE file.
 
@@ -78,8 +65,4 @@ repository](https://github.com/dompdf/dompdf).
 This extension uses the FPDI library. For license information please visit [the FPDI
 repository](https://github.com/Setasign/FPDI/blob/master/LICENSE.txt).
 
-Copyright
----------
-(c) since 2008 vianetz
-
 This library uses Semantic Versioning - please find more information at [semver.org](http://semver.org).

composer.json

@@ -25,7 +25,7 @@
     }
   },
   "require": {
-    "php": "^7|^8",
+    "php": "^7.4|^8",
     "dompdf/dompdf": "^2.0",
     "setasign/fpdi": "^2.0",
     "tecnickcom/tcpdf": "^6.4"

src/Model/Config.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * Vianetz Pdf Options Model
  *
@@ -24,157 +26,101 @@ final class Config
     public const PAPER_ORIENTATION_LANDSCAPE = 'landscape';
     public const PAPER_ORIENTATION_PORTRAIT = 'portrait';
 
-    /**
-     * @var string
-     * @see \Dompdf\Adapter\CPDF::$PAPER_SIZES
-     */
-    private $pdfSize = 'a4';
-
-    /** @var string */
-    private $pdfOrientation = self::PAPER_ORIENTATION_PORTRAIT;
-
-    /** @var string */
-    private $pdfAuthor = '';
-
-    /** @var string */
-    private $pdfTitle = '';
-
-    /** @var bool */
-    private $isDebugMode = false;
-
-    /** @var string */
-    private $tempDir;
-
-    /** @var string */
-    private $chrootDir = '/';
+    /** @see \Dompdf\Adapter\CPDF::$PAPER_SIZES */
+    private string $pdfSize = 'a4';
+    private string $pdfOrientation = self::PAPER_ORIENTATION_PORTRAIT;
+    private string $pdfAuthor = '';
+    private string $pdfTitle = '';
+    private bool $isDebugMode = false;
+    private string $tempDir;
+    private string $chrootDir = '/';
 
     public function __construct()
     {
         $this->tempDir = sys_get_temp_dir();
     }
 
-    /** @return string */
-    public function getPdfSize()
+    public function getPdfSize(): string
     {
         return $this->pdfSize;
     }
 
-    /**
-     * @return string
-     */
-    public function getPdfOrientation()
+    public function getPdfOrientation(): string
     {
         return $this->pdfOrientation;
     }
 
-    /**
-     * @return string
-     */
-    public function getPdfAuthor()
+    public function getPdfAuthor(): string
     {
         return $this->pdfAuthor;
     }
 
-    /**
-     * @return string
-     */
-    public function getPdfTitle()
+    public function getPdfTitle(): string
     {
         return $this->pdfTitle;
     }
 
-    /**
-     * @return boolean
-     */
-    public function isDebugMode()
+    public function isDebugMode(): bool
     {
         return $this->isDebugMode;
     }
 
-    /**
-     * @return string
-     */
-    public function getTempDir()
+    public function getTempDir(): string
     {
         return $this->tempDir;
     }
 
-    /**
-     * @return string
-     */
-    public function getChrootDir()
+    public function getChrootDir(): string
     {
         return $this->chrootDir;
     }
 
-    /**
-     * @param string $pdfSize
-     * @return Config
-     */
-    public function setPdfSize($pdfSize)
+    public function setPdfSize(string $pdfSize): self
     {
         $this->pdfSize = $pdfSize;
+
         return $this;
     }
 
-    /**
-     * @param string $pdfOrientation
-     * @return Config
-     */
-    public function setPdfOrientation($pdfOrientation)
+    public function setPdfOrientation(string $pdfOrientation): self
     {
         $this->pdfOrientation = $pdfOrientation;
+
         return $this;
     }
 
-    /**
-     * @param string $pdfAuthor
-     * @return Config
-     */
-    public function setPdfAuthor($pdfAuthor)
+    public function setPdfAuthor(string $pdfAuthor): self
     {
         $this->pdfAuthor = $pdfAuthor;
+
         return $this;
     }
 
-    /**
-     * @param string $pdfTitle
-     * @return Config
-     */
-    public function setPdfTitle($pdfTitle)
+    public function setPdfTitle(string $pdfTitle): self
     {
         $this->pdfTitle = $pdfTitle;
+
         return $this;
     }
 
-    /**
-     * @param boolean $isDebugMode
-     * @return Config
-     */
-    public function setIsDebugMode($isDebugMode)
+    public function setIsDebugMode(bool $isDebugMode): self
     {
         $this->isDebugMode = $isDebugMode;
+
         return $this;
     }
 
-    /**
-     * @param string $tempDir
-     * @return Config
-     */
-    public function setTempDir($tempDir)
+    public function setTempDir(string $tempDir): self
     {
         $this->tempDir = $tempDir;
+
         return $this;
     }
 
-    /**
-     * @param string $chrootDir
-     *
-     * @return $this
-     */
-    public function setChrootDir($chrootDir)
+    public function setChrootDir(string $chrootDir): self
     {
         $this->chrootDir = $chrootDir;
+
         return $this;
     }
 }

src/Model/Generator/AbstractGenerator.php

@@ -82,20 +82,14 @@ protected function replaceSpecialChars($htmlContents)
         return $htmlContents;
     }
 
-    /**
-     * Write the given string to debug file.
-     *
-     * @param string $fileContents
-     *
-     * @return boolean
-     */
-    protected function writeDebugFile($fileContents)
+    protected function writeDebugFile(string $fileContents): bool
     {
         if ($this->config->isDebugMode() === false) {
             return false;
         }
 
         $debugFilename = $this->config->getTempDir() . DIRECTORY_SEPARATOR . self::DEBUG_FILE_NAME;
-        return @file_put_contents($debugFilename, $fileContents) !== false;
+
+        return @file_put_contents($debugFilename, $fileContents, FILE_APPEND) !== false;
     }
 }