Merge pull request #48 from dreistromland-tj/task/typo3_v13_compatibi…

…lity Ad TYPO3 v13 compatibility, drop v11
tritum · Dec 3, 2024 · d0340df · d0340df
2 parents 698e177 + 4dc4859
commit d0340df
Show file tree

Hide file tree

Showing 22 changed files with 319 additions and 316 deletions.
diff --git a/Classes/Configuration/Extension.php b/Classes/Configuration/Extension.php
@@ -25,11 +25,7 @@
 namespace TRITUM\RepeatableFormElements\Configuration;
 
 use TRITUM\RepeatableFormElements\Hooks\FormHooks;
-use TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider;
-use TYPO3\CMS\Core\Imaging\IconRegistry;
-use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
-use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * Extension
@@ -58,26 +54,9 @@ public static function addTypoScriptSetup(): void
         '));
     }
 
-    public static function registerIcons(): void
-    {
-        if ('12.4' <= self::getTypo3Version()) return;
-
-        $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
-        $iconRegistry->registerIcon(
-            't3-form-icon-repeatable-container',
-            SvgIconProvider::class,
-            ['source' => 'EXT:repeatable_form_elements/Resources/Public/Icons/t3-form-icon-repeatable-container.svg']
-        );
-    }
-
     public static function registerHooks(): void
     {
         $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterInitializeCurrentPage'][1511196413] = FormHooks::class;
         $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['beforeRendering'][1511196413] = FormHooks::class;
     }
-
-    private static function getTypo3Version() : string
-    {
-        return (new Typo3Version())->getVersion();
-    }
 }
diff --git a/Classes/Event/CopyVariantEvent.php b/Classes/Event/CopyVariantEvent.php
@@ -25,16 +25,15 @@ class CopyVariantEvent
     private bool $variantEnabled = true;
 
     public function __construct(
-        array                $options,
+        array $options,
         FormElementInterface $originalFormElement,
         FormElementInterface $newFormElement,
-        string               $newIdentifier
-    )
-    {
-        $this->options             = $options;
+        string $newIdentifier,
+    ) {
+        $this->options = $options;
         $this->originalFormElement = $originalFormElement;
-        $this->newFormElement      = $newFormElement;
-        $this->newIdentifier       = $newIdentifier;
+        $this->newFormElement = $newFormElement;
+        $this->newIdentifier = $newIdentifier;
     }
 
     public function getOptions(): array
@@ -71,6 +70,4 @@ public function setVariantEnabled(bool $variantEnabled): void
     {
         $this->variantEnabled = $variantEnabled;
     }
-
-
 }
diff --git a/Classes/EventListener/AdaptVariantConditionEventListener.php b/Classes/EventListener/AdaptVariantConditionEventListener.php
@@ -13,12 +13,10 @@
 
 use TRITUM\RepeatableFormElements\Event\CopyVariantEvent;
 
-
 /**
  * Replace original identifiers inside variant condition with identifiers of new element
  *
  * @param CopyVariantEvent $event
- * @return void
  */
 final class AdaptVariantConditionEventListener
 {
@@ -30,19 +28,19 @@ public function __invoke(CopyVariantEvent $event): void
         // get path strings for identifiers for replacement in condition
         // e.g. for `traverse(formValues, 'repeatablecontainer-1.0.checkbox-1')`
         $originalIdentifierAsPath = str_replace('.', '/', $originalIdentifier);
-        $newIdentifierAsPath      = str_replace('.', '/', $event->getNewIdentifier());
+        $newIdentifierAsPath = str_replace('.', '/', $event->getNewIdentifier());
 
         // adapt original condition to match identifier of the copied form element
         $options['condition'] = str_replace(
             [
                 $originalIdentifier,
-                $originalIdentifierAsPath
+                $originalIdentifierAsPath,
             ],
             [
                 $event->getNewIdentifier(),
-                $newIdentifierAsPath
+                $newIdentifierAsPath,
             ],
-            $options['condition']
+            $options['condition'],
         );
 
         $event->setOptions($options);

diff --git a/Classes/Finisher/SaveToDatabaseFinisher.php b/Classes/Finisher/SaveToDatabaseFinisher.php
@@ -19,12 +19,12 @@
 use TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface;
 
 /**
- * This finisher is an extension to the default SaveToDatabaseFinisher. 
+ * This finisher is an extension to the default SaveToDatabaseFinisher.
  * It is intentionally registered as a new identifier to keep compatibility with existing forms.
  */
 class SaveToDatabaseFinisher extends \TYPO3\CMS\Form\Domain\Finishers\SaveToDatabaseFinisher
 {
-    protected function process(int $iterationCount)
+    protected function process(int $iterationCount): void
     {
         $this->throwExceptionOnInconsistentConfiguration();
 
@@ -68,10 +68,14 @@ protected function process(int $iterationCount)
      * @param array $databaseData prepared data
      * @param string $table Tablename to save data to
      * @param int $iterationCount finisher iteration
-     * @return void
      */
-    protected function processContainer(string $containerPath, array $elementsConfiguration, array $databaseData, string $table, int $iterationCount)
-    {
+    protected function processContainer(
+        string $containerPath,
+        array $elementsConfiguration,
+        array $databaseData,
+        string $table,
+        int $iterationCount,
+    ): void {
         $containerValues = ArrayUtility::getValueByPath($this->getFormValues(), $containerPath, '.');
         foreach ($containerValues as $copyId => $containerItem) {
             $prefix = $containerPath . '.' . $copyId . '.';
@@ -90,8 +94,12 @@ protected function processContainer(string $containerPath, array $elementsConfig
      * @param string $prefix prefix to get the form element object by a full identifier
      * @return array the filled database data
      */
-    protected function prepareData(array $elementsConfiguration, array $databaseData, array $values = [], string $prefix = ''): array
-    {
+    protected function prepareData(
+        array $elementsConfiguration,
+        array $databaseData,
+        array $values = [],
+        string $prefix = '',
+    ): array {
         if (empty($values)) {
             $values = $this->getFormValues();
         }
@@ -131,8 +139,12 @@ protected function prepareData(array $elementsConfiguration, array $databaseData
      * $databaseData into the table $table
      * and provide some finisher variables
      */
-    protected function saveToDatabase(array $databaseData, string $table, int $iterationCount, ?int $containerItemKey = null)
-    {
+    protected function saveToDatabase(
+        array $databaseData,
+        string $table,
+        int $iterationCount,
+        ?int $containerItemKey = null,
+    ): void {
         if (!empty($databaseData)) {
             if ($this->parseOption('mode') === 'update') {
                 $whereClause = $this->parseOption('whereClause');
@@ -142,26 +154,27 @@ protected function saveToDatabase(array $databaseData, string $table, int $itera
                 $this->databaseConnection->update(
                     $table,
                     $databaseData,
-                    $whereClause
+                    $whereClause,
                 );
             } else {
                 $this->databaseConnection->insert($table, $databaseData);
                 $insertedUid = (int)$this->databaseConnection->lastInsertId($table);
                 $this->finisherContext->getFinisherVariableProvider()->add(
                     $this->shortFinisherIdentifier,
                     'insertedUids.' . $iterationCount . (is_int($containerItemKey) ? '.' . $containerItemKey : ''),
-                    $insertedUid
+                    $insertedUid,
                 );
 
                 $currentCount = $this->finisherContext->getFinisherVariableProvider()->get(
                     $this->shortFinisherIdentifier,
-                    'countInserts.', $iterationCount,
-                    0
+                    'countInserts.',
+                    $iterationCount,
+                    0,
                 );
                 $this->finisherContext->getFinisherVariableProvider()->addOrUpdate(
                     $this->shortFinisherIdentifier,
                     'countInserts.' . $iterationCount,
-                    $currentCount++
+                    $currentCount++,
                 );
             }
         }

diff --git a/Classes/FormElements/RepeatableContainer.php b/Classes/FormElements/RepeatableContainer.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace TRITUM\RepeatableFormElements\FormElements;
 
@@ -12,6 +12,4 @@
  */
 use TYPO3\CMS\Form\Domain\Model\FormElements\Section;
 
-class RepeatableContainer extends Section implements RepeatableContainerInterface
-{
-}
+class RepeatableContainer extends Section implements RepeatableContainerInterface {}
diff --git a/Classes/FormElements/RepeatableContainerInterface.php b/Classes/FormElements/RepeatableContainerInterface.php
@@ -1,5 +1,7 @@
 <?php
-declare(strict_types = 1);
+
+declare(strict_types=1);
+
 namespace TRITUM\RepeatableFormElements\FormElements;
 
 /**
@@ -10,6 +12,4 @@
  */
 use TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface;
 
-interface RepeatableContainerInterface extends CompositeRenderableInterface
-{
-}
+interface RepeatableContainerInterface extends CompositeRenderableInterface {}
diff --git a/Classes/Hooks/FormHooks.php b/Classes/Hooks/FormHooks.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace TRITUM\RepeatableFormElements\Hooks;
 
@@ -14,6 +14,7 @@
 use TRITUM\RepeatableFormElements\Service\CopyService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface;
+use TYPO3\CMS\Form\Domain\Model\Exception\DuplicateFormElementException;
 use TYPO3\CMS\Form\Domain\Model\FormElements\AbstractFormElement;
 use TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface;
 use TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface;
@@ -28,13 +29,15 @@ class FormHooks
      * @param CompositeRenderableInterface|null $currentPage
      * @param CompositeRenderableInterface|null $lastPage
      * @param array $rawRequestArguments
+     *
      * @return CompositeRenderableInterface|null
+     * @throws DuplicateFormElementException
      */
     public function afterInitializeCurrentPage(
         FormRuntime $formRuntime,
         CompositeRenderableInterface $currentPage = null,
         CompositeRenderableInterface $lastPage = null,
-        array $rawRequestArguments = []
+        array $rawRequestArguments = [],
     ): ?CompositeRenderableInterface {
         foreach ($formRuntime->getPages() as $page) {
             $this->setRootRepeatableContainerIdentifiers($page, $formRuntime);
@@ -76,16 +79,18 @@ public function beforeRendering(FormRuntime $formRuntime, RootRenderableInterfac
     }
 
     /**
-     * @param RenderableInterface $formElement
+     * @param RenderableInterface $renderable
      * @param FormRuntime $formRuntime
      * @param array $repeatableContainerIdentifiers
+     *
+     * @throws DuplicateFormElementException
      */
     protected function setRootRepeatableContainerIdentifiers(
         RenderableInterface $renderable,
         FormRuntime $formRuntime,
-        array $repeatableContainerIdentifiers = []
+        array $repeatableContainerIdentifiers = [],
     ): void {
-        $isRepeatableContainer = $renderable instanceof RepeatableContainerInterface ? true : false;
+        $isRepeatableContainer = $renderable instanceof RepeatableContainerInterface;
 
         $hasOriginalIdentifier = isset($renderable->getRenderingOptions()['_originalIdentifier']);
         if ($isRepeatableContainer) {
@@ -104,7 +109,7 @@ protected function setRootRepeatableContainerIdentifiers(
             $originalIdentifier = $renderable->getIdentifier();
             $renderable->setRenderingOption('_originalIdentifier', $originalIdentifier);
 
-            if($renderable instanceof AbstractFormElement && $renderable->getDefaultValue()) {
+            if ($renderable instanceof AbstractFormElement && $renderable->getDefaultValue()) {
                 $formRuntime->getFormDefinition()->addElementDefaultValue($newIdentifier, $renderable->getDefaultValue());
             }
 
@@ -139,14 +144,15 @@ protected function setRootRepeatableContainerIdentifiers(
      * returns TRUE if the user went back to any previous step in the form.
      *
      * @param FormRuntime $formRuntime
-     * @param CompositeRenderableInterface $currentPage
-     * @param CompositeRenderableInterface $lastPage
+     * @param CompositeRenderableInterface|null $currentPage
+     * @param CompositeRenderableInterface|null $lastPage
+     *
      * @return bool
      */
     protected function userWentBackToPreviousStep(
         FormRuntime $formRuntime,
         CompositeRenderableInterface $currentPage = null,
-        CompositeRenderableInterface $lastPage = null
+        CompositeRenderableInterface $lastPage = null,
     ): bool {
         return $currentPage !== null
                 && $lastPage !== null