[FEATURE] Enable sorting for category menu

A editor con now select the sorting of the category menu using either the event plugin or by TypoScript. Refs #820
derhansen · Feb 1, 2021 · a356990 · a356990
1 parent 6537a41
commit a356990
Show file tree

Hide file tree

Showing 7 changed files with 170 additions and 5 deletions.
diff --git a/Classes/Controller/EventController.php b/Classes/Controller/EventController.php
@@ -157,6 +157,8 @@ public function createCategoryDemandObjectFromSettings(array $settings)
         $demand->setRestrictToStoragePage((bool)$settings['restrictForeignRecordsToStoragePage']);
         $demand->setCategories($settings['categoryMenu']['categories']);
         $demand->setIncludeSubcategories($settings['categoryMenu']['includeSubcategories']);
+        $demand->setOrderField($settings['categoryMenu']['orderField'] ?? 'uid');
+        $demand->setOrderDirection($settings['categoryMenu']['orderDirection'] ?? 'asc');
 
         return $demand;
     }

diff --git a/Classes/Domain/Model/Dto/CategoryDemand.php b/Classes/Domain/Model/Dto/CategoryDemand.php
@@ -16,6 +16,8 @@
  */
 class CategoryDemand extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
 {
+    const ORDER_FIELD_ALLOWED = ['title', 'uid', 'sorting'];
+
     /**
      * Storage page
      *
@@ -44,6 +46,16 @@ class CategoryDemand extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
      */
     protected $includeSubcategories = false;
 
+    /**
+     * @var string
+     */
+    protected $orderField = 'uid';
+
+    /**
+     * @var string
+     */
+    protected $orderDirection = 'asc';
+
     /**
      * Sets the storage page
      *
@@ -123,4 +135,38 @@ public function setIncludeSubcategories($includeSubcategories)
     {
         $this->includeSubcategories = $includeSubcategories;
     }
+
+
+
+    /**
+     * @return string
+     */
+    public function getOrderDirection(): string
+    {
+        return $this->orderDirection;
+    }
+
+    /**
+     * @param string $orderDirection
+     */
+    public function setOrderDirection(string $orderDirection): void
+    {
+        $this->orderDirection = $orderDirection;
+    }
+
+    /**
+     * @return string
+     */
+    public function getOrderField(): string
+    {
+        return $this->orderField;
+    }
+
+    /**
+     * @param string $orderField
+     */
+    public function setOrderField(string $orderField): void
+    {
+        $this->orderField = $orderField;
+    }
 }
diff --git a/Classes/Domain/Repository/CategoryRepository.php b/Classes/Domain/Repository/CategoryRepository.php
@@ -9,8 +9,10 @@
 
 namespace DERHANSEN\SfEventMgt\Domain\Repository;
 
+use DERHANSEN\SfEventMgt\Domain\Model\Dto\CategoryDemand;
 use DERHANSEN\SfEventMgt\Service\CategoryService;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 
 /**
  * The repository for Categories
@@ -54,6 +56,15 @@ public function findDemanded($demand)
             $query->matching($query->logicalAnd($constraints));
         }
 
+        if ($demand->getOrderField() !== '' && $demand->getOrderDirection() !== '' &&
+            in_array($demand->getOrderField(), CategoryDemand::ORDER_FIELD_ALLOWED, true)
+        ) {
+            $orderings[$demand->getOrderField()] = ((strtolower($demand->getOrderDirection()) == 'desc') ?
+                QueryInterface::ORDER_DESCENDING :
+                QueryInterface::ORDER_ASCENDING);
+            $query->setOrderings($orderings);
+        }
+
         return $query->execute();
     }
 }
diff --git a/Configuration/FlexForms/Flexform_plugin.xml b/Configuration/FlexForms/Flexform_plugin.xml
@@ -817,7 +817,6 @@
                 <type>array</type>
                 <el>
 
-                    <!-- category -->
                     <settings.categoryMenu.categories>
                         <TCEforms>
                             <label>LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_categorymenu.categories</label>
@@ -841,7 +840,6 @@
                         </TCEforms>
                     </settings.categoryMenu.categories>
 
-                    <!-- disable overrideDemand -->
                     <settings.categoryMenu.includeSubcategories>
                         <TCEforms>
                             <label>LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_categorymenu.includeSubcategories</label>
@@ -851,8 +849,52 @@
                         </TCEforms>
                     </settings.categoryMenu.includeSubcategories>
 
+                    <settings.categoryMenu.orderField>
+                        <TCEforms>
+                            <label>LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderField</label>
+                            <config>
+                                <type>select</type>
+                                <renderType>selectSingle</renderType>
+                                <items>
+                                    <numIndex index="0">
+                                        <numIndex index="0">LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderField.title</numIndex>
+                                        <numIndex index="1">title</numIndex>
+                                    </numIndex>
+                                    <numIndex index="1">
+                                        <numIndex index="0">LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderField.uid</numIndex>
+                                        <numIndex index="1">uid</numIndex>
+                                    </numIndex>
+                                    <numIndex index="2">
+                                        <numIndex index="0">LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderField.sorting</numIndex>
+                                        <numIndex index="1">sorting</numIndex>
+                                    </numIndex>
+                                </items>
+                            </config>
+                        </TCEforms>
+                    </settings.categoryMenu.orderField>
+
+                    <settings.categoryMenu.orderDirection>
+                        <TCEforms>
+                            <label>LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderDirection</label>
+                            <config>
+                                <type>select</type>
+                                <renderType>selectSingle</renderType>
+                                <items>
+                                    <numIndex index="0">
+                                        <numIndex index="0">LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderDirection.ascending</numIndex>
+                                        <numIndex index="1">asc</numIndex>
+                                    </numIndex>
+                                    <numIndex index="1">
+                                        <numIndex index="0">LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:flexforms_general.orderDirection.descending</numIndex>
+                                        <numIndex index="1">desc</numIndex>
+                                    </numIndex>
+                                </items>
+                            </config>
+                        </TCEforms>
+                    </settings.categoryMenu.orderDirection>
+
                 </el>
             </ROOT>
         </categoryMenu>
     </sheets>
-</T3DataStructure>
+</T3DataStructure>
diff --git a/Documentation/ForAdministrators/Configuration/Plugins/EventPlugin/Index.rst b/Documentation/ForAdministrators/Configuration/Plugins/EventPlugin/Index.rst
@@ -427,7 +427,7 @@ Tab notification
 
    :Key:
          notification.senderName
-         
+
  - :Property:
          settings.notification.replyToEmail
 
@@ -616,3 +616,27 @@ Tab category menu
 
    :Key:
          categoryMenu.includeSubcategories
+
+ - :Property:
+         Order field
+
+   :View:
+         List
+
+   :Description:
+         Order field for the category menu (internally limited to "title", "uid" and "sorting")
+
+   :Key:
+         categoryMenu.orderField
+
+ - :Property:
+         Order direction
+
+   :View:
+         List
+
+   :Description:
+         Order direction for the category menu
+
+   :Key:
+         categoryMenu.orderDirection
diff --git a/Resources/Private/Language/locallang_be.xlf b/Resources/Private/Language/locallang_be.xlf
@@ -88,6 +88,12 @@
 			<trans-unit id="flexforms_general.orderField.title">
 				<source>Title</source>
 			</trans-unit>
+			<trans-unit id="flexforms_general.orderField.uid">
+				<source>Record ID</source>
+			</trans-unit>
+			<trans-unit id="flexforms_general.orderField.sorting">
+				<source>Sorting in TYPO3</source>
+			</trans-unit>
 			<trans-unit id="flexforms_general.orderField.startdate">
 				<source>Start date</source>
 			</trans-unit>
@@ -407,4 +413,4 @@
 			</trans-unit>
 		</body>
 	</file>
-</xliff>
+</xliff>
diff --git a/Tests/Unit/Domain/Model/Dto/CategoryDemandTest.php b/Tests/Unit/Domain/Model/Dto/CategoryDemandTest.php
@@ -91,4 +91,38 @@ public function setIncludeSubcategoriesSetsValueForBoolean()
         $this->subject->setIncludeSubcategories(true);
         self::assertTrue($this->subject->getIncludeSubcategories());
     }
+
+    /**
+     * @test
+     */
+    public function orderFieldReturnsDefaultValue()
+    {
+        $this->assertSame('uid', $this->subject->getOrderField());
+    }
+
+    /**
+     * @test
+     */
+    public function orderFieldCanBeSet()
+    {
+        $this->subject->setOrderField('title');
+        $this->assertSame('title', $this->subject->getOrderField());
+    }
+
+    /**
+     * @test
+     */
+    public function orderDirectionReturnsDefaultValue()
+    {
+        $this->assertSame('asc', $this->subject->getOrderDirection());
+    }
+
+    /**
+     * @test
+     */
+    public function orderDirectionCanBeSet()
+    {
+        $this->subject->setOrderDirection('desc');
+        $this->assertSame('desc', $this->subject->getOrderDirection());
+    }
 }