Merge pull request #175 from Setasign/development

Development
Setasign · Jul 24, 2023 · 984c0a6 · 984c0a6
2 parents 8e02c37 + 8952a40
commit 984c0a6
Show file tree

Hide file tree

Showing 50 changed files with 107 additions and 59 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4']
+        php: ['5.6', '7.0', '7.1', '7.2', '7.3']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -26,12 +26,12 @@ jobs:
         run: |
           ./vendor/bin/phpunit
 
-  testsPhp8:
-    name: Run PHP Unit tests (>= 8.0)
+  testsPhp74and8:
+    name: Run PHP Unit tests (>= 7.4)
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        php: ['8.0', '8.1', '8.2']
+        php: ['7.4', '8.0', '8.1', '8.2']
     steps:
       - name: Checkout
         uses: actions/checkout@v2

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Setasign GmbH & Co. KG, https://www.setasign.com
+Copyright (c) 2023 Setasign GmbH & Co. KG, https://www.setasign.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/src/FpdfTpl.php b/src/FpdfTpl.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/FpdfTplTrait.php b/src/FpdfTplTrait.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 
@@ -13,7 +13,7 @@
 /**
  * Trait FpdfTplTrait
  *
- * This class adds a templating feature to FPDF and tFPDF.
+ * This trait adds a templating feature to FPDF and tFPDF.
  */
 trait FpdfTplTrait
 {

diff --git a/src/Fpdi.php b/src/Fpdi.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/FpdiException.php b/src/FpdiException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/FpdiTrait.php b/src/FpdiTrait.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 
@@ -124,17 +124,18 @@ protected function setMinPdfVersion($pdfVersion)
      * Get a new pdf parser instance.
      *
      * @param StreamReader $streamReader
+     * @param array $parserParams Individual parameters passed to the parser instance.
      * @return PdfParser|FpdiPdfParser
      */
-    protected function getPdfParserInstance(StreamReader $streamReader)
+    protected function getPdfParserInstance(StreamReader $streamReader, array $parserParams = [])
     {
         // note: if you get an exception here - turn off errors/warnings on not found for your autoloader.
         // psr-4 (https://www.php-fig.org/psr/psr-4/) says: Autoloader implementations MUST NOT throw
         // exceptions, MUST NOT raise errors of any level, and SHOULD NOT return a value.
         /** @noinspection PhpUndefinedClassInspection */
         if (\class_exists(FpdiPdfParser::class)) {
             /** @noinspection PhpUndefinedClassInspection */
-            return new FpdiPdfParser($streamReader);
+            return new FpdiPdfParser($streamReader, $parserParams);
         }
 
         return new PdfParser($streamReader);
@@ -145,9 +146,10 @@ protected function getPdfParserInstance(StreamReader $streamReader)
      *
      * @param string|resource|PdfReader|StreamReader $file An open file descriptor, a path to a file, a PdfReader
      *                                                     instance or a StreamReader instance.
+     * @param array $parserParams Individual parameters passed to the parser instance.
      * @return string
      */
-    protected function getPdfReaderId($file)
+    protected function getPdfReaderId($file, array $parserParams = [])
     {
         if (\is_resource($file)) {
             $id = (string) $file;
@@ -178,7 +180,7 @@ protected function getPdfReaderId($file)
             $streamReader = $file;
         }
 
-        $reader = new PdfReader($this->getPdfParserInstance($streamReader));
+        $reader = new PdfReader($this->getPdfParserInstance($streamReader, $parserParams));
         /** @noinspection OffsetOperationsInspection */
         $this->readers[$id] = $reader;
 
@@ -211,7 +213,24 @@ protected function getPdfReader($id)
      */
     public function setSourceFile($file)
     {
-        $this->currentReaderId = $this->getPdfReaderId($file);
+        return $this->setSourceFileWithParserParams($file);
+    }
+
+    /**
+     * Set the source PDF file with parameters which are passed to the parser instance.
+     *
+     * This method allows us to pass e.g. authentication information to the parser instance.
+     *
+     * @param string|resource|StreamReader $file Path to the file or a stream resource or a StreamReader instance.
+     * @param array $parserParams Individual parameters passed to the parser instance.
+     * @return int The page count of the PDF document.
+     * @throws CrossReferenceException
+     * @throws PdfParserException
+     * @throws PdfTypeException
+     */
+    public function setSourceFileWithParserParams($file, array $parserParams = [])
+    {
+        $this->currentReaderId = $this->getPdfReaderId($file, $parserParams);
         $this->objectsToCopy[$this->currentReaderId] = [];
 
         $reader = $this->getPdfReader($this->currentReaderId);

diff --git a/src/PdfParser/CrossReference/AbstractReader.php b/src/PdfParser/CrossReference/AbstractReader.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/CrossReference/CrossReference.php b/src/PdfParser/CrossReference/CrossReference.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/CrossReference/CrossReferenceException.php b/src/PdfParser/CrossReference/CrossReferenceException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/CrossReference/FixedReader.php b/src/PdfParser/CrossReference/FixedReader.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/CrossReference/LineReader.php b/src/PdfParser/CrossReference/LineReader.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/CrossReference/ReaderInterface.php b/src/PdfParser/CrossReference/ReaderInterface.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/Ascii85.php b/src/PdfParser/Filter/Ascii85.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/Ascii85Exception.php b/src/PdfParser/Filter/Ascii85Exception.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/AsciiHex.php b/src/PdfParser/Filter/AsciiHex.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/FilterException.php b/src/PdfParser/Filter/FilterException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/FilterInterface.php b/src/PdfParser/Filter/FilterInterface.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/Flate.php b/src/PdfParser/Filter/Flate.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/FlateException.php b/src/PdfParser/Filter/FlateException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/Lzw.php b/src/PdfParser/Filter/Lzw.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Filter/LzwException.php b/src/PdfParser/Filter/LzwException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/PdfParser.php b/src/PdfParser/PdfParser.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 
@@ -145,7 +145,7 @@ protected function resolveFileHeader()
     }
 
     /**
-     * Get the cross reference instance.
+     * Get the cross-reference instance.
      *
      * @return CrossReference
      * @throws CrossReferenceException

diff --git a/src/PdfParser/PdfParserException.php b/src/PdfParser/PdfParserException.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/StreamReader.php b/src/PdfParser/StreamReader.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Tokenizer.php b/src/PdfParser/Tokenizer.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfArray.php b/src/PdfParser/Type/PdfArray.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfBoolean.php b/src/PdfParser/Type/PdfBoolean.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfDictionary.php b/src/PdfParser/Type/PdfDictionary.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfHexString.php b/src/PdfParser/Type/PdfHexString.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfIndirectObject.php b/src/PdfParser/Type/PdfIndirectObject.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfIndirectObjectReference.php b/src/PdfParser/Type/PdfIndirectObjectReference.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */
 

diff --git a/src/PdfParser/Type/PdfName.php b/src/PdfParser/Type/PdfName.php
@@ -4,7 +4,7 @@
  * This file is part of FPDI
  *
  * @package   setasign\Fpdi
- * @copyright Copyright (c) 2020 Setasign GmbH & Co. KG (https://www.setasign.com)
+ * @copyright Copyright (c) 2023 Setasign GmbH & Co. KG (https://www.setasign.com)
  * @license   http://opensource.org/licenses/mit-license The MIT License
  */