PagerManagerTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\Pager;

use Drupal\Core\Pager\PagerManager;
use Drupal\KernelTests\KernelTestBase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;

/**
 * Tests Drupal\Core\Pager\PagerManager.
 */
class PagerManagerTest extends KernelTestBase {
  
  /**
   * Tests get updated parameters.
   *
   * @legacy-covers ::getUpdatedParameters
   */
  public function testGetUpdatedParameters() : void {
    $element = 2;
    $index = 5;
    $test_parameters = [
      'other' => 'arbitrary',
    ];
    $request = Request::create('http://example.com', 'GET', $test_parameters);
    $request->setSession(new Session(new MockArraySessionStorage()));
    /** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
    $request_stack = $this->container
      ->get('request_stack');
    $request_stack->push($request);
    /** @var \Drupal\Core\Pager\PagerManagerInterface $pager_manager */
    $pager_manager = $this->container
      ->get('pager.manager');
    $pager_manager->createPager(30, 10, $element);
    $query = $pager_manager->getUpdatedParameters($request->query
      ->all(), $element, $index);
    $this->assertArrayHasKey('other', $query);
    $this->assertEquals(",,{$index}", $query['page']);
  }
  
  /**
   * Tests find page.
   *
   * @legacy-covers ::findPage
   */
  public function testFindPage() : void {
    $request = Request::create('http://example.com', 'GET', [
      'page' => '0,10',
    ]);
    $request->setSession(new Session(new MockArraySessionStorage()));
    /** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
    $request_stack = $this->container
      ->get('request_stack');
    $request_stack->push($request);
    $pager_manager = $this->container
      ->get('pager.manager');
    $this->assertEquals(10, $pager_manager->findPage(1));
  }
  
  /**
   * Tests get max pager element id.
   *
   * @legacy-covers ::getMaxPagerElementId
   */
  public function testGetMaxPagerElementId(array $elements, int $expected_max_element_id) : void {
    /** @var \Drupal\Core\Pager\PagerManagerInterface $pager_manager */
    $pager_manager = $this->container
      ->get('pager.manager');
    foreach ($elements as $element) {
      $pager_manager->createPager(30, 10, $element);
    }
    $this->assertEquals($expected_max_element_id, $pager_manager->getMaxPagerElementId());
  }
  
  /**
   * Provides test cases for PagerManagerTest::testGetMaxPagerElementId().
   *
   * @return array
   *   An array of test cases, each which the following values:
   *   - Array of elements to pass to PagerManager::createPager().
   *   - The expected value returned by PagerManager::getMaxPagerElementId().
   */
  public static function providerTestGetMaxPagerElementId() : array {
    return [
      'no_pager' => [
        [],
        -1,
      ],
      'single_pager' => [
        [
          0,
        ],
        0,
      ],
      'multiple_pagers' => [
        [
          30,
          10,
          20,
        ],
        30,
      ],
    ];
  }

}