Issue #3386937 by Spokje, smustgrave: Remove error suppressions and...

Issue #3386937 by Spokje, smustgrave: Remove error suppressions and workarounds for https://bugs.php.net/bug.php?id=50688

core/lib/Drupal/Core/Layout/LayoutPluginManager.php

@@ -199,9 +199,7 @@ public function getCategories() {
   public function getSortedDefinitions(array $definitions = NULL, $label_key = 'label') {
     // Sort the plugins first by category, then by label.
     $definitions = $definitions ?? $this->getDefinitions();
-    // Suppress errors because PHPUnit will indirectly modify the contents,
-    // triggering https://bugs.php.net/bug.php?id=50688.
-    @uasort($definitions, function (LayoutDefinition $a, LayoutDefinition $b) {
+    uasort($definitions, function (LayoutDefinition $a, LayoutDefinition $b) {
       if ($a->getCategory() != $b->getCategory()) {
         return strnatcasecmp($a->getCategory(), $b->getCategory());
       }

core/modules/block/src/BlockRepository.php

@@ -78,9 +78,7 @@ public function getVisibleBlocksPerRegion(array &$cacheable_metadata = []) {
     // Merge it with the actual values to maintain the region ordering.
     $assignments = array_intersect_key(array_merge($empty, $full), $empty);
     foreach ($assignments as &$assignment) {
-      // Suppress errors because PHPUnit will indirectly modify the contents,
-      // triggering https://bugs.php.net/bug.php?id=50688.
-      @uasort($assignment, 'Drupal\block\Entity\Block::sort');
+      uasort($assignment, 'Drupal\block\Entity\Block::sort');
     }
     return $assignments;
   }

core/modules/search/src/Entity/SearchPage.php

@@ -208,7 +208,7 @@ public static function postDelete(EntityStorageInterface $storage, array $entiti
   }
 
   /**
-   * {@inheritdoc}
+   * Helper callback for uasort() to sort search page entities by status, weight and label.
    */
   public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
     /** @var \Drupal\search\SearchPageInterface $a */

core/modules/search/tests/src/Unit/SearchPageRepositoryTest.php

@@ -7,6 +7,7 @@
 
 namespace Drupal\Tests\search\Unit;
 
+use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\search\Entity\SearchPage;
 use Drupal\search\SearchPageRepository;
@@ -252,26 +253,62 @@ public function testSetDefaultSearchPage() {
    * Tests the sortSearchPages() method.
    */
   public function testSortSearchPages() {
-    $entity_type = $this->createMock('Drupal\Core\Entity\EntityTypeInterface');
-    $entity_type->expects($this->any())
+    $entity_type = $this->createMock(EntityTypeInterface::class);
+    $entity_type
       ->method('getClass')
-      ->willReturn('Drupal\Tests\search\Unit\TestSearchPage');
+      ->willReturn(TestSearchPage::class);
     $this->storage->expects($this->once())
       ->method('getEntityType')
       ->willReturn($entity_type);
 
-    // Declare entities out of their expected order so we can be sure they were
-    // sorted. We cannot mock these because of uasort(), see
-    // https://bugs.php.net/bug.php?id=50688.
-    $unsorted_entities['test4'] = new TestSearchPage(['weight' => 0, 'status' => FALSE, 'label' => 'Test4']);
-    $unsorted_entities['test3'] = new TestSearchPage(['weight' => 10, 'status' => TRUE, 'label' => 'Test3']);
-    $unsorted_entities['test2'] = new TestSearchPage(['weight' => 0, 'status' => TRUE, 'label' => 'Test2']);
-    $unsorted_entities['test1'] = new TestSearchPage(['weight' => 0, 'status' => TRUE, 'label' => 'Test1']);
-    $expected = $unsorted_entities;
-    ksort($expected);
+    // Declare entities out of their expected order, so we can be sure they were
+    // sorted.
+    $entity_test4 = $this->createMock(TestSearchPage::class);
+    $entity_test4
+      ->method('label')
+      ->willReturn('Test4');
+    $entity_test4
+      ->method('status')
+      ->willReturn(FALSE);
+    $entity_test4
+      ->method('getWeight')
+      ->willReturn(0);
+    $entity_test3 = $this->createMock(TestSearchPage::class);
+    $entity_test3
+      ->method('label')
+      ->willReturn('Test3');
+    $entity_test3
+      ->method('status')
+      ->willReturn(FALSE);
+    $entity_test3
+      ->method('getWeight')
+      ->willReturn(10);
+    $entity_test2 = $this->createMock(TestSearchPage::class);
+    $entity_test2
+      ->method('label')
+      ->willReturn('Test2');
+    $entity_test2
+      ->method('status')
+      ->willReturn(TRUE);
+    $entity_test2
+      ->method('getWeight')
+      ->willReturn(0);
+    $entity_test1 = $this->createMock(TestSearchPage::class);
+    $entity_test1
+      ->method('label')
+      ->willReturn('Test1');
+    $entity_test1
+      ->method('status')
+      ->willReturn(TRUE);
+    $entity_test1
+      ->method('getWeight')
+      ->willReturn(0);
+
+    $unsorted_entities = [$entity_test4, $entity_test3, $entity_test2, $entity_test1];
+    $expected = [$entity_test1, $entity_test2, $entity_test3, $entity_test4];
 
     $sorted_entities = $this->searchPageRepository->sortSearchPages($unsorted_entities);
-    $this->assertSame($expected, $sorted_entities);
+    $this->assertSame($expected, array_values($sorted_entities));
   }
 
 }

core/tests/Drupal/Tests/Core/Config/Entity/ConfigEntityBaseUnitTest.php

@@ -531,26 +531,22 @@ public function testSort() {
 
     // Test sorting by label.
     $list = [$entity_a, $entity_b];
-    // Suppress errors because of https://bugs.php.net/bug.php?id=50688.
-    @usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
+    usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
     $this->assertSame($entity_b, $list[0]);
 
     $list = [$entity_b, $entity_a];
-    // Suppress errors because of https://bugs.php.net/bug.php?id=50688.
-    @usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
+    usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
     $this->assertSame($entity_b, $list[0]);
 
     // Test sorting by weight.
     $entity_a->weight = 0;
     $entity_b->weight = 1;
     $list = [$entity_b, $entity_a];
-    // Suppress errors because of https://bugs.php.net/bug.php?id=50688.
-    @usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
+    usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
     $this->assertSame($entity_a, $list[0]);
 
     $list = [$entity_a, $entity_b];
-    // Suppress errors because of https://bugs.php.net/bug.php?id=50688.
-    @usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
+    usort($list, '\Drupal\Core\Config\Entity\ConfigEntityBase::sort');
     $this->assertSame($entity_a, $list[0]);
   }