Merge branch 'release/1.4.0'

Author: ma4nn

CHANGELOG.md

@@ -4,6 +4,10 @@ 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/).
 
+## [1.4.0] - 2020-10-15
+### Changed
+- `PdfMerge` class can now automatically instantiate the merger class
+
 ## [1.3.0] - 2020-10-04
 ### Changed
 - No temporary files necessary for pdf merging anymore

README.md

@@ -11,6 +11,8 @@ Requirements
 
 Usage
 -----
+
+#### Create PDF document from HTML contents 
 ```php
 // Create a new pdf instance.
 $pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
@@ -27,6 +29,23 @@ $pdf->addDocument($document);
 $pdf->saveToFile('test.pdf');
 ```
 
+#### Merge a PDF file and a PDF string into one PDF file
+```php
+// Load some random PDF contents
+$pdfString = file_get_contents('test1.pdf');
+
+// Setup things
+$pdf = Vianetz\Pdf\Model\PdfFactory::general()->create();
+$pdfMerge = Vianetz\Pdf\Model\PdfMerge::create();
+
+// Do the merge.
+$pdfMerge->mergePdfString($pdfString);
+$pdfMerge->mergePdfFile('test2.pdf');
+
+// Save the result PDF to file result.pdf.
+$pdfMerge->saveToFile('result.pdf');
+```
+
 Frequently Asked Questions
 --------------------------
 Please find the Frequently Asked Questions [on our website](https://www.vianetz.com/en/faq).

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-    level: 8
+    level: max
     fileExtensions:
         - php
     paths:

src/Model/Pdf.php

@@ -27,7 +27,7 @@
 
 use Vianetz\Pdf\NoDataException;
 
-class Pdf
+class Pdf implements PdfInterface
 {
     /**
      * The generator instance.
@@ -77,46 +77,37 @@ final public function __construct(
         MergerInterface $merger
     ) {
         $this->generator = $generator;
-        $this->pdfMerge = PdfMerge::createWithMerger($merger);
+        $this->pdfMerge = PdfMerge::create($merger);
         $this->config = $config;
         $this->eventManager = $eventManager;
     }
 
     /**
-     * Get pdf file contents as string.
-     *
-     * @api
-     * @return string
+     * {@inheritDoc}
      */
     final public function getContents()
     {
         if ($this->contents === null) {
-            $this->contents = $this->renderPdfContentsForAllDocuments();
+            $this->renderPdfContentsForAllDocuments();
+            $this->contents = $this->pdfMerge->getContents();
         }
 
         return $this->contents;
     }
 
     /**
-     * Save pdf contents to file.
-     *
-     * @param string $fileName
-     *
-     * @api
-     * @return boolean true in case of success
+     * {@inheritDoc}
      */
     final public function saveToFile($fileName)
     {
         $pdfContents = $this->getContents();
 
-        return (@file_put_contents($fileName, $pdfContents) !== false);
+        return @file_put_contents($fileName, $pdfContents) !== false;
     }
 
     /**
      * Add a new document to generate.
      *
-     * @param DocumentInterface $documentModel
-     *
      * @api
      * @return Pdf
      */
@@ -164,7 +155,7 @@ public function getConfig()
     /**
      * Return merged pdf contents of all documents and save it to single temporary files.
      *
-     * @return string
+     * @return void
      * @throws \Vianetz\Pdf\NoDataException
      */
     private function renderPdfContentsForAllDocuments()
@@ -200,7 +191,5 @@ private function renderPdfContentsForAllDocuments()
         if (! $hasData) {
             throw new NoDataException('No data to print.');
         }
-
-        return $this->pdfMerge->getResult();
     }
 }

src/Model/PdfInterface.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Pdf interface class
+ *
+ * @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;
+
+interface PdfInterface
+{
+    /**
+     * @return string
+     * @throws \Vianetz\Pdf\NoDataException
+     */
+    public function getContents();
+
+    /**
+     * @param string $fileName
+     *
+     * @api
+     * @return bool true in case of success
+     * @throws \Vianetz\Pdf\NoDataException
+     */
+    public function saveToFile($fileName);
+}

src/Model/PdfMerge.php

@@ -17,24 +17,43 @@
 
 namespace Vianetz\Pdf\Model;
 
-class PdfMerge
+use Vianetz\Pdf\Model\Merger\Fpdi;
+use Vianetz\Pdf\NoDataException;
+
+class PdfMerge implements PdfInterface
 {
     /** @var \Vianetz\Pdf\Model\MergerInterface */
     private $merger;
 
-    public function __construct(MergerInterface $merger)
+    /** @var int */
+    private $pageCount = 0;
+
+    public function __construct(MergerInterface $merger = null)
     {
+        if ($merger === null) {
+            $merger = new Fpdi();
+        }
+
         $this->merger = $merger;
     }
 
     /**
      * @return \Vianetz\Pdf\Model\PdfMerge
      */
-    public static function createWithMerger(MergerInterface $merger)
+    public static function create(MergerInterface $merger = null)
     {
         return new self($merger);
     }
 
+    /**
+     * @deprecated
+     * @return \Vianetz\Pdf\Model\PdfMerge
+     */
+    public static function createWithMerger(MergerInterface $merger)
+    {
+        return self::create($merger);
+    }
+
     /**
      * {@inheritDoc}
      *
@@ -58,8 +77,8 @@ public function mergePdfFile($pdfFile, $pdfBackgroundFile = null, $pdfBackground
      * {@inheritDoc}
      *
      * @param string $pdfString
-     * @param null|string $pdfBackgroundFile
-     * @param null|string $pdfBackgroundFileForFirstPage
+     * @param string|null $pdfBackgroundFile
+     * @param string|null $pdfBackgroundFileForFirstPage
      *
      * @return void
      */
@@ -68,6 +87,7 @@ public function mergePdfString($pdfString, $pdfBackgroundFile = null, $pdfBackgr
         $pageCount = $this->merger->countPages($pdfString);
         for ($pageNumber = 1; $pageNumber <= $pageCount; $pageNumber++) {
             $this->merger->addPage();
+            $this->pageCount++;
 
             if ($pageNumber === 1 && ! empty($pdfBackgroundFileForFirstPage)) {
                 $this->merger->importBackgroundTemplateFile($pdfBackgroundFileForFirstPage);
@@ -80,10 +100,35 @@ public function mergePdfString($pdfString, $pdfBackgroundFile = null, $pdfBackgr
     }
 
     /**
+     * @deprecated use self::getContents() instead
+     *
      * @return string
+     * @throws \Vianetz\Pdf\NoDataException
      */
     public function getResult()
     {
+        return $this->getContents();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function getContents()
+    {
+        if ($this->pageCount === 0) {
+            throw new NoDataException('No data to print.');
+        }
+
         return $this->merger->getPdfContents();
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function saveToFile($fileName)
+    {
+        $pdfContents = $this->getContents();
+
+        return @file_put_contents($fileName, $pdfContents) !== false;
+    }
 }

src/Test/PdfMergeTest.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * @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\Test;
+
+use PHPUnit\Framework\TestCase;
+use Vianetz\Pdf\Model\PdfMerge;
+use Vianetz\Pdf\NoDataException;
+
+final class PdfMergeTest extends TestCase
+{
+    /**
+     * @return \Vianetz\Pdf\Model\PdfMerge
+     */
+    private function getPdfMergeMock()
+    {
+        return PdfMerge::create();
+    }
+
+    /**
+     * @return void
+     */
+    public function testMergeGeneratesEmptyPdfIfNoContentsAdded()
+    {
+        $pdfMergeMock = $this->getPdfMergeMock();
+        $this->expectException(NoDataException::class);
+
+        $pdfMergeMock->getContents();
+    }
+}

src/Test/PdfTest.php

@@ -19,7 +19,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Vianetz\Pdf\Model\Config;
-use Vianetz\Pdf\Model\EventManagerInterface;
 use Vianetz\Pdf\Model\Generator\AbstractGenerator;
 use Vianetz\Pdf\Model\PdfFactory;
 use Vianetz\Pdf\NoDataException;