From f22fb7858ac5cf20b4fad6f9870655ab1ffc56b6 Mon Sep 17 00:00:00 2001
From: mhsdesign <85400359+mhsdesign@users.noreply.github.com>
Date: Tue, 6 Feb 2024 10:38:07 +0100
Subject: [PATCH] TASK: Remove `Neos.Ui.PositionalArraySorter` helper

---
 .../Helper/PositionalArraySorterHelper.php    | 40 ------------------
 Classes/Fusion/Helper/RenderingModeHelper.php | 41 +++++++++++++++++++
 Configuration/Settings.yaml                   |  7 ++--
 3 files changed, 44 insertions(+), 44 deletions(-)
 delete mode 100644 Classes/Fusion/Helper/PositionalArraySorterHelper.php
 create mode 100644 Classes/Fusion/Helper/RenderingModeHelper.php

diff --git a/Classes/Fusion/Helper/PositionalArraySorterHelper.php b/Classes/Fusion/Helper/PositionalArraySorterHelper.php
deleted file mode 100644
index ee9b53fd83..0000000000
--- a/Classes/Fusion/Helper/PositionalArraySorterHelper.php
+++ /dev/null
@@ -1,40 +0,0 @@
-<?php
-namespace Neos\Neos\Ui\Fusion\Helper;
-
-/*
- * This file is part of the Neos.Neos.Ui package.
- *
- * (c) Contributors of the Neos Project - www.neos.io
- *
- * This package is Open Source Software. For the full copyright and license
- * information, please view the LICENSE file which was distributed with this
- * source code.
- */
-
-use Neos\Eel\ProtectedContextAwareInterface;
-use Neos\Utility\PositionalArraySorter;
-
-/**
- * @todo EEL helpers are still to be declared as internal
- */
-class PositionalArraySorterHelper implements ProtectedContextAwareInterface
-{
-    /**
-     * @param array<int|string, mixed> $array
-     * @param string $positionPath
-     * @return array<int|string, mixed>
-     */
-    public function sort(array $array, string $positionPath = 'position'): array
-    {
-        return (new PositionalArraySorter($array, $positionPath))->toArray();
-    }
-
-    /**
-     * @param string $methodName
-     * @return boolean
-     */
-    public function allowsCallOfMethod($methodName)
-    {
-        return true;
-    }
-}
diff --git a/Classes/Fusion/Helper/RenderingModeHelper.php b/Classes/Fusion/Helper/RenderingModeHelper.php
new file mode 100644
index 0000000000..e1b07ddd23
--- /dev/null
+++ b/Classes/Fusion/Helper/RenderingModeHelper.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neos\Neos\Ui\Fusion\Helper;
+
+use Neos\Eel\ProtectedContextAwareInterface;
+use Neos\Flow\Annotations as Flow;
+use Neos\Neos\Domain\Model\RenderingMode;
+use Neos\Neos\Domain\Service\RenderingModeService;
+use Neos\Utility\PositionalArraySorter;
+
+/**
+ * @internal implementation detail of the Neos Ui to build its initialState.
+ *           only used in EEL for the configuration Neos.Neos.Ui.initialState.
+ */
+final class RenderingModeHelper implements ProtectedContextAwareInterface
+{
+    /**
+     * @Flow\InjectConfiguration(path="userInterface.editPreviewModes", package="Neos.Neos")
+     * @var array<string,mixed>
+     */
+    protected $editPreviewModes;
+
+    /**
+     * Returns the sorted configuration of all rendering modes {@see RenderingMode}
+     *
+     * todo: evaluate if this should be part of {@see RenderingModeService}
+     * @return array
+     */
+    public function findAllSorted(): array
+    {
+        // sorting seems expected for the Neos.Ui: https://github.com/neos/neos-ui/issues/1658
+        return (new PositionalArraySorter($this->editPreviewModes))->toArray();
+    }
+
+    public function allowsCallOfMethod($methodName)
+    {
+        return true;
+    }
+}
diff --git a/Configuration/Settings.yaml b/Configuration/Settings.yaml
index 014a5a60e0..3527f1aada 100644
--- a/Configuration/Settings.yaml
+++ b/Configuration/Settings.yaml
@@ -51,7 +51,7 @@ Neos:
         backgroundColor: '#ffffff'
 
       frontendConfiguration:
-        editPreviewModes: '${Neos.Ui.PositionalArraySorter.sort(Configuration.setting(''Neos.Neos.userInterface.editPreviewModes''))}'
+        editPreviewModes: '${Neos.Ui.RenderingMode.findAllSorted()}'
         # You may use this place to deliver some configuration to your custom UI components, e.g.:
         # 'Your.Own:Package':
         #   someKey: someValue
@@ -101,9 +101,9 @@ Neos:
       configurationDefaultEelContext:
         Neos.Ui.ContentDimensions: Neos\Neos\Ui\Fusion\Helper\ContentDimensionsHelper
         Neos.Ui.NodeInfo: Neos\Neos\Ui\Fusion\Helper\NodeInfoHelper
-        Neos.Ui.Workspace: Neos\Neos\Ui\Fusion\Helper\WorkspaceHelper
+        Neos.Ui.RenderingMode: Neos\Neos\Ui\Fusion\Helper\RenderingModeHelper
         Neos.Ui.StaticResources: Neos\Neos\Ui\Fusion\Helper\StaticResourcesHelper
-        Neos.Ui.PositionalArraySorter: Neos\Neos\Ui\Fusion\Helper\PositionalArraySorterHelper
+        Neos.Ui.Workspace: Neos\Neos\Ui\Fusion\Helper\WorkspaceHelper
       documentNodeInformation:
         metaData:
           documentNode: '${Neos.Ui.NodeInfo.serializedNodeAddress(documentNode)}'
@@ -205,4 +205,3 @@ Neos:
   Fusion:
     defaultContext:
       Neos.Ui.StaticResources: Neos\Neos\Ui\Fusion\Helper\StaticResourcesHelper
-      Neos.Ui.PositionalArraySorter: Neos\Neos\Ui\Fusion\Helper\PositionalArraySorterHelper