Merge branch 'release/4.0.0' into develop

Author: ma4nn

CHANGELOG.md

@@ -1,8 +1,16 @@
 # Change Log
 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/).
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [4.0.0] - 2023-07-09
+### Changed
+- Raised minimum PHP version to 7.4
+- Small refactorings for typehints
+- Debug file appends content now
+### Fixed
+- Issue with pdf author not being set correctly
 
 ## [3.1.0] - 2022-08-24
 ### Changed

phpstan.neon

@@ -4,5 +4,5 @@ parameters:
         - php
     paths:
         - src/
-    excludes_analyse:
+    excludePaths:
         - src/Model/Merger/Zendpdf.php

src/Model/Generator/Dompdf.php

@@ -1,7 +1,5 @@
 <?php
 /**
- * DOMPdf generator class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -33,16 +31,10 @@ final class Dompdf extends AbstractGenerator
 {
     private const TOTAL_PAGE_COUNT_PLACEHOLDER = '__PDF_TPC__';
 
-    /** @var \Dompdf\Dompdf */
-    private $domPdf;
+    private \Dompdf\Dompdf $domPdf;
 
-    /**
-     * Render the pdf document.
-     *
-     * @return string|null
-     * @throws \Exception
-     */
-    public function renderPdfDocument(DocumentInterface $documentModel)
+    /** @throws \Exception */
+    public function renderPdfDocument(DocumentInterface $documentModel): ?string
     {
         $this->initPdf();
 
@@ -54,12 +46,7 @@ public function renderPdfDocument(DocumentInterface $documentModel)
         return $this->domPdf->output();
     }
 
-    /**
-     * Init PDF default settings.
-     *
-     * @return Dompdf
-     */
-    protected function initPdf()
+    protected function initPdf(): self
     {
         $this->domPdf = new \Dompdf\Dompdf($this->getDompdfOptions());
 
@@ -91,23 +78,23 @@ protected function getHtmlContentsForDocument(DocumentInterface $documentModel):
      *
      * @return array<string,mixed>
      */
-    private function getDompdfOptions()
+    private function getDompdfOptions(): array
     {
-        return array(
+        return [
             'isPhpEnabled' => true,
             'isRemoteEnabled' => true,
             'chroot' => $this->config->getChrootDir(),
-        );
+        ];
     }
 
     private function injectPageCount(): void
     {
         $canvas = $this->domPdf->getCanvas();
-        $pdf = $canvas->get_cpdf();
+        $pdf = $canvas->get_cpdf(); // @phpstan-ignore-line
 
         foreach ($pdf->objects as &$o) {
             if ($o['t'] === 'contents') {
-                $o['c'] = str_replace(self::TOTAL_PAGE_COUNT_PLACEHOLDER, $canvas->get_page_count(), $o['c']);
+                $o['c'] = str_replace(self::TOTAL_PAGE_COUNT_PLACEHOLDER, (string)$canvas->get_page_count(), $o['c']);
             }
         }
     }

src/Model/Pdf.php

@@ -102,12 +102,11 @@ final public function saveToFile($fileName)
     /**
      * Add a new document to generate.
      *
-     * @param \Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface
+     * @param \Vianetz\Pdf\Model\DocumentInterface|\Vianetz\Pdf\Model\PdfDocumentInterface $documentModel
      *
      * @api
-     * @return Pdf
      */
-    final public function addDocument($documentModel)
+    final public function addDocument($documentModel): self
     {
         $this->documents[] = $documentModel;
         // Reset cached pdf contents.