[FEATURE] Add showNewRecordLink option

This option is available in TYPO3 v11 and replaces levelLinksPosition with "none" set.
liayn · Mar 20, 2022 · 5bbd770 · 5bbd770
1 parent 33c029e
commit 5bbd770
Show file tree

Hide file tree

Showing 9 changed files with 95 additions and 3 deletions.
diff --git a/Classes/ConfigurationLoader/ConfigurationLoader.php b/Classes/ConfigurationLoader/ConfigurationLoader.php
@@ -17,6 +17,7 @@
 
 namespace MASK\Mask\ConfigurationLoader;
 
+use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 class ConfigurationLoader implements ConfigurationLoaderInterface
@@ -61,6 +62,21 @@ public function loadTcaFields(): array
             return $this->tcaFields;
         }
         $this->tcaFields = require GeneralUtility::getFileAbsFileName('EXT:mask/Configuration/Mask/TcaFields.php');
+
+        $typo3Version = (new Typo3Version())->getMajorVersion();
+
+        // levelLinksPosition "none" deprecated since TYPO3 v11.
+        if ($typo3Version > 10) {
+            unset($this->tcaFields['config.appearance.levelLinksPosition']['items']['none']);
+        }
+
+        // Remove options not available in current TYPO3 version.
+        foreach ($this->tcaFields as $key => $tcaField) {
+            if (($tcaField['version'] ?? 0) > $typo3Version) {
+                unset($this->tcaFields[$key]);
+            }
+        }
+
         return $this->tcaFields;
     }
 

diff --git a/Classes/Definition/TcaFieldDefinition.php b/Classes/Definition/TcaFieldDefinition.php
@@ -20,6 +20,7 @@
 use MASK\Mask\Enumeration\FieldType;
 use MASK\Mask\Utility\AffixUtility;
 use MASK\Mask\Utility\FieldTypeUtility;
+use TYPO3\CMS\Core\Information\Typo3Version;
 
 final class TcaFieldDefinition
 {
@@ -113,6 +114,17 @@ public static function createFromFieldArray(array $definition): TcaFieldDefiniti
             $tcaFieldDefinition->type = FieldType::cast($fieldType);
         }
 
+        // Migrate levelLinksPosition "none" to showNewRecordLink=false (TYPO3 v11).
+        if (
+            (new Typo3Version())->getMajorVersion() > 10
+            && $tcaFieldDefinition->type instanceof FieldType
+            && ($tcaFieldDefinition->type->equals(FieldType::INLINE) || $tcaFieldDefinition->type->equals(FieldType::CONTENT))
+            && ($definition['config']['appearance']['levelLinksPosition'] ?? '') === 'none'
+        ) {
+            $definition['config']['appearance']['levelLinksPosition'] = 'top';
+            $definition['config']['appearance']['showNewRecordLink'] = 0;
+        }
+
         // Now config is clean. Extract real TCA.
         $tcaFieldDefinition->realTca = self::extractRealTca($definition, $tcaFieldDefinition);
 

diff --git a/Configuration/Mask/Defaults.php b/Configuration/Mask/Defaults.php
@@ -195,6 +195,7 @@
             'config.appearance.levelLinksPosition' => 'top',
             'config.appearance.showPossibleLocalizationRecords' => 1,
             'config.appearance.showAllLocalizationLink' => 1,
+            'config.appearance.showNewRecordLink' => 1,
         ],
         'tca_out' => [
             'config.type' => 'inline',
@@ -212,6 +213,7 @@
             'config.appearance.levelLinksPosition' => 'top',
             'config.appearance.showPossibleLocalizationRecords' => 1,
             'config.appearance.showAllLocalizationLink' => 1,
+            'config.appearance.showNewRecordLink' => 1,
         ],
         'tca_out' => [
             'config.type' => 'inline',

diff --git a/Configuration/Mask/Tabs/content.php b/Configuration/Mask/Tabs/content.php
@@ -17,7 +17,8 @@
     TAB::APPEARANCE => [
         [
             'config.appearance.newRecordLinkTitle' => 6,
-            'config.appearance.levelLinksPosition' => 6
+            'config.appearance.levelLinksPosition' => 6,
+            'config.appearance.showNewRecordLink' => 6,
         ],
         [
             'config.appearance.expandSingle' => 6,

diff --git a/Configuration/Mask/Tabs/inline.php b/Configuration/Mask/Tabs/inline.php
@@ -18,7 +18,8 @@
     TAB::APPEARANCE => [
         [
             'config.appearance.newRecordLinkTitle' => 6,
-            'config.appearance.levelLinksPosition' => 6
+            'config.appearance.levelLinksPosition' => 6,
+            'config.appearance.showNewRecordLink' => 6,
         ],
         [
             'config.appearance.collapseAll' => 6,

diff --git a/Configuration/Mask/TcaFields.php b/Configuration/Mask/TcaFields.php
@@ -729,6 +729,13 @@
         'code' => 'levelLinksPosition',
         'documentation' => 'ColumnsConfig/Type/Inline.html?highlight=levellinksposition#appearance'
     ],
+    'config.appearance.showNewRecordLink' => [
+        'type' => 'checkbox',
+        'label' => 'tx_mask.field.inline.show_new_record_link.label',
+        'description' => 'tx_mask.field.inline.show_new_record_link.description',
+        'code' => 'showNewRecordLink',
+        'version' => 11,
+    ],
     'ctrl.label' => [
         'type' => 'text',
         'label' => 'tx_mask.all.label',

diff --git a/Resources/Private/Language/locallang.xlf b/Resources/Private/Language/locallang.xlf
@@ -438,6 +438,12 @@ title3, value3, icon3, description3
 			<trans-unit id="tx_mask.field.inline.level_links_position.none">
 				<source>None</source>
 			</trans-unit>
+			<trans-unit id="tx_mask.field.inline.show_new_record_link.label">
+				<source>Show "New record" link</source>
+			</trans-unit>
+			<trans-unit id="tx_mask.field.inline.show_new_record_link.description">
+				<source>If disabled, the "New record" link button is removed.</source>
+			</trans-unit>
 			<trans-unit id="tx_mask.allowed_content">
 				<source>Allowed content elements</source>
 			</trans-unit>

diff --git a/Resources/Public/JavaScript/Components/FormField.js b/Resources/Public/JavaScript/Components/FormField.js
@@ -72,6 +72,10 @@ define([
         },
         computed: {
           field: function () {
+            if (typeof this.tcaFields[this.tcaKey] === 'undefined') {
+              return {available: false};
+            }
+            this.tcaFields[this.tcaKey].available = true;
             if (this.global.activeField.name in this.tcaFields[this.tcaKey]) {
               return this.tcaFields[this.tcaKey][this.global.activeField.name];
             } else if ('other' in this.tcaFields[this.tcaKey]) {
@@ -128,7 +132,7 @@ define([
           }
         },
         template: `
-          <div :class="['form-group', 'col-sm-12 col-xl-' + column, {'has-error': hasError}]">
+          <div v-if="field.available" :class="['form-group', 'col-sm-12 col-xl-' + column, {'has-error': hasError}]">
             <label class="t3js-formengine-label" :for="tcaKey">
                 {{ field.label }}
             </label>

diff --git a/Tests/Unit/Definition/TcaFieldDefinitionTest.php b/Tests/Unit/Definition/TcaFieldDefinitionTest.php
@@ -18,6 +18,7 @@
 namespace MASK\Mask\Tests\Unit\Definition;
 
 use MASK\Mask\Definition\TcaFieldDefinition;
+use TYPO3\CMS\Core\Information\Typo3Version;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
 class TcaFieldDefinitionTest extends UnitTestCase
@@ -139,6 +140,48 @@ public function createFromArrayWorksOnLegacyFormatDataProvider(): iterable
                 'fullKey' => 'tx_mask_field1',
             ]
         ];
+
+        $expected = [
+            'config' => [
+                'type' => 'inline',
+                'appearance' => [
+                    'levelLinksPosition' => 'none',
+                ]
+            ],
+            'type' => 'inline',
+            'key' => 'inline1',
+            'fullKey' => 'tx_mask_inline1',
+        ];
+
+        if ((new Typo3Version())->getMajorVersion() > 10) {
+            $expected = [
+                'config' => [
+                    'type' => 'inline',
+                    'appearance' => [
+                        'levelLinksPosition' => 'top',
+                        'showNewRecordLink' => 0,
+                    ]
+                ],
+                'type' => 'inline',
+                'key' => 'inline1',
+                'fullKey' => 'tx_mask_inline1',
+            ];
+        }
+
+        yield 'levelLinksPosition "none" migrated in TYPO3 v11 to showNewRecordLink' => [
+            'json' => [
+                'config' => [
+                    'type' => 'inline',
+                    'appearance' => [
+                        'levelLinksPosition' => 'none',
+                    ]
+                ],
+                'type' => 'inline',
+                'key' => 'inline1',
+                'fullKey' => 'tx_mask_inline1',
+            ],
+            'expected' => $expected,
+        ];
     }
 
     /**