[FEATURE] Make IsFieldEnabledViewHelper configurable (#2059)

Author: oliverklee

CHANGELOG.md

@@ -7,6 +7,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Added
 
+- Make configuration key for `IsFieldEnabledViewHelper` configurable (#2059)
+
 ### Changed
 
 ### Deprecated

Classes/ViewHelpers/IsFieldEnabledViewHelper.php

@@ -15,8 +15,8 @@
  * You can provide either a single field name or multiple field names separated by the pipe character (which serves
  * as a logical OR).
  *
- * The name of the fields in the settings carrying the list of enabled fields needs to be provided in the
- * :php:`SETTING_FOR_ENABLED_FIELDS` constant.
+ * The name of the fields in the settings carrying the list of enabled fields can be changed with the
+ * `configurationKey` argument.
  *
  * Examples
  * ========
@@ -56,23 +56,30 @@
  */
 class IsFieldEnabledViewHelper extends AbstractConditionViewHelper
 {
-    /**
-     * @var non-empty-string
-     */
-    protected const SETTING_FOR_ENABLED_FIELDS = 'fieldsToShow';
-
     public function initializeArguments(): void
     {
         parent::initializeArguments();
         $this->registerArgument('fieldName', 'string', 'The name(s) of the fields to check, separated by |.', true);
+        $this->registerArgument('configurationKey', 'string', 'The configuration key to use.', false, 'fieldsToShow');
     }
 
     /**
      * @param array<string, mixed> $arguments
      */
     public static function verdict(array $arguments, RenderingContextInterface $renderingContext): bool
     {
-        $enabledFields = self::getEnabledFields($renderingContext);
+        $configurationKey = $arguments['configurationKey'] ?? null;
+        if (!\is_string($configurationKey)) {
+            throw new \UnexpectedValueException(
+                'The variable "configurationKey" must be a string, but was: ' . \gettype($configurationKey),
+                1743708980
+            );
+        }
+        if ($configurationKey === '') {
+            throw new \UnexpectedValueException('The variable "configurationKey" must not be empty.', 1743709004);
+        }
+
+        $enabledFields = self::getEnabledFields($renderingContext, $configurationKey);
 
         $verdict = false;
         foreach (self::getFieldsToCheck($arguments) as $fieldName) {
@@ -106,35 +113,35 @@ private static function getFieldsToCheck(array $arguments): array
             throw new \InvalidArgumentException('The argument "fieldName" must not be empty.', 1_651_155_957);
         }
 
-        $result = GeneralUtility::trimExplode('|', $fieldsNamesArgument, true);
-
-        return $result;
+        return GeneralUtility::trimExplode('|', $fieldsNamesArgument, true);
     }
 
     /**
+     * @param non-empty-string $configurationKey
+     *
      * @return list<non-empty-string>
      *
      * @throws \UnexpectedValueException
      */
-    private static function getEnabledFields(RenderingContextInterface $renderingContext): array
-    {
+    private static function getEnabledFields(
+        RenderingContextInterface $renderingContext,
+        string $configurationKey
+    ): array {
         $settings = $renderingContext->getVariableProvider()->get('settings');
         if (!\is_array($settings)) {
             throw new \UnexpectedValueException('No settings in the variable container found.', 1_651_153_736);
         }
-
-        $enabledFieldsVariable = self::SETTING_FOR_ENABLED_FIELDS;
-        if (!isset($settings[$enabledFieldsVariable])) {
+        if (!isset($settings[$configurationKey])) {
             throw new \UnexpectedValueException(
-                'No field "' . $enabledFieldsVariable . '" in settings found.',
+                'No field "' . $configurationKey . '" in settings found.',
                 1_651_154_598
             );
         }
 
-        $enabledFieldsConfiguration = $settings[$enabledFieldsVariable];
+        $enabledFieldsConfiguration = $settings[$configurationKey];
         if (!\is_string($enabledFieldsConfiguration)) {
             throw new \UnexpectedValueException(
-                'The setting "' . $enabledFieldsVariable . '" needs to be a string.',
+                'The setting "' . $configurationKey . '" needs to be a string.',
                 1_651_155_151
             );
         }

Tests/Functional/ViewHelpers/IsFieldEnabledViewHelperTest.php

@@ -246,4 +246,73 @@ public function renderEscapesChildren(): void
 
         self::assertStringContainsString('a&b', $result);
     }
+
+    /**
+     * @test
+     */
+    public function renderForBothRequestedConfiguredFieldsEnabledRendersThenChild(): void
+    {
+        $this->variableProvider->add('settings', ['columns' => 'company,name']);
+
+        $html = '<oelib:isFieldEnabled configurationKey="columns" fieldName="company|name" then="THEN" else="ELSE"/>';
+        $result = $this->renderViewHelper($html);
+
+        self::assertStringContainsString('THEN', $result);
+    }
+
+    /**
+     * @test
+     */
+    public function renderForSingleRequestedConfiguredFieldEnabledRendersThenChild(): void
+    {
+        $this->variableProvider->add('settings', ['columns' => 'company']);
+
+        $html = '<oelib:isFieldEnabled configurationKey="columns" fieldName="company" then="THEN" else="ELSE"/>';
+        $result = $this->renderViewHelper($html);
+
+        self::assertStringContainsString('THEN', $result);
+    }
+
+    /**
+     * @test
+     */
+    public function renderForRequestedConfiguredFieldNotEnabledRendersElseChild(): void
+    {
+        $this->variableProvider->add('settings', ['columns' => 'company']);
+
+        $html = '<oelib:isFieldEnabled configurationKey="columns" fieldName="name" then="THEN" else="ELSE"/>';
+        $result = $this->renderViewHelper($html);
+
+        self::assertStringContainsString('ELSE', $result);
+    }
+
+    /**
+     * @test
+     */
+    public function renderForNonStringConfigurationKeyThrowsException(): void
+    {
+        $this->expectException(\UnexpectedValueException::class);
+        $this->expectExceptionMessage('The variable "configurationKey" must be a string, but was: array');
+        $this->expectExceptionCode(1743708980);
+
+        $this->variableProvider->add('settings', ['fieldsToShow' => 'name']);
+
+        $html = '<oelib:isFieldEnabled configurationKey="{0: 1}" fieldName="name" then="THEN" else="ELSE"/>';
+        $this->renderViewHelper($html);
+    }
+
+    /**
+     * @test
+     */
+    public function renderForEmptyConfigurationKeyThrowsException(): void
+    {
+        $this->expectException(\UnexpectedValueException::class);
+        $this->expectExceptionMessage('The variable "configurationKey" must not be empty.');
+        $this->expectExceptionCode(1743709004);
+
+        $this->variableProvider->add('settings', ['fieldsToShow' => 'name']);
+
+        $html = '<oelib:isFieldEnabled configurationKey="" fieldName="name" then="THEN" else="ELSE"/>';
+        $this->renderViewHelper($html);
+    }
 }