You are here

class PagererTest in Pagerer 8.2

Same name and namespace in other branches
  1. 8 tests/src/Functional/PagererTest.php \Drupal\Tests\pagerer\Functional\PagererTest

Checks Pagerer functionality.

@group Pagerer

Hierarchy

Expanded class hierarchy of PagererTest

File

tests/src/Functional/PagererTest.php, line 12

Namespace

Drupal\Tests\pagerer\Functional
View source
class PagererTest extends BrowserTestBase {

  /**
   * The URL for Pagerer admin UI page.
   *
   * @var string
   */
  protected $pagererAdmin = 'admin/config/user-interface/pagerer';

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'dblog',
    'pagerer',
    'pagerer_example',
    'pager_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();

    // Insert 300 log messages.
    $logger = $this->container
      ->get('logger.factory')
      ->get('pager_test');
    for ($i = 0; $i < 300; $i++) {
      $logger
        ->debug($this
        ->randomString());
    }
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'access site reports',
      'administer site configuration',
    ]));
  }

  /**
   * Tests Pagerer functionality.
   */
  public function testPagerer() {

    // Admin UI tests.
    $this
      ->drupalGet($this->pagererAdmin . '/preset/add');
    $this
      ->submitForm([
      'label' => 'ui_test',
      'id' => 'ui_test',
    ], 'Create');
    $this
      ->drupalGet($this->pagererAdmin);
    $this
      ->submitForm([
      'core_override_preset' => 'ui_test',
    ], 'Save configuration');
    $styles = [
      'standard',
      'none',
      'basic',
      'progressive',
      'adaptive',
      'mini',
      'slider',
      'scrollpane',
    ];
    foreach ($styles as $style) {
      $this
        ->drupalGet($this->pagererAdmin . '/preset/manage/ui_test');
      $this
        ->submitForm([
        'panes_container[left][style]' => 'none',
        'panes_container[center][style]' => 'none',
        'panes_container[right][style]' => $style,
      ], 'Save');
      $this
        ->drupalGet($this->pagererAdmin . '/preset/manage/ui_test');
      if ($style !== 'none') {
        $this
          ->click('[id="edit-panes-container-right-actions-reset"]');
        $this
          ->click('[id="edit-submit"]');
        $this
          ->assertSession()
          ->pageTextNotContains('fooxiey');
        $this
          ->click('[id="edit-panes-container-right-actions-configure"]');
        $this
          ->submitForm([
          'prefix_display' => '1',
          'tags_container[pages][prefix_label]' => 'fooxiey',
        ], 'Save');
        $this
          ->assertSession()
          ->pageTextContains('fooxiey');
      }
    }

    // Load example page.
    $this
      ->drupalGet('pagerer/example');
  }

  /**
   * Test proper functioning of multiple pagers with overridden querystring.
   */
  public function testQuerystringOverrides() {

    // Test data.
    $test_data = [
      // With no querystring, all pagers set to first page.
      [
        'input_querystring' => NULL,
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=1.1...1',
          ],
        ],
      ],
      // Blanks around page numbers should not be relevant.
      [
        'input_querystring' => '?page=2  ,    10,,,   5     ,,',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '3',
              1 => '11',
              4 => '6',
            ],
            'querystring' => '?page=2%2C10%2C%2C%2C5',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '11',
              4 => '6',
            ],
            'querystring' => '?pg=2.10...5',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '11',
              4 => '6',
            ],
            'querystring' => '?px=3.11...6',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=  2  .    10...   5     ..',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=  2  .    10...   5     ..&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '11',
              4 => '6',
            ],
            'querystring' => '?pg=2.10...5',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=  2  .    10...   5     ..&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=  3  .    11...   6     ..',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=  3  .    11...   6     ..&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=  3  .    11...   6     ..&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '11',
              4 => '6',
            ],
            'querystring' => '?px=3.11...6',
          ],
        ],
      ],
      // Blanks within page numbers should lead to only the first integer
      // to be considered.
      [
        'input_querystring' => '?page=2  ,   3 0,,,   4  13    ,,',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '3',
              1 => '4',
              4 => '5',
            ],
            'querystring' => '?page=2%2C3%2C%2C%2C4',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '4',
              4 => '5',
            ],
            'querystring' => '?pg=2.3...4',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '4',
              4 => '5',
            ],
            'querystring' => '?px=3.4...5',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=2  .   3 0...   4  13    ..',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2  .   3 0...   4  13    ..&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '4',
              4 => '5',
            ],
            'querystring' => '?pg=2.3...4',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2  .   3 0...   4  13    ..&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=3  .   4 1...   5  14    ..',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=3  .   4 1...   5  14    ..&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=3  .   4 1...   5  14    ..&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '4',
              4 => '5',
            ],
            'querystring' => '?px=3.4...5',
          ],
        ],
      ],
      // If floats are passed as page numbers, only the integer part is
      // returned. NOTE - the override in Pagerer is different from core as dots
      // are interpreted as pager id separators.
      [
        'input_querystring' => '?page=2.1,6.999,,,5.',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?page=2%2C6%2C%2C%2C5',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?pg=2.6...5',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?px=3.7...6',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=2. 6.999 . . 5.',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2. 6.999 . . 5.&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?pg=2.6...5',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2. 6.999 . . 5.&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=3. 7.999 . . 6.',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=3. 7.999 . . 6.&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=3. 7.999 . . 6.&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?px=3.7...6',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=2,1.6,999...5,',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2%2C1.6%2C999...5%2C&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '3',
              1 => '7',
              4 => '6',
            ],
            'querystring' => '?pg=2.6...5',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=2%2C1.6%2C999...5%2C&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=2,1.6,999...5,',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=2%2C1.6%2C999...5%2C&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=2%2C1.6%2C999...5%2C&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '2',
              1 => '6',
              4 => '5',
            ],
            'querystring' => '?px=2.6...5',
          ],
        ],
      ],
      // Partial page fragment, undefined pagers set to first page.
      [
        'input_querystring' => '?page=5,2',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '6',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?page=5%2C2%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '6',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?pg=5.2...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '6',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?px=6.3...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=5.2',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=5.2&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '6',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?pg=5.2...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=5.2&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=6.3',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=6.3&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=6.3&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '6',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?px=6.3...1',
          ],
        ],
      ],
      // Partial page fragment, undefined pagers set to first page.
      [
        'input_querystring' => '?page=,2',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?page=0%2C2%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?pg=0.2...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?px=1.3...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=.2',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=.2&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?pg=0.2...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=.2&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=.3',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=.3&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=.3&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '3',
              4 => '1',
            ],
            'querystring' => '?px=1.3...1',
          ],
        ],
      ],
      // Partial page fragment, undefined pagers set to first page.
      [
        'input_querystring' => '?page=,',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=.',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=.&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=.&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=.',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=.&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=.&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=1.1...1',
          ],
        ],
      ],
      // With overflow pages, all pagers set to max page.
      [
        'input_querystring' => '?page=99,99,,,99',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '16',
              1 => '16',
              4 => '16',
            ],
            'querystring' => '?page=15%2C15%2C%2C%2C15',
          ],
          'pg_0' => [
            'markup' => [
              0 => '16',
              1 => '16',
              4 => '16',
            ],
            'querystring' => '?pg=15.15...15',
          ],
          'px_1' => [
            'markup' => [
              0 => '16',
              1 => '16',
              4 => '16',
            ],
            'querystring' => '?px=16.16...16',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=99.99...99',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=99.99...99&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '16',
              1 => '16',
              4 => '16',
            ],
            'querystring' => '?pg=15.15...15',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=99.99...99&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=99.99...99',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=99.99...99&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=99.99...99&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '16',
              1 => '16',
              4 => '16',
            ],
            'querystring' => '?px=16.16...16',
          ],
        ],
      ],
      // Wrong value for the page resets pager to first page.
      [
        'input_querystring' => '?page=bar,5,foo,qux,bet',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '6',
              4 => '1',
            ],
            'querystring' => '?page=0%2C5%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '6',
              4 => '1',
            ],
            'querystring' => '?pg=0.5...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '6',
              4 => '1',
            ],
            'querystring' => '?px=1.6...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?pg=bar.5.foo.qux.bet',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=bar.5.foo.qux.bet&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '6',
              4 => '1',
            ],
            'querystring' => '?pg=0.5...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?pg=bar.5.foo.qux.bet&px=1.1...1',
          ],
        ],
      ],
      [
        'input_querystring' => '?px=bar.6.foo.qux.bet',
        'expected' => [
          'page' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=bar.6.foo.qux.bet&page=0%2C0%2C%2C%2C0',
          ],
          'pg_0' => [
            'markup' => [
              0 => '1',
              1 => '1',
              4 => '1',
            ],
            'querystring' => '?px=bar.6.foo.qux.bet&pg=0.0...0',
          ],
          'px_1' => [
            'markup' => [
              0 => '1',
              1 => '6',
              4 => '1',
            ],
            'querystring' => '?px=1.6...1',
          ],
        ],
      ],
    ];

    // Loop through test sets.
    foreach ([
      'page',
      'pg_0',
      'px_1',
    ] as $set) {
      $match_querystring = 'expected_querystring_' . $set;
      switch ($set) {
        case 'core':

          // Run with default: 'page' and 0-based page numbers.
          // Using 'page', it works.
          // Using 'pg' or 'px', pager is not initialised.
          break;
        case 'pg_0':

          // Override: 'pg' and 0-based page numbers.
          // Using 'page' or 'pg', it works.
          // Using 'px', pager is not initialised.
          $this
            ->drupalGet($this->pagererAdmin . '/url_settings');
          $this
            ->submitForm([
            'core_override_querystring' => TRUE,
          ], 'Save configuration');
          break;
        case 'px_1':

          // Override: 'px' and 1-based page numbers.
          // Using 'page' or 'px', it works.
          // Using 'pg', pager is not initialised.
          $this
            ->drupalGet($this->pagererAdmin . '/url_settings');
          $this
            ->submitForm([
            'index_base' => 1,
            'querystring_key' => 'px',
          ], 'Save configuration');
          break;
      }
      foreach ($test_data as $data) {
        $input_query = str_replace(' ', '%20', $data['input_querystring']);
        $expected_markup = $data['expected'][$set]['markup'];
        $this
          ->drupalGet($GLOBALS['base_root'] . '/pager-test/multiple-pagers' . $input_query, [
          'external' => TRUE,
        ]);
        foreach (array_keys($expected_markup) as $pager_element) {
          $active_page = $this
            ->cssSelect("div.test-pager-{$pager_element} ul.pager__items li.is-active:contains('{$expected_markup[$pager_element]}')");
          $this
            ->assertNotEmpty($active_page, $data['input_querystring'] . " // {$pager_element} // {$set}");
          $destination = $active_page[0]
            ->find('css', 'a')
            ->getAttribute('href');
          $destination = str_replace('%20', ' ', $destination);
          $this
            ->assertEquals($data['expected'][$set]['querystring'], $destination, $data['input_querystring'] . " // {$pager_element} // {$set}");
        }
      }
    }
  }

  /**
   * Test proper functioning of multiple adaptive keys pagers.
   */
  public function testAdaptiveKeysQuerystring() {

    // Add more entries in the log.
    for ($i = 0; $i < 2700; $i++) {
      $this->container
        ->get('logger.factory')
        ->get('pager_test')
        ->debug($this
        ->randomString());
    }

    // Setup the core overriden pager to Adaptive without breakers.
    $this
      ->drupalGet($this->pagererAdmin . '/preset/add');
    $this
      ->submitForm([
      'label' => 'ui_test',
      'id' => 'ui_test',
    ], 'Create');
    $this
      ->drupalGet($this->pagererAdmin);
    $this
      ->submitForm([
      'core_override_preset' => 'ui_test',
    ], 'Save configuration');
    $this
      ->drupalGet($this->pagererAdmin . '/preset/manage/ui_test');
    $this
      ->submitForm([
      'panes_container[left][style]' => 'none',
      'panes_container[center][style]' => 'adaptive',
      'panes_container[right][style]' => 'none',
    ], 'Save');
    $this
      ->drupalGet($this->pagererAdmin . '/preset/manage/ui_test');
    $this
      ->click('[id="edit-panes-container-center-actions-configure"]');
    $this
      ->submitForm([
      'breaker_display' => FALSE,
    ], 'Save');

    // Test data.
    $test_data = [
      [
        'pager_id' => 0,
        'pager_item' => 7,
        'expected_querystring_core' => '?page=75%2C0%2C%2C%2C0&page_ak=37.150',
        'expected_querystring_pg_0' => '?pg=75.0...0-ak-37_150',
        'expected_querystring_px_1' => '?px=76.1...1-ak-38_151',
      ],
      [
        'pager_id' => 0,
        'pager_item' => 5,
        'expected_querystring_core' => '?page=74%2C0%2C%2C%2C0&page_ak=37.150.75',
        'expected_querystring_pg_0' => '?pg=74.0...0-ak-37_150_75',
        'expected_querystring_px_1' => '?px=75.1...1-ak-38_151_76',
      ],
      [
        'pager_id' => 0,
        'pager_item' => 7,
        'expected_querystring_core' => '?page=75%2C0%2C%2C%2C0&page_ak=37.150.75',
        'expected_querystring_pg_0' => '?pg=75.0...0-ak-37_150_75',
        'expected_querystring_px_1' => '?px=76.1...1-ak-38_151_76',
      ],
      [
        'pager_id' => 0,
        'pager_item' => 7,
        'expected_querystring_core' => '?page=76%2C0%2C%2C%2C0&page_ak=37.150.75',
        'expected_querystring_pg_0' => '?pg=76.0...0-ak-37_150_75',
        'expected_querystring_px_1' => '?px=77.1...1-ak-38_151_76',
      ],
      [
        'pager_id' => 0,
        'pager_item' => 7,
        'expected_querystring_core' => '?page=77%2C0%2C%2C%2C0&page_ak=37.150.75',
        'expected_querystring_pg_0' => '?pg=77.0...0-ak-37_150_75',
        'expected_querystring_px_1' => '?px=78.1...1-ak-38_151_76',
      ],
      [
        'pager_id' => 0,
        'pager_item' => 9,
        'expected_querystring_core' => '?page=93%2C0%2C%2C%2C0&page_ak=79.112',
        'expected_querystring_pg_0' => '?pg=93.0...0-ak-79_112',
        'expected_querystring_px_1' => '?px=94.1...1-ak-80_113',
      ],
      [
        'pager_id' => 1,
        'pager_item' => 3,
        'expected_querystring_core' => '?page=93%2C2%2C%2C%2C0&page_ak=79.112',
        'expected_querystring_pg_0' => '?pg=93.2...0-ak-79_112',
        'expected_querystring_px_1' => '?px=94.3...1-ak-80_113',
      ],
      [
        'pager_id' => 4,
        'pager_item' => 8,
        'expected_querystring_core' => '?page=93%2C2%2C%2C%2C150&page_ak=79.112',
        'expected_querystring_pg_0' => '?pg=93.2...150-ak-79_112',
        'expected_querystring_px_1' => '?px=94.3...151-ak-80_113',
      ],
      [
        'pager_id' => 4,
        'pager_item' => 2,
        'expected_querystring_core' => '?page=93%2C2%2C%2C%2C75&page_ak=79.112%2C%2C%2C%2C0.113',
        'expected_querystring_pg_0' => '?pg=93.2...75-ak-79_112....0_113',
        'expected_querystring_px_1' => '?px=94.3...76-ak-80_113....1_114',
      ],
    ];

    // Loop through test sets.
    foreach ([
      'core',
      'pg_0',
      'px_1',
    ] as $set) {
      $match_querystring = 'expected_querystring_' . $set;
      switch ($set) {
        case 'core':
          break;
        case 'pg_0':

          // Override: 'pg' and 0-based page numbers.
          $this
            ->drupalGet($this->pagererAdmin . '/url_settings');
          $this
            ->submitForm([
            'core_override_querystring' => TRUE,
          ], 'Save configuration');
          break;
        case 'px_1':

          // Override: 'px' and 1-based page numbers.
          $this
            ->drupalGet($this->pagererAdmin . '/url_settings');
          $this
            ->submitForm([
            'index_base' => 1,
            'querystring_key' => 'px',
          ], 'Save configuration');
          break;
      }

      // First page.
      $this
        ->drupalGet('pager-test/multiple-pagers');

      // Loop through test pager clicks.
      foreach ($test_data as $id => $test) {
        $elements = $this
          ->xpath('//div[contains(@class, :pager)]//ul[contains(@class, :items)]/li[' . $test['pager_item'] . ']/a', [
          ':pager' => 'test-pager-' . $test['pager_id'],
          ':items' => 'pager__items',
        ]);
        $this
          ->assertStringContainsString($test[$match_querystring], $elements[0]
          ->getAttribute('href'), "Test {$id}");
        $elements[0]
          ->click();
        $this
          ->assertStringContainsString('pager-test/multiple-pagers' . $test[$match_querystring], $this
          ->getUrl(), "Test {$id}");
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PagererTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PagererTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
PagererTest::$pagererAdmin protected property The URL for Pagerer admin UI page.
PagererTest::setUp public function Overrides BrowserTestBase::setUp
PagererTest::testAdaptiveKeysQuerystring public function Test proper functioning of multiple adaptive keys pagers.
PagererTest::testPagerer public function Tests Pagerer functionality.
PagererTest::testQuerystringOverrides public function Test proper functioning of multiple pagers with overridden querystring.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.