[TASK] Add sort order configuration to plugin

extcode · extcode · commit 41ec9819000e · 2020-04-22T18:22:45.000+02:00
Related: #79
diff --git a/Classes/Controller/ActionController.php b/Classes/Controller/ActionController.php
@@ -38,10 +38,11 @@ public function injectCategoryRepository(CategoryRepository $categoryRepository)
      */
     protected function createDemandObjectFromSettings(array $settings) : Demand
     {
-        $demand = $this->objectManager->get(
-            Demand::class
-        );
+        $demand = new Demand();
         $this->addCategoriesToDemandObjectFromSettings($demand);
+        if ($this->settings['orderBy']) {
+            $demand->setOrderBy($this->settings['orderBy']);
+        }
 
         $arguments = $this->request->getArguments();
 
diff --git a/Classes/Controller/AddressController.php b/Classes/Controller/AddressController.php
@@ -48,8 +48,7 @@ public function injectZipRepository(ZipRepository $zipRepository)
 
     public function searchAction()
     {
-        /** @var AddressSearch $addressSearch */
-        $addressSearch = $this->objectManager->get(AddressSearch::class);
+        $addressSearch = new AddressSearch();
         if ($this->settings['orderBy']) {
             $addressSearch->setOrderBy($this->settings['orderBy']);
             if ($this->settings['fallbackOrderBy']) {
diff --git a/Classes/Domain/Model/Contact.php b/Classes/Domain/Model/Contact.php
@@ -167,7 +167,7 @@ public function getLastName()
      * @param string $seperator
      * @return string
      */
-    public function getFullName(string $seperator)
+    public function getFullName(string $seperator = ' ')
     {
         return implode($seperator, [$this->getFirstName(), $this->getLastName()]);
     }
@@ -176,7 +176,7 @@ public function getFullName(string $seperator)
      * @param string $seperator
      * @return string
      */
-    public function getTitleFullName(string $seperator)
+    public function getTitleFullName(string $seperator = ' ')
     {
         $titleFullName = [];
         if ($this->getTitle()) {
diff --git a/Classes/Domain/Model/Dto/Demand.php b/Classes/Domain/Model/Dto/Demand.php
@@ -37,6 +37,11 @@ class Demand
      */
     protected $class = '';
 
+    /**
+     * @var string
+     */
+    protected $orderBy = '';
+
     /**
      * @return string
      */
@@ -126,4 +131,20 @@ public function setActionAndClass($action, $class): void
         $this->action = $action;
         $this->class = $class;
     }
+
+    /**
+     * @return string
+     */
+    public function getOrderBy(): string
+    {
+        return $this->orderBy;
+    }
+
+    /**
+     * @param string $orderBy
+     */
+    public function setOrderBy(string $orderBy): void
+    {
+        $this->orderBy = $orderBy;
+    }
 }
diff --git a/Classes/Domain/Repository/CompanyRepository.php b/Classes/Domain/Repository/CompanyRepository.php
@@ -57,6 +57,14 @@ public function findDemanded(Demand $demand)
             );
         }
 
+        if (!empty($demand->getOrderBy())) {
+            $query->setOrderings(
+                [
+                    $demand->getOrderBy() => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING
+                ]
+            );
+        }
+
         return $query->execute();
     }
 
diff --git a/Classes/Domain/Repository/ContactRepository.php b/Classes/Domain/Repository/ContactRepository.php
@@ -58,6 +58,14 @@ public function findDemanded(Demand $demand)
             );
         }
 
+        if (!empty($demand->getOrderBy())) {
+            $query->setOrderings(
+                [
+                    $demand->getOrderBy() => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING
+                ]
+            );
+        }
+
         return $query->execute();
     }
 
diff --git a/Configuration/FlexForms/CompaniesPlugin.xml b/Configuration/FlexForms/CompaniesPlugin.xml
@@ -30,6 +30,25 @@
                         </TCEforms>
                     </switchableControllerActions>
 
+                    <settings.orderBy>
+                        <TCEforms>
+                            <label>LLL:EXT:contacts/Resources/Private/Language/locallang_be.xlf:tx_contacts.plugin.companies.action.company.list.orderBy</label>
+                            <config>
+                                <type>select</type>
+                                <items>
+                                    <numIndex index="0" type="array">
+                                        <numIndex index="0"></numIndex>
+                                        <numIndex index="1"></numIndex>
+                                    </numIndex>
+                                    <numIndex index="2">
+                                        <numIndex index="0">LLL:EXT:contacts/Resources/Private/Language/locallang_be.xlf:tx_contacts.plugin.companies.action.company.list.orderBy.name</numIndex>
+                                        <numIndex index="1">name</numIndex>
+                                    </numIndex>
+                                </items>
+                            </config>
+                        </TCEforms>
+                    </settings.orderBy>
+
                     <settings.companyUids>
                         <TCEforms>
                             <label>LLL:EXT:contacts/Resources/Private/Language/locallang_db.xlf:tx_contacts_domain_model_company</label>
diff --git a/Configuration/FlexForms/ContactsPlugin.xml b/Configuration/FlexForms/ContactsPlugin.xml
@@ -31,6 +31,25 @@
                         </TCEforms>
                     </switchableControllerActions>
 
+                    <settings.orderBy>
+                        <TCEforms>
+                            <label>LLL:EXT:contacts/Resources/Private/Language/locallang_be.xlf:tx_contacts.plugin.contacts.action.contact.list.orderBy</label>
+                            <config>
+                                <type>select</type>
+                                <items>
+                                    <numIndex index="0" type="array">
+                                        <numIndex index="0"></numIndex>
+                                        <numIndex index="1"></numIndex>
+                                    </numIndex>
+                                    <numIndex index="2">
+                                        <numIndex index="0">LLL:EXT:contacts/Resources/Private/Language/locallang_be.xlf:tx_contacts.plugin.contacts.action.contact.list.orderBy.last_name</numIndex>
+                                        <numIndex index="1">last_name</numIndex>
+                                    </numIndex>
+                                </items>
+                            </config>
+                        </TCEforms>
+                    </settings.orderBy>
+
                     <settings.contactUids>
                         <TCEforms>
                             <label>LLL:EXT:contacts/Resources/Private/Language/locallang_db.xlf:tx_contacts_domain_model_contact</label>
diff --git a/Resources/Private/Language/de.locallang_be.xlf b/Resources/Private/Language/de.locallang_be.xlf
@@ -87,6 +87,14 @@
                 <target>Detailseite</target>
             </trans-unit>
 
+            <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.orderBy">
+                <source>Sort Order</source>
+                <target>Sortierreihenfolge</target>
+            </trans-unit>
+            <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.orderBy.last_name">
+                <source>Last Name</source>
+                <target>Nachname</target>
+            </trans-unit>
             <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.categories">
                 <source>Categories</source>
                 <target>Kategorie</target>
@@ -96,6 +104,14 @@
                 <target>mit Unterkategorien</target>
             </trans-unit>
 
+            <trans-unit id="tx_contacts.plugin.companies.action.company.list.orderBy">
+                <source>Sort Order</source>
+                <target>Sortierreihenfolge</target>
+            </trans-unit>
+            <trans-unit id="tx_contacts.plugin.companies.action.company.list.orderBy.name">
+                <source>Name</source>
+                <target>Name</target>
+            </trans-unit>
             <trans-unit id="tx_contacts.plugin.companies.action.company.list.categories">
                 <source>Categories</source>
                 <target>Kategorie</target>
diff --git a/Resources/Private/Language/locallang_be.xlf b/Resources/Private/Language/locallang_be.xlf
@@ -64,13 +64,25 @@
                 <source>Detail Page</source>
             </trans-unit>
 
+            <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.orderBy">
+                <source>Sort Order</source>
+            </trans-unit>
+            <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.orderBy.last_name">
+                <source>Last Name</source>
+            </trans-unit>
             <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.categories">
                 <source>Categories</source>
             </trans-unit>
             <trans-unit id="tx_contacts.plugin.contacts.action.contact.list.subcategories">
                 <source>with Subcategories</source>
             </trans-unit>
 
+            <trans-unit id="tx_contacts.plugin.companies.action.company.list.orderBy">
+                <source>Sort Order</source>
+            </trans-unit>
+            <trans-unit id="tx_contacts.plugin.companies.action.company.list.orderBy.name">
+                <source>Name</source>
+            </trans-unit>
             <trans-unit id="tx_contacts.plugin.companies.action.company.list.categories">
                 <source>Categories</source>
             </trans-unit>
diff --git a/Tests/Functional/Fixtures/tx_contacts_domain_model_contact.xml b/Tests/Functional/Fixtures/tx_contacts_domain_model_contact.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dataset>
+    <tx_contacts_domain_model_contact>
+        <uid>1</uid>
+        <pid>2</pid>
+        <first_name>Max</first_name>
+        <last_name>Mustermann</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+    <tx_contacts_domain_model_contact>
+        <uid>2</uid>
+        <pid>2</pid>
+        <first_name>Erika</first_name>
+        <last_name>Mustermann</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+
+    <tx_contacts_domain_model_contact>
+        <uid>3</uid>
+        <pid>3</pid>
+        <first_name>John</first_name>
+        <last_name>Doe</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+    <tx_contacts_domain_model_contact>
+        <uid>4</uid>
+        <pid>3</pid>
+        <first_name>Jane</first_name>
+        <last_name>Doe</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+
+    <tx_contacts_domain_model_contact>
+        <uid>5</uid>
+        <pid>4</pid>
+        <first_name>Jean</first_name>
+        <last_name>Dupont</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+    <tx_contacts_domain_model_contact>
+        <uid>6</uid>
+        <pid>4</pid>
+        <first_name>Matti</first_name>
+        <last_name>Meikäläinen</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+    <tx_contacts_domain_model_contact>
+        <uid>7</uid>
+        <pid>4</pid>
+        <first_name>Mario</first_name>
+        <last_name>Rossi</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+    <tx_contacts_domain_model_contact>
+        <uid>8</uid>
+        <pid>4</pid>
+        <first_name>Jan</first_name>
+        <last_name>Janssen</last_name>
+        <teaser>''</teaser>
+        <description>''</description>
+        <meta_description>''</meta_description>
+    </tx_contacts_domain_model_contact>
+</dataset>
diff --git a/Tests/Functional/Repository/CompanyRepositoryTest.php b/Tests/Functional/Repository/CompanyRepositoryTest.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace Extcode\Contacts\Tests\Functional\Repository;
+
+/*
+ * This file is part of the package extcode/contacts.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file that was distributed with this source code.
+ */
+
+use Extcode\Contacts\Domain\Model\Dto\Demand;
+use Extcode\Contacts\Domain\Repository\CompanyRepository;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Extbase\Object\ObjectManager;
+use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
+
+class CompanyRepositoryTest extends FunctionalTestCase
+{
+
+    /**
+     * @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
+     */
+    protected $objectManager;
+
+    /**
+     * @var CompanyRepository
+     */
+    protected $companyRepository;
+
+    protected $testExtensionsToLoad = [
+        'typo3conf/ext/contacts'
+    ];
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
+        $this->companyRepository = $this->objectManager->get(CompanyRepository::class);
+
+        $this->importDataSet(__DIR__ . '/../Fixtures/pages.xml');
+        $this->importDataSet(__DIR__ . '/../Fixtures/tx_contacts_domain_model_company.xml');
+    }
+
+    public function tearDown(): void
+    {
+        unset($this->companyRepository);
+        unset($this->objectManager);
+    }
+
+    /**
+     * @test
+     */
+    public function findDemandedAndOrderByName(): void
+    {
+        $demand = new Demand();
+        $demand->setOrderBy('name');
+
+        $querySettings = $this->companyRepository->createQuery()->getQuerySettings();
+        $querySettings->setRespectStoragePage(false);
+        $this->companyRepository->setDefaultQuerySettings($querySettings);
+        $companies = $this->companyRepository->findDemanded($demand)->toArray();
+
+        $this->assertSame(
+            'Abgeordnetenhaus von Berlin',
+            $companies[0]->getName()
+        );
+        $this->assertSame(
+            'Bayerischer Landtag',
+            $companies[1]->getName()
+        );
+        $this->assertSame(
+            'Bremische Bürgerschaft',
+            $companies[2]->getName()
+        );
+        $this->assertSame(
+            'Landtag von Baden-Württemberg',
+            $companies[10]->getName()
+        );
+        $this->assertSame(
+            'Thüringer Landtag',
+            $companies[15]->getName()
+        );
+    }
+}
diff --git a/Tests/Functional/Repository/ContactRepositoryTest.php b/Tests/Functional/Repository/ContactRepositoryTest.php
diff --git a/Tests/Unit/Domain/Model/Dto/AddressSearchTest.php b/Tests/Unit/Domain/Model/Dto/AddressSearchTest.php
diff --git a/Tests/Unit/Domain/Model/Dto/DemandTest.php b/Tests/Unit/Domain/Model/Dto/DemandTest.php
diff --git a/ext_emconf.php b/ext_emconf.php

Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,7 @@ public function injectZipRepository(ZipRepository $zipRepository)`
`48`	`48`
`49`	`49`	`public function searchAction()`
`50`	`50`	`{`
`51`		`- /** @var AddressSearch $addressSearch */`
`52`		`- $addressSearch = $this->objectManager->get(AddressSearch::class);`
	`51`	`+ $addressSearch = new AddressSearch();`
`53`	`52`	`if ($this->settings['orderBy']) {`
`54`	`53`	`$addressSearch->setOrderBy($this->settings['orderBy']);`
`55`	`54`	`if ($this->settings['fallbackOrderBy']) {`
Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ public function getLastName()`
`167`	`167`	`* @param string $seperator`
`168`	`168`	`* @return string`
`169`	`169`	`*/`
`170`		`- public function getFullName(string $seperator)`
	`170`	`+ public function getFullName(string $seperator = ' ')`
`171`	`171`	`{`
`172`	`172`	`return implode($seperator, [$this->getFirstName(), $this->getLastName()]);`
`173`	`173`	`}`
`@@ -176,7 +176,7 @@ public function getFullName(string $seperator)`
`176`	`176`	`* @param string $seperator`
`177`	`177`	`* @return string`
`178`	`178`	`*/`
`179`		`- public function getTitleFullName(string $seperator)`
	`179`	`+ public function getTitleFullName(string $seperator = ' ')`
`180`	`180`	`{`
`181`	`181`	`$titleFullName = [];`
`182`	`182`	`if ($this->getTitle()) {`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,14 @@ public function findDemanded(Demand $demand)`
`57`	`57`	`);`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ if (!empty($demand->getOrderBy())) {`
	`61`	`+ $query->setOrderings(`
	`62`	`+ [`
	`63`	`+ $demand->getOrderBy() => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING`
	`64`	`+ ]`
	`65`	`+ );`
	`66`	`+ }`
	`67`	`+`
`60`	`68`	`return $query->execute();`
`61`	`69`	`}`
`62`	`70`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,14 @@ public function findDemanded(Demand $demand)`
`58`	`58`	`);`
`59`	`59`	`}`
`60`	`60`
	`61`	`+ if (!empty($demand->getOrderBy())) {`
	`62`	`+ $query->setOrderings(`
	`63`	`+ [`
	`64`	`+ $demand->getOrderBy() => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING`
	`65`	`+ ]`
	`66`	`+ );`
	`67`	`+ }`
	`68`	`+`
`61`	`69`	`return $query->execute();`
`62`	`70`	`}`
`63`	`71`