[FEATURE] Configurable default ordering in backend module

With this feature it is possible to define the default order field and the default order direction for the backend module. Refs #1169
derhansen · Dec 16, 2023 · 6d2c900 · 6d2c900
1 parent 85fa822
commit 6d2c900
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 4 deletions.
diff --git a/Classes/Controller/AdministrationController.php b/Classes/Controller/AdministrationController.php
@@ -249,8 +249,16 @@ public function listAction(?SearchDemand $searchDemand = null, array $overwriteD
             $this->beUserSessionService->saveSessionData($sessionData);
         }
 
+        // Initialize default ordering when no overwriteDemand is available
+        if (empty($overwriteDemand)) {
+            $overwriteDemand = [
+                'orderField' => $this->settings['defaultSorting']['orderField'] ?? 'title',
+                'orderDirection' => $this->settings['defaultSorting']['orderDirection'] ?? 'asc',
+            ];
+        }
+
         $eventDemand = GeneralUtility::makeInstance(EventDemand::class);
-        $eventDemand = $this->overwriteEventDemandObject($eventDemand, $overwriteDemand ?? []);
+        $eventDemand = $this->overwriteEventDemandObject($eventDemand, $overwriteDemand);
         $eventDemand->setOrderFieldAllowed($this->settings['orderFieldAllowed'] ?? '');
         $eventDemand->setSearchDemand($searchDemand);
         $eventDemand->setStoragePage((string)$this->pid);

diff --git a/Configuration/TypoScript/setup.typoscript b/Configuration/TypoScript/setup.typoscript
@@ -210,6 +210,10 @@ module.tx_sfeventmgt {
             notify = 1
             export = 1
         }
+        defaultSorting {
+          orderField = title
+          orderDirection = asc
+        }
         pagination {
             enablePagination = 1
             itemsPerPage = 10

diff --git a/Documentation/ForAdministrators/Configuration/TsReference/Index.rst b/Documentation/ForAdministrators/Configuration/TsReference/Index.rst
@@ -778,3 +778,57 @@ settings.enabledActions.export
 
    If set to "1", the Export-Action / Icon is shown for events with registration enabled.
 
+settings.defaultSorting.orderField
+------------------------------
+
+.. confval:: settings.defaultSorting.orderField
+
+   :Type: string
+   :Default: title
+
+   Defines the default field to be used for sorting. When not explicitly
+   specified, the sorting will be based on the "title" field.
+
+settings.defaultSorting.orderDirection
+----------------------------------------
+
+.. confval:: settings.defaultSorting.orderDirection
+
+   :Type: string
+   :Default: asc
+
+   Specifies the default order direction. The default value "asc" stands for
+   ascending order. Can be set to "desc" for descending order.
+
+settings.pagination.enablePagination
+------------------------------------
+
+.. confval:: settings.pagination.enablePagination
+
+   :Type: int
+   :Default: 1
+
+   Determines whether pagination is enabled (1) or disabled (0). When set to
+   "1", pagination is used to divide content into separate pages.
+
+settings.pagination.itemsPerPage
+--------------------------------
+
+.. confval:: settings.pagination.itemsPerPage
+
+   :Type: int
+   :Default: 10
+
+   Specifies the number of items to display on each page when pagination is
+   enabled. The default setting is 10 items per page.
+
+settings.pagination.maxNumPages
+-------------------------------
+
+.. confval:: settings.pagination.maxNumPages
+
+   :Type: int
+   :Default: 10
+
+   Sets the maximum number of pages to display in the pagination control.
+   The default is set to 10 pages.
diff --git a/Tests/Unit/Controller/AdministrationControllerTest.php b/Tests/Unit/Controller/AdministrationControllerTest.php
@@ -85,7 +85,10 @@ public function listActionDoesNotFetchEventsForStoragePidZero(): void
             'searchDemand' => new SearchDemand(),
             'orderByFields' => $this->subject->getOrderByFields(),
             'orderDirections' => $this->subject->getOrderDirections(),
-            'overwriteDemand' => null,
+            'overwriteDemand' => [
+                'orderField' => 'title',
+                'orderDirection' => 'asc',
+            ],
             'pagination' => null,
         ];
         $this->subject->expects(self::once())->method('initModuleTemplateAndReturnResponse')
@@ -128,7 +131,10 @@ public function listActionDoesNotFetchEventsForStoragePidZeroAndDemand(): void
             'searchDemand' => $searchDemand,
             'orderByFields' => $this->subject->getOrderByFields(),
             'orderDirections' => $this->subject->getOrderDirections(),
-            'overwriteDemand' => [],
+            'overwriteDemand' => [
+                'orderField' => 'title',
+                'orderDirection' => 'asc',
+            ],
             'pagination' => null,
         ];
         $this->subject->expects(self::once())->method('initModuleTemplateAndReturnResponse')
@@ -179,7 +185,10 @@ public function listActionFetchesAllEventsForGivenStoragePidAndPassesExpectedVar
             'searchDemand' => $searchDemand,
             'orderByFields' => $this->subject->getOrderByFields(),
             'orderDirections' => $this->subject->getOrderDirections(),
-            'overwriteDemand' => [],
+            'overwriteDemand' => [
+                'orderField' => 'title',
+                'orderDirection' => 'asc',
+            ],
             'pagination' => [],
         ];
         $this->subject->expects(self::once())->method('initModuleTemplateAndReturnResponse')