Improve CGL

.php-cs-fixer.dist.php

@@ -47,7 +47,9 @@ return (new \PhpCsFixer\Config())
         'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
         'phpdoc_no_access' => true,
         'phpdoc_no_package' => true,
+        'phpdoc_order' => ['order' => ['test', 'dataProvider', 'param', 'throws', 'return']],
         'phpdoc_scalar' => true,
+        'phpdoc_separation' => ['groups' => [['Extbase\\*']]],
         'phpdoc_trim' => true,
         'phpdoc_types' => true,
         'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],

Classes/Domain/Model/Date.php

@@ -59,6 +59,7 @@ class Date extends AbstractEntity
 
     /**
      * @param \DateTime $start
+     *
      * @return void
      */
     public function setStart(\DateTime $start)
@@ -81,6 +82,7 @@ class Date extends AbstractEntity
 
     /**
      * @param \DateTime $end
+     *
      * @return void
      */
     public function setEnd(\DateTime $end)
@@ -117,6 +119,7 @@ class Date extends AbstractEntity
 
     /**
      * @param int $languageUid
+     *
      * @return void
      */
     public function setLanguageUid($languageUid)
@@ -142,6 +145,7 @@ class Date extends AbstractEntity
 
     /**
      * @param  string  $canceled
+     *
      * @return void
      */
     public function setCanceled(string $canceled)

Classes/Domain/Model/Event.php

@@ -77,12 +77,14 @@ class Event extends AbstractEntity
 
     /**
      * @var ObjectStorage<FileReference>
+     *
      * @Extbase\ORM\Cascade remove
      */
     protected $images;
 
     /**
      * @var ObjectStorage<Date>
+     *
      * @Extbase\ORM\Cascade remove
      * @Extbase\ORM\Lazy
      */

Classes/Extbase/AddSpecialProperties.php

@@ -40,6 +40,7 @@ class AddSpecialProperties
 
     /**
      * Internal info to speed things up if we know there are none.
+     *
      * @var bool
      */
     private $doPostponedDatesExist = true;

Classes/Service/CategoryService.php

@@ -29,6 +29,7 @@ class CategoryService
      *
      * @param string $idList list of category ids to start
      * @param int $counter
+     *
      * @return string comma separated list of category ids
      */
     public function getChildrenCategories($idList, int $counter = 0): string
@@ -49,6 +50,7 @@ class CategoryService
      *
      * @param string $idList list of category ids to start
      * @param int $counter
+     *
      * @return string comma separated list of category ids
      */
     protected function getChildrenCategoriesRecursive($idList, $counter = 0): string
@@ -96,6 +98,7 @@ class CategoryService
      * Fetch ids again from DB to avoid false positives
      *
      * @param string $idList
+     *
      * @return string
      */
     protected function getUidListFromRecords(string $idList): string

Classes/Service/Cleanup/Files.php

@@ -230,6 +230,7 @@ class Files
 
     /**
      * @param array<int, array{storage: int, identifier: string}> $files
+     *
      * @return array<int, array{storage: int, identifier: string}> Index is file uid.
      */
     private function filterPotentialFilesToDelete(array $files): array
@@ -250,7 +251,7 @@ class Files
 
         foreach ($queryBuilder->execute() as $reference) {
             $file = [];
-            $fileUid = (int) $reference['uid_local'];
+            $fileUid = (int)$reference['uid_local'];
 
             if (
                 (

Classes/Service/DestinationDataImportService.php

@@ -110,6 +110,7 @@ class DestinationDataImportService
 
     /**
      * ImportService constructor.
+     *
      * @param EventRepository $eventRepository
      * @param OrganizerRepository $organizerRepository
      * @param DateRepository $dateRepository

Classes/Service/DestinationDataImportService/Slugger/SluggerType.php

@@ -34,6 +34,7 @@ interface SluggerType
      * That way fields used by the generation can be populated.
      *
      * @param string[] $record
+     *
      * @return string[]
      */
     public function prepareRecordForSlugGeneration(array $record): array;

Tests/Functional/Import/DestinationDataTest/ImportsTicketsTest.php

@@ -11,6 +11,7 @@ class ImportsTicketsTest extends AbstractTest
 {
     /**
      * @test
+     *
      * @todo: Missing "ticket" example and combinations.
      *        Could not find any "ticket" real world example.
      */

Tests/Unit/Domain/Model/Dto/DateDemandFactoryTest.php

@@ -321,6 +321,7 @@ class DateDemandFactoryTest extends TestCase
 
     /**
      * @test
+     *
      * @dataProvider possibleEndAndStartNullCombinations
      */
     public function returnsEndsOnSameDayIfAnyIsNull(
@@ -412,6 +413,7 @@ class DateDemandFactoryTest extends TestCase
 
     /**
      * @test
+     *
      * @dataProvider possibleSubmittedHighlights
      *
      * @param mixed $highlight
@@ -443,6 +445,7 @@ class DateDemandFactoryTest extends TestCase
 
     /**
      * @test
+     *
      * @dataProvider possibleSubmittedFalsyHighlights
      *
      * @param mixed $highlight

Tests/Unit/Service/DestinationDataImportService/DatesFactoryTest.php

@@ -46,6 +46,7 @@ class DatesFactoryTest extends TestCase
 
     /**
      * @test
+     *
      * @dataProvider possibleUnkownInput
      */
     public function returnsNoResultOnUnkownInput(array $unkownInput): void

Tests/Unit/Service/DestinationDataImportService/UrlFactoryTest.php

@@ -41,6 +41,7 @@ class UrlFactoryTest extends TestCase
 
     /**
      * @test
+     *
      * @dataProvider possibleImports
      */
     public function createSearchResultUrl(