added fpdf merger as new default (more lightweight), removed deprecated zendpdf merger, added zugferd fpdf merger

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

Author: ma4nn

README.md

@@ -1,22 +1,24 @@
-# vianetz PDF Library
+# vianetz Pdf Library
 
 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.
+Internally it uses the [DomPDF library](https://github.com/dompdf/dompdf) for PDF generation and [FPDI](https://github.com/Setasign/FPDI) for merging.
+
+More information about this PDF API can also be found [on my website](https://www.vianetz.com/en/pdf-invoice-api-magento/).
 
 ## Usage
 
 ### Create PDF document from HTML contents
 
 ```php
 // Create a new pdf instance.
-$pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
+$pdf = \Vianetz\Pdf\Model\PdfFactory::general()->create();
 
 // Create the document. You can return any kind of HTML content here.
 $document = new \Vianetz\Pdf\Model\HtmlDocument('<strong>Hello</strong> World!');
 
 // Add our document to the pdf. You can add as many documents as you like
 // as they will all be merged into one PDF file.
-$pdf->addDocument($document);
+$pdf->add($document);
 
 // Save the resulting PDF to file test.pdf - That's it :-)
 $pdf->saveToFile('test.pdf');
@@ -28,15 +30,14 @@ $pdf->saveToFile('test.pdf');
 $pdfString = file_get_contents('test1.pdf');
 
 // Setup things
-$pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
-$pdfMerge = Vianetz\Pdf\Model\PdfMerge::create();
+$pdfMerge = \Vianetz\Pdf\Model\PdfMerge::create();
 
 // Do the merge.
-$pdfMerge->mergePdfString($pdfString);
+$pdfMerge->mergePdfString($pdfString, 'background.pdf');
 $pdfMerge->mergePdfFile('test2.pdf');
 
 // Save the result PDF to file result.pdf.
-$pdfMerge->saveToFile('result.pdf');
+file_put_contents($fileName, $pdfMerge->toPdf());
 ```
 
 ### Tips & Tricks
@@ -50,12 +51,6 @@ Please find the Frequently Asked Questions [on my website](https://www.vianetz.c
 If you have any issues or suggestions with this extension, please do not hesitate to
 [contact me](https://www.vianetz.com/en/contacts).
 
-## 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)
-
 ## License
 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)  
 See also LICENSE file.

composer.json

@@ -27,17 +27,18 @@
   "require": {
     "php": "^7.4|^8",
     "dompdf/dompdf": "^2.0|^3.0",
-    "setasign/fpdi": "^2.0",
-    "tecnickcom/tcpdf": "^6.4"
+    "setasign/fpdi": "^2.6",
+    "setasign/fpdf": "^1.8"
   },
   "require-dev": {
     "phpunit/phpunit": "^9|^10|^11",
     "phpstan/phpstan": "^1.8",
     "phpstan/phpstan-phpunit": "^1.1"
   },
   "suggest": {
+    "horstoeko/zugferd": "Create Zugferd documents with this merger library",
     "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."
+    "tecnickcom/tcpdf": "Necessary if you want to use TCPDF for merging. By default this package uses the fpdf merger."
   },
   "config": {
     "allow-plugins": {

src/Exception.php

@@ -1,7 +1,7 @@
 <?php
+declare(strict_types=1);
+
 /**
- * Pdf Exception Class
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.

src/FileNotFoundException.php

@@ -0,0 +1,24 @@
+<?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;
+
+class FileNotFoundException extends \Exception
+{
+}

src/Model/Generator/AbstractGenerator.php

@@ -37,7 +37,7 @@ abstract class AbstractGenerator implements Pdfable // @todo rename Generator to
     public const DEBUG_FILE_NAME = 'vianetz_pdf_generator_debug.html';
     protected Config $config;
 
-    abstract public function convert(string $html): self;
+    abstract public function import(string $html): self;
 
     public function __construct(?Config $config = null)
     {

src/Model/Generator/Dompdf.php

@@ -34,7 +34,7 @@ final class Dompdf extends AbstractGenerator
     private \Dompdf\Dompdf $domPdf;
 
     /** @throws \Exception */
-    public function convert(string $html): self
+    public function import(string $html): self
     {
         $this->writeDebugFile($html);
 

src/Model/Merger/AbstractMerger.php

@@ -19,17 +19,16 @@
 
 namespace Vianetz\Pdf\Model\Merger;
 
+use Vianetz\Pdf\FileNotFoundException;
 use Vianetz\Pdf\Model\MergerInterface;
 
 abstract class AbstractMerger implements MergerInterface
 {
-    /**
-     * Add the background pdf (if enabled and file exists).
-     */
+    /** @inheritDoc */
     public function importBackgroundTemplateFile(string $pdfBackgroundFile): void
     {
         if (empty($pdfBackgroundFile) || ! file_exists($pdfBackgroundFile)) {
-            return;
+            throw new FileNotFoundException('pdf background template file does not exist');
         }
 
         $this->importPageFromFile($pdfBackgroundFile, 1); // We assume the background pdf has only one page.

src/Model/Merger/Fpdf.php

@@ -0,0 +1,99 @@
+<?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\Merger;
+
+use setasign\Fpdi\Fpdi as FpdfFpdi;
+use setasign\Fpdi\PdfParser\StreamReader;
+use Vianetz\Pdf\Model\Config;
+
+class Fpdf extends AbstractMerger
+{
+    private const OUTPUT_MODE_STRING = 'S';
+    private const OUTPUT_FORMAT_LANDSCAPE = 'L';
+    private const OUTPUT_FORMAT_PORTRAIT = 'P';
+    protected FpdfFpdi $fpdiModel;
+    private string $orientation = self::OUTPUT_FORMAT_PORTRAIT;
+    private string $paper;
+
+    public function __construct(?Config $config = null, ?FpdfFpdi $fpdiModel = null)
+    {
+        $config ??= new Config();
+
+        if ($config->getPdfOrientation() === Config::PAPER_ORIENTATION_PORTRAIT) {
+            $this->orientation = self::OUTPUT_FORMAT_PORTRAIT;
+        } elseif ($config->getPdfOrientation() === Config::PAPER_ORIENTATION_LANDSCAPE) {
+            $this->orientation = self::OUTPUT_FORMAT_LANDSCAPE;
+        }
+
+        $this->paper = $config->getPdfSize();
+
+        $this->fpdiModel = $fpdiModel ?? new FpdfFpdi($this->orientation, 'mm', $this->paper);
+
+        $this->fpdiModel->SetAuthor($config->getPdfAuthor());
+        $this->fpdiModel->SetTitle($config->getPdfTitle());
+        $this->fpdiModel->setCreator('https://github.com/vianetz/pdf-generator');
+    }
+
+    /**
+     * Import the specified page number from the given file into the current pdf model.
+     *
+     * @param string|resource|StreamReader $file
+     *
+     * @throws \setasign\Fpdi\PdfParser\PdfParserException|\setasign\Fpdi\PdfReader\PdfReaderException
+     */
+    public function importPageFromFile($file, int $pageNumber): void
+    {
+        $this->fpdiModel->setSourceFile($file);
+        $pageId = $this->fpdiModel->importPage($pageNumber);
+        $this->fpdiModel->useTemplate($pageId);
+    }
+
+    public function importPageFromPdfString(string $pdfString, int $pageNumber): void
+    {
+        $this->importPageFromFile($this->createPdfStream($pdfString), $pageNumber);
+    }
+
+    public function toPdf(): string
+    {
+        return $this->fpdiModel->Output('', self::OUTPUT_MODE_STRING);
+    }
+
+    public function countPages(string $pdfString): int
+    {
+        return $this->fpdiModel->setSourceFile($this->createPdfStream($pdfString));
+    }
+
+    public function addPage(): self
+    {
+        $this->fpdiModel->addPage($this->orientation, $this->paper);
+
+        return $this;
+    }
+
+    public function addAttachment(string $fileName): self
+    {
+        throw new \RuntimeException('not implemented');
+    }
+
+    private function createPdfStream(string $pdfString): StreamReader
+    {
+        return StreamReader::createByString($pdfString);
+    }
+}

src/Model/Merger/Fpdi.php

@@ -2,8 +2,6 @@
 declare(strict_types=1);
 
 /**
- * This class is responsible for merging individual PDF documents and eventually adding the background PDF template file.
- *
  * @section LICENSE
  * This file is created by vianetz <[email protected]>.
  * The code is distributed under the GPL license.
@@ -25,12 +23,11 @@
 use setasign\Fpdi\Tcpdf\Fpdi as TcpdfFpdi;
 use Vianetz\Pdf\Model\Config;
 
-final class Fpdi extends AbstractMerger
+final class Fpdi extends AbstractMerger // @todo rename to tcpdf
 {
     private const OUTPUT_MODE_STRING = 'S';
     private const OUTPUT_FORMAT_LANDSCAPE = 'L';
     private const OUTPUT_FORMAT_PORTRAIT = 'P';
-
     private TcpdfFpdi $fpdiModel;
     private string $orientation = self::OUTPUT_FORMAT_PORTRAIT;
     private string $paper = 'a4';
@@ -45,24 +42,23 @@ public function __construct(?Config $config = null)
             $this->orientation = self::OUTPUT_FORMAT_LANDSCAPE;
         }
 
+        $this->paper = $config->getPdfSize();
+
         $this->fpdiModel = new TcpdfFpdi($this->orientation, 'mm', $this->paper);
 
         $this->fpdiModel->SetAuthor($config->getPdfAuthor());
         $this->fpdiModel->SetTitle($config->getPdfTitle());
-        $this->fpdiModel->setCreator('vianetz PDF Generator (https://github.com/vianetz/pdf-generator)');
+        $this->fpdiModel->setCreator('https://github.com/vianetz/pdf-generator');
         $this->fpdiModel->setPrintHeader(false);
         $this->fpdiModel->setPrintFooter(false);
-
-        $this->paper = $config->getPdfSize();
     }
 
     /**
      * Import the specified page number from the given file into the current pdf model.
      *
      * @param string|resource|StreamReader $file
      *
-     * @throws \setasign\Fpdi\PdfParser\PdfParserException
-     * @throws \setasign\Fpdi\PdfReader\PdfReaderException
+     * @throws \setasign\Fpdi\PdfParser\PdfParserException|\setasign\Fpdi\PdfReader\PdfReaderException
      */
     public function importPageFromFile($file, int $pageNumber): void
     {
@@ -93,7 +89,12 @@ public function addPage(): self
         return $this;
     }
 
-    private function createPdfStream(string $pdfString): \setasign\Fpdi\PdfParser\StreamReader
+    public function addAttachment(string $fileName): self
+    {
+        throw new \RuntimeException('not implemented');
+    }
+
+    private function createPdfStream(string $pdfString): StreamReader
     {
         return StreamReader::createByString($pdfString);
     }