Implement a custom format option (inspiredminds#7)

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+/composer.lock

.php-cs-fixer.dist.php

@@ -9,9 +9,8 @@
 EOF;
 
 $finder = (new PhpCsFixer\Finder())
-    ->exclude('Resources/contao/templates')
-    ->exclude('Fixtures')
     ->in([
+        __DIR__.'/contao',
         __DIR__.'/src',
     ])
 ;

composer.json

@@ -20,17 +20,17 @@
     },
     "require":{
         "php": ">=7.1",
-        "contao/core-bundle": "^4.9",
+        "contao/core-bundle": "^4.13",
         "isotope/isotope-core": "^2.5",
         "mpdf/mpdf": "^8.0",
         "menatwork/contao-multicolumnwizard-bundle": "^3.4",
-        "symfony/dependency-injection": "^4.0 || ^5.0",
-        "symfony/http-kernel": "^4.0 || ^5.0",
-        "symfony/event-dispatcher": "^4.0 || ^5.0",
+        "symfony/dependency-injection": "^5.4",
+        "symfony/http-kernel": "^5.4",
+        "symfony/event-dispatcher": "^5.4",
         "symfony/event-dispatcher-contracts": "^1.0 || ^2.0 || ^3.0",
-        "symfony/finder": "^4.0 || ^5.0",
-        "symfony/config": "^4.0 || ^5.0",
-        "webmozart/path-util": "^2.3"
+        "symfony/finder": "^5.4",
+        "symfony/config": "^5.4",
+        "symfony/filesystem": "^5.4"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.0 || ^3.0"
@@ -41,6 +41,13 @@
         }
     },
     "extra": {
-        "contao-manager-plugin": "InspiredMinds\\ContaoIsotopePdfTemplatesBundle\\ContaoManagerPlugin"
+        "contao-manager-plugin": "InspiredMinds\\ContaoIsotopePdfTemplatesBundle\\ContaoManager\\Plugin"
+    },
+    "config": {
+        "allow-plugins": {
+            "contao-components/installer": true,
+            "php-http/discovery": false,
+            "contao-community-alliance/composer-plugin": true
+        }
     }
 }

config/services.yaml

@@ -0,0 +1,13 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+    InspiredMinds\ContaoIsotopePdfTemplatesBundle\:
+        resource: ../src
+        exclude: ../src/{ContaoManager,DependencyInjection,Event,Isotope,Resources}
+
+    InspiredMinds\ContaoIsotopePdfTemplatesBundle\EventListener\DataContainer\IsoDocumentListener:
+        public: true
+        arguments:
+            - '%kernel.project_dir%'

contao/config/config.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the ContaoIsotopePdfTemplatesBundle bundle.
+ *
+ * (c) inspiredminds
+ *
+ * @license LGPL-3.0-or-later
+ */
+
+use InspiredMinds\ContaoIsotopePdfTemplatesBundle\Isotope\Model\Document\Template;
+use Isotope\Model\Document;
+
+Document::registerModelType('template', Template::class);

src/Resources/contao/dca/tl_iso_document.php → contao/dca/tl_iso_document.php

@@ -10,7 +10,8 @@
  * @license LGPL-3.0-or-later
  */
 
-use InspiredMinds\ContaoIsotopePdfTemplatesBundle\DataContainer\IsoDocumentListener;
+use Contao\CoreBundle\DataContainer\PaletteManipulator;
+use InspiredMinds\ContaoIsotopePdfTemplatesBundle\EventListener\DataContainer\IsoDocumentListener;
 
 $GLOBALS['TL_DCA']['tl_iso_document']['config']['onload_callback'][] = [IsoDocumentListener::class, 'onLoadCallback'];
 
@@ -104,19 +105,27 @@
     'exclude' => true,
     'inputType' => 'select',
     'options' => ['A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6', 'A7', 'A8', 'A9', 'A10'],
-    'eval' => ['tl_class' => 'w50', 'mandatory' => true],
+    'eval' => ['tl_class' => 'w50', 'includeBlankOption' => true, 'blankOptionLabel' => &$GLOBALS['TL_LANG']['tl_iso_document']['pdfFormatBlank']],
     'sql' => ['type' => 'string', 'length' => 3, 'default' => 'A4'],
 ];
 
 $GLOBALS['TL_DCA']['tl_iso_document']['fields']['pdfOrientation'] = [
     'label' => &$GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientation'],
     'exclude' => true,
     'inputType' => 'select',
-    'options' => ['P' => 'portrait', 'L' => 'landscape'],
+    'options' => ['P', 'L'],
+    'reference' => &$GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientationOptions'],
     'eval' => ['tl_class' => 'w50', 'mandatory' => true],
     'sql' => ['type' => 'string', 'length' => 1, 'default' => 'P'],
 ];
 
+$GLOBALS['TL_DCA']['tl_iso_document']['fields']['pdfFormatCustom'] = [
+    'exclude' => true,
+    'inputType' => 'text',
+    'eval' => ['tl_class' => 'w50', 'maxlength' => 32, 'multiple' => true, 'size' => 2],
+    'sql' => ['type' => 'blob', 'notnull' => false],
+];
+
 $GLOBALS['TL_DCA']['tl_iso_document']['fields']['pdfMargin'] = [
     'label' => &$GLOBALS['TL_LANG']['tl_iso_document']['pdfMargin'],
     'exclude' => true,
@@ -158,7 +167,6 @@
     'sql' => ['type' => 'string', 'length' => 128, 'default' => ''],
 ];
 
-
 $GLOBALS['TL_DCA']['tl_iso_document']['palettes']['__selector__'][] = 'usePdfTemplate';
 $GLOBALS['TL_DCA']['tl_iso_document']['palettes']['__selector__'][] = 'appendPdfTemplate';
 $GLOBALS['TL_DCA']['tl_iso_document']['palettes']['__selector__'][] = 'useCustomFonts';
@@ -167,19 +175,20 @@
 $GLOBALS['TL_DCA']['tl_iso_document']['subpalettes']['appendPdfTemplate'] = 'appendPdfTemplateSRC';
 $GLOBALS['TL_DCA']['tl_iso_document']['subpalettes']['useCustomFonts'] = 'customFontsDirectory,customFontsConfig';
 
-\Contao\CoreBundle\DataContainer\PaletteManipulator::create()
+PaletteManipulator::create()
     ->addLegend('pdftemplate_legend', 'template_legend')
-    ->addField('usePdfTemplate', 'pdftemplate_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('appendPdfTemplate', 'pdftemplate_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
+    ->addField('usePdfTemplate', 'pdftemplate_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('appendPdfTemplate', 'pdftemplate_legend', PaletteManipulator::POSITION_APPEND)
     ->addLegend('font_legend', 'pdftemplate_legend')
-    ->addField('useCustomFonts', 'font_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addLegend('pdfconfig_legend', 'pdftemplate_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_AFTER, true)
-    ->addField('pdfFormat', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfOrientation', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfMargin', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfDefaultFont', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfDefaultFontSize', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfCreator', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
-    ->addField('pdfAuthor', 'pdfconfig_legend', \Contao\CoreBundle\DataContainer\PaletteManipulator::POSITION_APPEND)
+    ->addField('useCustomFonts', 'font_legend', PaletteManipulator::POSITION_APPEND)
+    ->addLegend('pdfconfig_legend', 'pdftemplate_legend', PaletteManipulator::POSITION_AFTER, true)
+    ->addField('pdfFormat', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfOrientation', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfFormatCustom', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfMargin', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfDefaultFont', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfDefaultFontSize', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfCreator', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
+    ->addField('pdfAuthor', 'pdfconfig_legend', PaletteManipulator::POSITION_APPEND)
     ->applyToPalette('template', 'tl_iso_document')
 ;

src/Resources/contao/languages/de/default.php → contao/languages/de/default.php

@@ -11,3 +11,4 @@
  */
 
 $GLOBALS['TL_LANG']['MODEL']['tl_iso_document']['template'] = ['Vorlage', 'Vorlage'];
+$GLOBALS['TL_LANG']['ERR']['missingCustomPdfFormat'] = 'Kein eigenes Format angegeben.';

src/Resources/contao/languages/de/tl_iso_document.php → contao/languages/de/tl_iso_document.php

@@ -25,7 +25,10 @@
 $GLOBALS['TL_LANG']['tl_iso_document']['customFontsConfigFilename'] = 'Dateiname';
 $GLOBALS['TL_LANG']['tl_iso_document']['customFontsConfigFontname'] = 'Schriftarten Name';
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfFormat'] = ['Format', 'Hier wird das Format für das PDF ausgewählt.'];
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfFormatBlank'] = 'Eigenes Format';
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfFormatCustom'] = ['Eigenes Format', 'Das Format in Millimeter angeben.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientation'] = ['Ausrichtung', 'Hier wird die Ausrichtung für das PDF ausgewählt.'];
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientationOptions'] = ['P' => 'Hochformat', 'L' => 'Querformat'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfMargin'] = ['Dokumentränder', 'Hier werden die Dokumentränder für das PDF eingestellt.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfDefaultFont'] = ['Hauptschriftart', 'Die Hauptschriftart die im PDF verwendet werden soll.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfDefaultFontSize'] = ['Schriftgröße', 'Die Schriftgröße die als Basis im PDF verwendet werden soll.'];

src/Resources/contao/languages/en/default.php → contao/languages/en/default.php

@@ -11,3 +11,4 @@
  */
 
 $GLOBALS['TL_LANG']['MODEL']['tl_iso_document']['template'] = ['Template', 'Template'];
+$GLOBALS['TL_LANG']['ERR']['missingCustomPdfFormat'] = 'No custom format specified.';

src/Resources/contao/languages/en/tl_iso_document.php → contao/languages/en/tl_iso_document.php

@@ -25,7 +25,10 @@
 $GLOBALS['TL_LANG']['tl_iso_document']['customFontsConfigFilename'] = 'File name';
 $GLOBALS['TL_LANG']['tl_iso_document']['customFontsConfigFontname'] = 'Font family name';
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfFormat'] = ['Format', 'Here can you select the format for the PDF.'];
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfFormatBlank'] = 'Custom format';
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfFormatCustom'] = ['Custom format', 'Enter the width and height in millimeters.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientation'] = ['Orientation', 'Here can you select the orientantion for the PDF.'];
+$GLOBALS['TL_LANG']['tl_iso_document']['pdfOrientationOptions'] = ['P' => 'Portrait', 'L' => 'Landscape'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfMargin'] = ['Document margins', 'Here the document margins for the PDF are set.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfDefaultFont'] = ['Main font', 'The main font to be used in the PDF.'];
 $GLOBALS['TL_LANG']['tl_iso_document']['pdfDefaultFontSize'] = ['Font size', 'The font size to be used as the base in the PDF.'];

src/ContaoIsotopePdfTemplatesBundle.php

@@ -16,4 +16,8 @@
 
 class ContaoIsotopePdfTemplatesBundle extends Bundle
 {
+    public function getPath()
+    {
+        return \dirname(__DIR__);
+    }
 }

src/ContaoManagerPlugin.php → src/ContaoManager/Plugin.php

@@ -10,17 +10,15 @@
  * @license LGPL-3.0-or-later
  */
 
-namespace InspiredMinds\ContaoIsotopePdfTemplatesBundle;
+namespace InspiredMinds\ContaoIsotopePdfTemplatesBundle\ContaoManager;
 
 use Contao\CoreBundle\ContaoCoreBundle;
 use Contao\ManagerPlugin\Bundle\BundlePluginInterface;
 use Contao\ManagerPlugin\Bundle\Config\BundleConfig;
 use Contao\ManagerPlugin\Bundle\Parser\ParserInterface;
+use InspiredMinds\ContaoIsotopePdfTemplatesBundle\ContaoIsotopePdfTemplatesBundle;
 
-/**
- * Plugin for the Contao Manager.
- */
-class ContaoManagerPlugin implements BundlePluginInterface
+class Plugin implements BundlePluginInterface
 {
     /**
      * {@inheritdoc}

src/DependencyInjection/ContaoIsotopePdfTemplatesExtension.php

@@ -21,7 +21,8 @@ class ContaoIsotopePdfTemplatesExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
-        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
-        $loader->load('services.yml');
+        (new YamlFileLoader($container, new FileLocator(__DIR__.'/../../config')))
+            ->load('services.yaml')
+        ;
     }
 }

src/DataContainer/IsoDocumentListener.php → src/EventListener/DataContainer/IsoDocumentListener.php

@@ -10,7 +10,7 @@
  * @license LGPL-3.0-or-later
  */
 
-namespace InspiredMinds\ContaoIsotopePdfTemplatesBundle\DataContainer;
+namespace InspiredMinds\ContaoIsotopePdfTemplatesBundle\EventListener\DataContainer;
 
 use Contao\DataContainer;
 use Contao\FilesModel;

src/EventListener/DataContainer/TemplateCustomFormatSaveListener.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the ContaoIsotopePdfTemplatesBundle bundle.
+ *
+ * (c) inspiredminds
+ *
+ * @license LGPL-3.0-or-later
+ */
+
+namespace InspiredMinds\ContaoIsotopePdfTemplatesBundle\EventListener\DataContainer;
+
+use Contao\CoreBundle\ServiceAnnotation\Callback;
+use Contao\StringUtil;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * @Callback(table="tl_iso_document", target="fields.pdfFormatCustom.save")
+ */
+class TemplateCustomFormatSaveListener
+{
+    private RequestStack $requestStack;
+    private TranslatorInterface $translator;
+
+    public function __construct(RequestStack $requestStack, TranslatorInterface $translator)
+    {
+        $this->requestStack = $requestStack;
+        $this->translator = $translator;
+    }
+
+    public function __invoke($value): string
+    {
+        $request = $this->requestStack->getCurrentRequest();
+        $values = StringUtil::deserialize($value, true) + ['', ''];
+
+        if (!array_filter($values) && !$request->request->get('pdfFormat')) {
+            throw new \Exception($this->translator->trans('ERR.missingCustomPdfFormat', [], 'contao_default'));
+        }
+
+        return serialize(array_map('floatval', $values));
+    }
+}

src/Isotope/Model/Document/Template.php

@@ -18,11 +18,11 @@
 use Contao\System;
 use InspiredMinds\ContaoIsotopePdfTemplatesBundle\Event\ModifyPdfEvent;
 use Isotope\Interfaces\IsotopeProductCollection;
-use Webmozart\PathUtil\Path;
+use Symfony\Component\Filesystem\Path;
 
 class Template extends \Isotope\Model\Document\Standard
 {
-    public function outputToBrowser(IsotopeProductCollection $objCollection)
+    public function outputToBrowser(IsotopeProductCollection $objCollection): void
     {
         parent::outputToBrowser($objCollection);
 
@@ -68,6 +68,10 @@ protected function generatePDF(IsotopeProductCollection $objCollection, array $a
 
         $margin = StringUtil::deserialize($this->pdfMargin, true);
 
+        if (!$this->pdfFormat) {
+            $this->pdfFormat = array_map('floatval', StringUtil::deserialize($this->pdfFormatCustom, true)) + [210.0, 297.0];
+        }
+
         // Create new PDF document
         $pdf = new \Mpdf\Mpdf([
             'fontDir' => $fontDirs,