Merge pull request bithost-gmbh#98 from bithost-gmbh/feature/pdfCompl…

…iance

Fixes a PDF 1.7 compliance issue

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog for TYPO3 CMS Extension pdfviewhelpers
 
+## 2.0.1 - October 18, 2018
+- Fixes a PDF 1.7 compliance issue, [#97](https://github.com/bithost-gmbh/pdfviewhelpers/issues/97)
+- Updates documentation
+
 ## 2.0.0 - October 4, 2018
 - Adds HeaderViewHelper and FooterViewHelper, [#31](https://github.com/bithost-gmbh/pdfviewhelpers/issues/31)
 - Adds PageNumberAliasViewHelper and TotalNumberOfPagesAliasViewHelpers, [#31](https://github.com/bithost-gmbh/pdfviewhelpers/issues/31)

Classes/Model/BasePDF.php

@@ -105,20 +105,24 @@ class BasePDF extends Fpdi
      */
     protected function setHeader()
     {
-        //disable TCPDF default behaviour in order to be able to overwrite header and footer on page level
+        //disable TCPDF default behaviour in order to be able to overwrite header on page level
     }
 
     /**
      * @inheritdoc
      */
-    protected function setFooter()
+    public function endPage($tocpage = false)
     {
-        //disable TCPDF default behaviour in order to be able to overwrite header and footer on page level
+        parent::endPage($tocpage);
+
+        if ($this->pageFooterScope === self::SCOPE_THIS_PAGE) {
+            $this->pageFooterClosure = null; //remove page footer closure as it should only be used once
+        }
     }
 
     /**
      * Custom method to call setHeader to render header after the children of a PageViewHelper are rendered.
-     * This allows to overwrite header within a PageViewHelper.
+     * This allows to overwrite the header within a PageViewHelper.
      *
      * @return void
      */
@@ -127,23 +131,8 @@ public function renderHeader()
         $graphicVars = $this->getGraphicVars();
 
         parent::setHeader();
-
-        $this->setGraphicVars($graphicVars);
-    }
-
-    /**
-     * Custom method to call setFooter to render footer after the children of a PageViewHelper are rendered.
-     * This allows to overwrite footer within a PageViewHelper.
-     *
-     * @return void
-     */
-    public function renderFooter()
-    {
-        $graphicVars = $this->getGraphicVars();
-
-        parent::setFooter();
-
         $this->setGraphicVars($graphicVars);
+        $this->setPageMark();
     }
 
     /**
@@ -204,12 +193,7 @@ public function AddPage($orientation = '', $format = '', $rotationOrKeepmargins
                 $this->pageHeaderClosure = null; //remove page header closure as it should only be used once
             }
 
-            if ($this->pageFooterScope === self::SCOPE_THIS_PAGE) {
-                $this->pageFooterClosure = null; //remove page footer closure as it should only be used once
-            }
-
             $this->renderHeader();
-            $this->renderFooter();
         }
 
         if ($this->importTemplateOnThisPage && $this->tpl !== 0) {

Classes/ViewHelpers/AbstractContentElementViewHelper.php

@@ -89,7 +89,6 @@ protected function initializeHeaderAndFooter()
             $this->viewHelperVariableContainer->addOrUpdate('DocumentViewHelper', 'pageNeedsHeader', false);
 
             $this->getPDF()->renderHeader();
-            $this->getPDF()->renderFooter();
         }
     }
 

Classes/ViewHelpers/PageViewHelper.php

@@ -99,22 +99,20 @@ public function render()
 
         $this->setPageNeedsHeader(true);
         $this->getPDF()->setIsAutoPageBreak(true);
+        $this->getPDF()->setHeaderClosure(null, BasePDF::SCOPE_THIS_PAGE_INCLUDING_PAGE_BREAKS);
+        $this->getPDF()->setFooterClosure(null, BasePDF::SCOPE_THIS_PAGE_INCLUDING_PAGE_BREAKS);
         $this->getPDF()->setImportTemplateOnThisPage($hasImportedPage && $this->arguments['importPageOnAutomaticPageBreak']);
 
         $this->renderChildren();
 
         if ($this->pageNeedsHeader()) {
-            //no auto page break occurred, we still need to set the header
+            //no auto page break occurred or no element was rendered, we still need to set the header
             $this->setPageNeedsHeader(false);
-
             $this->getPDF()->renderHeader();
-            $this->getPDF()->renderFooter();
         }
 
-        //reset default header and footer scope to document and reset header and footer closures
+        //reset default header and footer scope to document
         $this->setDefaultHeaderFooterScope(BasePDF::SCOPE_DOCUMENT);
-        $this->getPDF()->setHeaderClosure(null, BasePDF::SCOPE_THIS_PAGE_INCLUDING_PAGE_BREAKS);
-        $this->getPDF()->setFooterClosure(null, BasePDF::SCOPE_THIS_PAGE_INCLUDING_PAGE_BREAKS);
     }
 
     /**

Documentation/ConfigurationReference/ExtendExistingPDFs/Index.rst

@@ -9,9 +9,7 @@ Extend Existing PDFs
 --------------------
 
 It is possible to use existing PDFs as template and extend the PDF where needed. You can either load the template PDF
-within the TypoScript settings or within the Fluid template itself. When you want to use that feature your PDF class should
-extend the class ``Bithost\Pdfviewhelpers\Model\BasePDF``. It is however also possible to use the class ``\FPDI``, although
-not recommend because it does not support all ``EXT:pdfviewhelpers`` features.
+within the TypoScript settings or within the Fluid template itself.
 
 TypoScript
 """"""""""

Documentation/Settings.yml

@@ -10,8 +10,8 @@
 conf.py:
   copyright: 2016 - 2018
   project: PDF ViewHelpers
-  version: 2.0.0
-  release: 2.0.0
+  version: 2.0.1
+  release: 2.0.1
   intersphinx_mapping:
     t3tsref:
     - http://docs.typo3.org/typo3cms/TyposcriptReference/

composer.json

@@ -1,7 +1,7 @@
 {
 	"name": "bithost-gmbh/pdfviewhelpers",
 	"type": "typo3-cms-extension",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"license": "GPL-3.0",
 	"description": "This is a TYPO3 CMS extension that provides various Fluid ViewHelpers to generate PDF documents.",
 	"keywords": ["PDF", "ViewHelpers", "Fluid", "generation", "generator", "TCPDF", "FPDI"],

ext_emconf.php

@@ -12,7 +12,7 @@
 	'uploadfolder' => '0',
 	'createDirs' => '',
 	'clearCacheOnLoad' => 0,
-	'version' => '2.0.0',
+	'version' => '2.0.1',
 	'constraints' => [
 		'depends' => [
 			'typo3' => '7.6.0-9.5.99',