Possibility to generate PDFa invoice documents

Signed-off-by: Anton Fedurtsya <anton@fedurtsya.com>
Fresh-Advance · Oct 1, 2023 · 99514dc · 99514dc
1 parent a3b89b6
commit 99514dc
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 - Php 8.1 and Mysql 8.0 supported
+- Possibility to generate PDFA format invoice documents
 
 ### Changed
 - Inverted dependencies on most of the classes to extracted interfaces

diff --git a/metadata.php b/metadata.php
@@ -46,6 +46,12 @@
             'type' => 'str',
             'value' => 'invoice-'
         ],
+        [
+            'group' => 'fa_invoice_main',
+            'name' => \FreshAdvance\Invoice\Service\ModuleSettings::SETTING_DOCUMENT_IS_FOR_ARCHIVE,
+            'type' => 'bool',
+            'value' => false
+        ],
     ],
     'events' => [
         'onActivate' => '\FreshAdvance\Invoice\Transition\Core\Events::onActivate',

diff --git a/src/Document/MpdfDocument/MpdfFactory.php b/src/Document/MpdfDocument/MpdfFactory.php
@@ -9,16 +9,20 @@
 
 namespace FreshAdvance\Invoice\Document\MpdfDocument;
 
+use FreshAdvance\Invoice\Service\ModuleSettingsInterface;
 use Mpdf\Mpdf;
 
 class MpdfFactory
 {
     public function __construct(
+        private ModuleSettingsInterface $moduleSettings
     ) {
     }
 
     public function create(): Mpdf
     {
-        return new Mpdf();
+        return new Mpdf([
+            'PDFA' => $this->moduleSettings->isForArchive()
+        ]);
     }
 }
diff --git a/src/Service/ModuleSettings.php b/src/Service/ModuleSettings.php
@@ -16,6 +16,7 @@ class ModuleSettings implements ModuleSettingsInterface
 {
     public const SETTING_DOCUMENT_FOOTER = 'fa_invoice_DocumentFooter';
     public const SETTING_DOCUMENT_FILENAME_PREFIX = 'fa_invoice_FilenamePrefix';
+    public const SETTING_DOCUMENT_IS_FOR_ARCHIVE = 'fa_invoice_IsForArchive';
 
     public function __construct(
         private ModuleSettingServiceInterface $moduleSettingService
@@ -32,6 +33,14 @@ public function getFilePrefix(): string
         return $this->getStringSetting(self::SETTING_DOCUMENT_FILENAME_PREFIX);
     }
 
+    public function isForArchive(): bool
+    {
+        return $this->moduleSettingService->getBoolean(
+            self::SETTING_DOCUMENT_IS_FOR_ARCHIVE,
+            Module::MODULE_ID
+        );
+    }
+
     private function getStringSetting(string $key): string
     {
         return $this->moduleSettingService

diff --git a/src/Service/ModuleSettingsInterface.php b/src/Service/ModuleSettingsInterface.php
@@ -7,4 +7,6 @@ interface ModuleSettingsInterface
     public function getDocumentFooter(): string;
 
     public function getFilePrefix(): string;
+
+    public function isForArchive(): bool;
 }
diff --git a/tests/Integration/Document/MpdfDocument/MpdfFactoryTest.php b/tests/Integration/Document/MpdfDocument/MpdfFactoryTest.php
@@ -10,6 +10,7 @@
 namespace Document\MpdfDocument;
 
 use FreshAdvance\Invoice\Document\MpdfDocument\MpdfFactory;
+use FreshAdvance\Invoice\Service\ModuleSettingsInterface;
 use Mpdf\Mpdf;
 use PHPUnit\Framework\TestCase;
 
@@ -20,7 +21,22 @@ class MpdfFactoryTest extends TestCase
 {
     public function testCreate(): void
     {
-        $sut = new MpdfFactory();
+        $sut = new MpdfFactory(
+            moduleSettings: $this->createStub(ModuleSettingsInterface::class)
+        );
         $this->assertInstanceOf(Mpdf::class, $sut->create());
     }
+
+    public function testArchiveFlagConfigured(): void
+    {
+        $settingsStub = $this->createMock(ModuleSettingsInterface::class);
+        $settingsStub->method('isForArchive')->willReturn(true);
+
+        $sut = new MpdfFactory(
+            moduleSettings: $settingsStub
+        );
+        $object = $sut->create();
+
+        $this->assertSame(true, $object->PDFA);
+    }
 }
diff --git a/tests/Unit/Service/ModuleSettingsTest.php b/tests/Unit/Service/ModuleSettingsTest.php
@@ -42,4 +42,26 @@ public function testGetFilenamePrefix(): void
         $sut = new ModuleSettings($mssMock);
         $this->assertSame($value, $sut->getFilePrefix());
     }
+
+    /**
+     * @dataProvider booleanDataProvider
+     */
+    public function testIsForArchive(bool $value): void
+    {
+        $mssMock = $this->createPartialMock(ModuleSettingService::class, ['getBoolean']);
+        $mssMock->method('getBoolean')->willReturnMap([
+            [ModuleSettings::SETTING_DOCUMENT_IS_FOR_ARCHIVE, Module::MODULE_ID, $value]
+        ]);
+
+        $sut = new ModuleSettings($mssMock);
+        $this->assertSame($value, $sut->isForArchive());
+    }
+
+    public function booleanDataProvider(): array
+    {
+        return [
+            [true],
+            [false]
+        ];
+    }
 }
diff --git a/views/admin_twig/de/fainvoice_lang.php b/views/admin_twig/de/fainvoice_lang.php
@@ -40,4 +40,5 @@
     'SHOP_MODULE_GROUP_fa_invoice_main' => 'Invoice document',
     'SHOP_MODULE_fa_invoice_DocumentFooter' => 'Document Footer',
     'SHOP_MODULE_fa_invoice_FilenamePrefix' => 'Filename Prefix',
+    'SHOP_MODULE_fa_invoice_IsForArchive' => 'Document is for archive (PDFA)',
 ];
diff --git a/views/admin_twig/en/fainvoice_lang.php b/views/admin_twig/en/fainvoice_lang.php
@@ -40,4 +40,5 @@
     'SHOP_MODULE_GROUP_fa_invoice_main' => 'Invoice document',
     'SHOP_MODULE_fa_invoice_DocumentFooter' => 'Document Footer',
     'SHOP_MODULE_fa_invoice_FilenamePrefix' => 'Filename Prefix',
+    'SHOP_MODULE_fa_invoice_IsForArchive' => 'Document is for archive (PDFA)',
 ];
diff --git a/views/admin_twig/lt/fainvoice_lang.php b/views/admin_twig/lt/fainvoice_lang.php
@@ -40,4 +40,5 @@
     'SHOP_MODULE_GROUP_fa_invoice_main' => 'Invoice document',
     'SHOP_MODULE_fa_invoice_DocumentFooter' => 'Document Footer',
     'SHOP_MODULE_fa_invoice_FilenamePrefix' => 'Filename Prefix',
+    'SHOP_MODULE_fa_invoice_IsForArchive' => 'Document is for archive (PDFA)',
 ];