Merge branch 'release/3.1.0'

Author: ma4nn

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.1.0] - 2022-08-24
+### Changed
+- Upgraded DomPDF library to version 2
+- Upgraded other dependences
+- Raised minimum PHP version to 7
+
 ## [3.0.0] - 2021-06-01
 ### Changed
 - Refactored logic for pdf attachment files

README.md

@@ -7,7 +7,7 @@ This library offers an easy-to-use API for PDF generation and merging.
 
 Requirements
 ------------
-- PHP >= 5.6
+- PHP >= 7
 
 Usage
 -----

composer.json

@@ -25,19 +25,24 @@
     }
   },
   "require": {
-    "php": "^5.6|^7|^8",
-    "dompdf/dompdf": "^0.8|^1.0",
+    "php": "^7|^8",
+    "dompdf/dompdf": "^2.0",
     "setasign/fpdi": "^2.0",
     "tecnickcom/tcpdf": "^6.4"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7",
-    "phpstan/phpstan": "^0.12.11",
-    "phpstan/phpstan-phpunit": "^0.12.6",
-    "roave/backward-compatibility-check": "^5.0"
+    "phpunit/phpunit": "^9",
+    "phpstan/phpstan": "^1.8",
+    "phpstan/phpstan-phpunit": "^1.1",
+    "roave/backward-compatibility-check": "^7.0"
   },
   "suggest": {
     "vianetz/signaturportal-api": "Use this library to sign your generated PDF documents.",
     "zf1/zend-pdf": "Necessary if you want to use Zend_Pdf for merging. By default this package uses the fpdi merger."
+  },
+  "config": {
+    "allow-plugins": {
+      "ocramius/package-versions": true
+    }
   }
 }

src/Model/Config.php

@@ -21,11 +21,8 @@
 
 final class Config
 {
-    /** @var string */
-    const PAPER_ORIENTATION_LANDSCAPE = 'landscape';
-
-    /** @var string */
-    const PAPER_ORIENTATION_PORTRAIT = 'portrait';
+    public const PAPER_ORIENTATION_LANDSCAPE = 'landscape';
+    public const PAPER_ORIENTATION_PORTRAIT = 'portrait';
 
     /**
      * @var string
@@ -34,15 +31,15 @@ final class Config
     private $pdfSize = 'a4';
 
     /** @var string */
-    private $pdfOrientation;
+    private $pdfOrientation = self::PAPER_ORIENTATION_PORTRAIT;
 
     /** @var string */
     private $pdfAuthor = '';
 
     /** @var string */
     private $pdfTitle = '';
 
-    /** @var boolean */
+    /** @var bool */
     private $isDebugMode = false;
 
     /** @var string */

src/Model/Generator/AbstractGenerator.php

@@ -96,6 +96,6 @@ protected function writeDebugFile($fileContents)
         }
 
         $debugFilename = $this->config->getTempDir() . DIRECTORY_SEPARATOR . self::DEBUG_FILE_NAME;
-        return (@file_put_contents($debugFilename, $fileContents) !== false);
+        return @file_put_contents($debugFilename, $fileContents) !== false;
     }
 }

src/Model/Generator/Dompdf.php

@@ -31,18 +31,14 @@
  */
 final class Dompdf extends AbstractGenerator
 {
-    const TOTAL_PAGE_COUNT_PLACEHOLDER = '__PDF_TPC__';
+    private const TOTAL_PAGE_COUNT_PLACEHOLDER = '__PDF_TPC__';
 
-    /**
-     * @var \Dompdf\Dompdf
-     */
+    /** @var \Dompdf\Dompdf */
     private $domPdf;
 
     /**
      * Render the pdf document.
      *
-     * @param DocumentInterface $documentModel
-     *
      * @return string|null
      * @throws \Exception
      */
@@ -69,27 +65,20 @@ protected function initPdf()
 
         $this->domPdf->setPaper($this->config->getPdfSize(), $this->config->getPdfOrientation());
 
-        $this->domPdf->add_info('Creator', $this->config->getPdfAuthor());
-        $this->domPdf->add_info('Title', $this->config->getPdfTitle());
+        $this->domPdf->addInfo('Creator', $this->config->getPdfAuthor());
+        $this->domPdf->addInfo('Title', $this->config->getPdfTitle());
 
         return $this;
     }
 
     /**
      * Return HTML contents for one single document that is later merged with the others.
      *
-     * @param DocumentInterface $documentModel
-     *
-     * @return string
      * @throws \Exception
      */
-    protected function getHtmlContentsForDocument(DocumentInterface $documentModel)
+    protected function getHtmlContentsForDocument(DocumentInterface $documentModel): string
     {
-        try {
-            $htmlContents = $documentModel->getHtmlContents();
-        } catch (\Exception $ex) {
-            throw $ex;
-        }
+        $htmlContents = $documentModel->getHtmlContents();
 
         $htmlContents = $this->replaceSpecialChars($htmlContents);
         $this->writeDebugFile($htmlContents);
@@ -111,10 +100,7 @@ private function getDompdfOptions()
         );
     }
 
-    /**
-     * @return void
-     */
-    private function injectPageCount()
+    private function injectPageCount(): void
     {
         $canvas = $this->domPdf->getCanvas();
         $pdf = $canvas->get_cpdf();

src/Test/PdfTest.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
@@ -25,30 +27,21 @@
 
 final class PdfTest extends TestCase
 {
-    /**
-     * @return \Vianetz\Pdf\Model\Document
-     */
-    private function getDocumentMock()
+    private function getDocumentMock(): \Vianetz\Pdf\Model\Document
     {
         /** @var \Vianetz\Pdf\Model\Document $document */
         $document = new \Vianetz\Pdf\Model\Document();
-        $document->setHtmlContents('<html>test</html>');
+        $document->setHtmlContents('<html><body>This is the <strong>pdf-generator</strong> test!</body></html>');
 
         return $document;
     }
 
-    /**
-     * @return \Vianetz\Pdf\Model\Pdf
-     */
-    private function getPdfMock(Config $config = null)
+    private function getPdfMock(?Config $config = null): \Vianetz\Pdf\Model\Pdf
     {
         return PdfFactory::general()->create($config);
     }
 
-    /**
-     * @return void
-     */
-    public function tearDown()
+    public function tearDown(): void
     {
         parent::tearDown();
 
@@ -57,21 +50,15 @@ public function tearDown()
         @rmdir('./tmp/');
     }
 
-    /**
-     * @return void
-     */
-    public function testAddOneDocumentIncreasesDocumentCounterByOne()
+    public function testAddOneDocumentIncreasesDocumentCounterByOne(): void
     {
         $pdfMock = $this->getPdfMock();
         $pdfMock->addDocument($this->getDocumentMock());
 
         $this->assertEquals(1, $pdfMock->countDocuments());
     }
 
-    /**
-     * @return void
-     */
-    public function testAddThreeDocumentsIncreasesDocumentCounterByThree()
+    public function testAddThreeDocumentsIncreasesDocumentCounterByThree(): void
     {
         $pdfMock = $this->getPdfMock();
         $pdfMock->addDocument($this->getDocumentMock())
@@ -81,30 +68,21 @@ public function testAddThreeDocumentsIncreasesDocumentCounterByThree()
         $this->assertEquals(3, $pdfMock->countDocuments());
     }
 
-    /**
-     * @return void
-     */
-    public function testGetContentsReturnsExceptionIfNoDocumentsAdded()
+    public function testGetContentsReturnsExceptionIfNoDocumentsAdded(): void
     {
         $this->expectException(NoDataException::class);
         $this->getPdfMock()->getContents();
     }
 
-    /**
-     * @return void
-     */
-    public function testGetContentsReturnsExpectedResult()
+    public function testGetContentsReturnsNonEmptyResult(): void
     {
         $pdfMock = $this->getPdfMock();
         $pdfMock->addDocument($this->getDocumentMock());
 
         $this->assertNotEmpty($pdfMock->getContents());
     }
 
-    /**
-     * @return void
-     */
-    public function testDebugModeGeneratesDebugFile()
+    public function testDebugModeGeneratesDebugFile(): void
     {
         $config = new Config();
         $config->setIsDebugMode(true)
@@ -116,20 +94,14 @@ public function testDebugModeGeneratesDebugFile()
         $this->assertFileExists(AbstractGenerator::DEBUG_FILE_NAME);
     }
 
-    /**
-     * @return void
-     */
-    public function testConfigTempDirMayNotBeNull()
+    public function testConfigTempDirMayNotBeNull(): void
     {
         $config = new Config();
 
         $this->assertNotEmpty($config->getTempDir());
     }
 
-    /**
-     * @return void
-     */
-    public function testNoExceptionIfTempDirNotWritable()
+    public function testNoExceptionIfTempDirNotWritable(): void
     {
         @mkdir('./tmp', 0000);
 
@@ -140,6 +112,6 @@ public function testNoExceptionIfTempDirNotWritable()
         $pdfMock->addDocument($this->getDocumentMock())
             ->render();
 
-        $this->assertDirectoryNotIsWritable('tmp/');
+        $this->assertDirectoryIsNotWritable('tmp/');
     }
 }