You are here

Home » API reference » Drupal 9 » PagerTest.php

class PagerTest in Drupal 9

Same name in this branch
  1. 9 core/modules/views/tests/src/Functional/Plugin/PagerTest.php \Drupal\Tests\views\Functional\Plugin\PagerTest
  2. 9 core/modules/views/tests/src/Functional/Wizard/PagerTest.php \Drupal\Tests\views\Functional\Wizard\PagerTest
  3. 9 core/modules/system/tests/src/Functional/Pager/PagerTest.php \Drupal\Tests\system\Functional\Pager\PagerTest
Same name and namespace in other branches
  1. 8 core/modules/views/tests/src/Functional/Plugin/PagerTest.php \Drupal\Tests\views\Functional\Plugin\PagerTest

Tests the pluggable pager system.

@group views

Hierarchy

Expanded class hierarchy of PagerTest

File

core/modules/views/tests/src/Functional/Plugin/PagerTest.php, line 15

Namespace

Drupal\Tests\views\Functional\Plugin
View source 
class PagerTest extends ViewTestBase {
  use AssertPageCacheContextsAndTagsTrait;

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_store_pager_settings',
    'test_pager_none',
    'test_pager_some',
    'test_pager_full',
    'test_view_pager_full_zero_items_per_page',
    'test_view',
    'content',
  ];

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'node',
    'views_ui',
  ];

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

  /**
   * String translation storage object.
   *
   * @var \Drupal\locale\StringStorageInterface
   */
  protected $localeStorage;

  /**
   * Pagers was sometimes not stored.
   *
   * @see https://www.drupal.org/node/652712
   */
  public function testStorePagerSettings() {

    // Show the default display so the override selection is shown.
    \Drupal::configFactory()
      ->getEditable('views.settings')
      ->set('ui.show.default_display', TRUE)
      ->save();
    $admin_user = $this
      ->drupalCreateUser([
      'administer views',
      'administer site configuration',
    ]);
    $this
      ->drupalLogin($admin_user);

    // Test behavior described in
    // https://www.drupal.org/node/652712#comment-2354918.
    $this
      ->drupalGet('admin/structure/views/view/test_view/edit');
    $edit = [
      'pager[type]' => 'some',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_view/default/pager');
    $this
      ->submitForm($edit, 'Apply');
    $items_per_page = $this
      ->assertSession()
      ->fieldExists("pager_options[items_per_page]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[items_per_page]", 10);
    $this
      ->assertSame('number', $items_per_page
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $items_per_page
      ->getAttribute('min'));
    $offset = $this
      ->assertSession()
      ->fieldExists("pager_options[offset]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[offset]", 0);
    $this
      ->assertSame('number', $offset
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $offset
      ->getAttribute('min'));
    $edit = [
      'pager[type]' => 'none',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_view/default/pager');
    $this
      ->submitForm($edit, 'Apply');
    $offset = $this
      ->assertSession()
      ->fieldExists("pager_options[offset]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[offset]", 0);
    $this
      ->assertSame('number', $offset
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $offset
      ->getAttribute('min'));
    $edit = [
      'pager[type]' => 'full',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_view/default/pager');
    $this
      ->submitForm($edit, 'Apply');
    $items_per_page = $this
      ->assertSession()
      ->fieldExists("pager_options[items_per_page]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[items_per_page]", 10);
    $this
      ->assertSame('number', $items_per_page
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $items_per_page
      ->getAttribute('min'));
    $offset = $this
      ->assertSession()
      ->fieldExists("pager_options[offset]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[offset]", 0);
    $this
      ->assertSame('number', $offset
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $offset
      ->getAttribute('min'));
    $id = $this
      ->assertSession()
      ->fieldExists("pager_options[id]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[id]", 0);
    $this
      ->assertSame('number', $id
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $id
      ->getAttribute('min'));
    $total_pages = $this
      ->assertSession()
      ->fieldExists("pager_options[total_pages]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[total_pages]", '');
    $this
      ->assertSame('number', $total_pages
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $total_pages
      ->getAttribute('min'));
    $quantity = $this
      ->assertSession()
      ->fieldExists("pager_options[quantity]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[quantity]", 9);
    $this
      ->assertSame('number', $quantity
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $quantity
      ->getAttribute('min'));
    $edit = [
      'pager_options[items_per_page]' => 20,
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_view/default/pager_options');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->assertSession()
      ->pageTextContains('20 items');

    // Change type and check whether the type is new type is stored.
    $edit = [
      'pager[type]' => 'mini',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_view/default/pager');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->drupalGet('admin/structure/views/view/test_view/edit');
    $this
      ->assertSession()
      ->pageTextContains('Mini');

    // Test behavior described in
    // https://www.drupal.org/node/652712#comment-2354400.
    $view = Views::getView('test_store_pager_settings');

    // Make it editable in the admin interface.
    $view
      ->save();
    $this
      ->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
    $edit = [
      'pager[type]' => 'full',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/default/pager');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
    $this
      ->assertSession()
      ->pageTextContains('Full');
    $edit = [
      'pager_options[items_per_page]' => 20,
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/default/pager_options');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->assertSession()
      ->pageTextContains('20 items');

    // add new display and test the settings again, by override it.
    $edit = [];

    // Add a display and override the pager settings.
    $this
      ->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
    $this
      ->submitForm($edit, 'Add Page');
    $edit = [
      'override[dropdown]' => 'page_1',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager');
    $this
      ->submitForm($edit, 'Apply');
    $edit = [
      'pager[type]' => 'mini',
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->drupalGet('admin/structure/views/view/test_store_pager_settings/edit/page_1');
    $this
      ->assertSession()
      ->pageTextContains('Mini');
    $edit = [
      'pager_options[items_per_page]' => 10,
    ];
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/default/pager_options');
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->assertSession()
      ->pageTextContains('10 items');
    $this
      ->drupalGet('admin/structure/views/view/test_store_pager_settings/edit/page_1');
    $this
      ->assertSession()
      ->pageTextContains('20 items');

    // Test that the override element is only displayed on pager plugin selection form.
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager');
    $this
      ->assertSession()
      ->fieldValueEquals('override[dropdown]', 'page_1');
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager_options');
    $this
      ->assertSession()
      ->fieldNotExists('override[dropdown]');
    $items_per_page = $this
      ->assertSession()
      ->fieldExists("pager_options[items_per_page]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[items_per_page]", 20);
    $this
      ->assertSame('number', $items_per_page
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $items_per_page
      ->getAttribute('min'));
    $offset = $this
      ->assertSession()
      ->fieldExists("pager_options[offset]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[offset]", 0);
    $this
      ->assertSame('number', $offset
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $offset
      ->getAttribute('min'));
    $id = $this
      ->assertSession()
      ->fieldExists("pager_options[id]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[id]", 0);
    $this
      ->assertSame('number', $id
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $id
      ->getAttribute('min'));
    $total_pages = $this
      ->assertSession()
      ->fieldExists("pager_options[total_pages]");
    $this
      ->assertSession()
      ->fieldValueEquals("pager_options[total_pages]", '');
    $this
      ->assertSame('number', $total_pages
      ->getAttribute('type'));
    $this
      ->assertEquals(0, $total_pages
      ->getAttribute('min'));
  }

  /**
   * Tests the none-pager-query.
   */
  public function testNoLimit() {

    // Create 11 nodes and make sure that everyone is returned.
    // We create 11 nodes, because the default pager plugin had 10 items per page.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }
    $view = Views::getView('test_pager_none');
    $this
      ->executeView($view);
    $this
      ->assertCount(11, $view->result, 'Make sure that every item is returned in the result');

    // Setup and test an offset.
    $view = Views::getView('test_pager_none');
    $view
      ->setDisplay();
    $pager = [
      'type' => 'none',
      'options' => [
        'offset' => 3,
      ],
    ];
    $view->display_handler
      ->setOption('pager', $pager);
    $this
      ->executeView($view);
    $this
      ->assertCount(8, $view->result, 'Make sure that every item beside the first three is returned in the result');

    // Check some public functions.
    $this
      ->assertFalse($view->pager
      ->usePager());
    $this
      ->assertFalse($view->pager
      ->useCountQuery());
    $this
      ->assertEquals(0, $view->pager
      ->getItemsPerPage());
  }
  public function testViewTotalRowsWithoutPager() {
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 23; $i++) {
      $this
        ->drupalCreateNode();
    }
    $view = Views::getView('test_pager_none');
    $view->get_total_rows = TRUE;
    $this
      ->executeView($view);
    $this
      ->assertEquals(23, $view->total_rows, "'total_rows' is calculated when pager type is 'none' and 'get_total_rows' is TRUE.");
  }

  /**
   * Tests the some pager plugin.
   */
  public function testLimit() {

    // Create 11 nodes and make sure that everyone is returned.
    // We create 11 nodes, because the default pager plugin had 10 items per page.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }
    $view = Views::getView('test_pager_some');
    $this
      ->executeView($view);
    $this
      ->assertCount(5, $view->result, 'Make sure that only a certain count of items is returned');

    // Setup and test an offset.
    $view = Views::getView('test_pager_some');
    $view
      ->setDisplay();
    $pager = [
      'type' => 'none',
      'options' => [
        'offset' => 8,
        'items_per_page' => 5,
      ],
    ];
    $view->display_handler
      ->setOption('pager', $pager);
    $this
      ->executeView($view);
    $this
      ->assertCount(3, $view->result, 'Make sure that only a certain count of items is returned');

    // Check some public functions.
    $this
      ->assertFalse($view->pager
      ->usePager());
    $this
      ->assertFalse($view->pager
      ->useCountQuery());
  }

  /**
   * Tests the normal pager.
   */
  public function testNormalPager() {

    // Create 11 nodes and make sure that everyone is returned.
    // We create 11 nodes, because the default pager plugin had 10 items per page.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }
    $view = Views::getView('test_pager_full');
    $this
      ->executeView($view);
    $this
      ->assertCount(5, $view->result, 'Make sure that only a certain count of items is returned');

    // Setup and test an offset.
    $view = Views::getView('test_pager_full');
    $view
      ->setDisplay();
    $pager = [
      'type' => 'full',
      'options' => [
        'offset' => 8,
        'items_per_page' => 5,
      ],
    ];
    $view->display_handler
      ->setOption('pager', $pager);
    $this
      ->executeView($view);
    $this
      ->assertCount(3, $view->result, 'Make sure that only a certain count of items is returned');

    // Test items per page = 0
    $view = Views::getView('test_view_pager_full_zero_items_per_page');
    $this
      ->executeView($view);
    $this
      ->assertCount(11, $view->result, 'All items are return');

    // TODO test number of pages.
    // Test items per page = 0.
    // Setup and test an offset.
    $view = Views::getView('test_pager_full');
    $view
      ->setDisplay();
    $pager = [
      'type' => 'full',
      'options' => [
        'offset' => 0,
        'items_per_page' => 0,
      ],
    ];
    $view->display_handler
      ->setOption('pager', $pager);
    $this
      ->executeView($view);
    $this
      ->assertEquals(0, $view->pager
      ->getItemsPerPage());
    $this
      ->assertCount(11, $view->result);

    // Test pager cache contexts.
    $this
      ->drupalGet('test_pager_full');
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'theme',
      'timezone',
      'url.query_args',
      'user.node_grants:view',
    ]);
  }

  /**
   * Tests rendering with NULL pager.
   */
  public function testRenderNullPager() {

    // Create 11 nodes and make sure that everyone is returned.
    // We create 11 nodes, because the default pager plugin had 10 items per page.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }
    $view = Views::getView('test_pager_full');
    $this
      ->executeView($view);

    // Force the value again here.
    $view
      ->setAjaxEnabled(TRUE);
    $view->pager = NULL;
    $output = $view
      ->render();
    $output = \Drupal::service('renderer')
      ->renderRoot($output);
    $this
      ->assertEquals(0, preg_match('/<ul class="pager">/', $output), 'The pager is not rendered.');
  }

  /**
   * Tests the api functions on the view object.
   */
  public function testPagerApi() {
    $view = Views::getView('test_pager_full');
    $view
      ->setDisplay();

    // On the first round don't initialize the pager.
    $this
      ->assertNull($view
      ->getItemsPerPage(), 'If the pager is not initialized and no manual override there is no items per page.');
    $rand_number = rand(1, 5);
    $view
      ->setItemsPerPage($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getItemsPerPage(), 'Make sure getItemsPerPage uses the settings of setItemsPerPage.');
    $this
      ->assertNull($view
      ->getOffset(), 'If the pager is not initialized and no manual override there is no offset.');
    $rand_number = rand(1, 5);
    $view
      ->setOffset($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getOffset(), 'Make sure getOffset uses the settings of setOffset.');
    $this
      ->assertNull($view
      ->getCurrentPage(), 'If the pager is not initialized and no manual override there is no current page.');
    $rand_number = rand(1, 5);
    $view
      ->setCurrentPage($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getCurrentPage(), 'Make sure getCurrentPage uses the settings of set_current_page.');
    $view
      ->destroy();

    // On this round enable the pager.
    $view
      ->initDisplay();
    $view
      ->initQuery();
    $view
      ->initPager();
    $this
      ->assertEquals(5, $view
      ->getItemsPerPage(), 'Per default the view has 5 items per page.');
    $rand_number = rand(1, 5);
    $view
      ->setItemsPerPage($rand_number);
    $rand_number = rand(6, 11);
    $view->pager
      ->setItemsPerPage($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getItemsPerPage(), 'Make sure getItemsPerPage uses the settings of setItemsPerPage.');
    $this
      ->assertEquals(0, $view
      ->getOffset(), 'Per default a view has a 0 offset.');
    $rand_number = rand(1, 5);
    $view
      ->setOffset($rand_number);
    $rand_number = rand(6, 11);
    $view->pager
      ->setOffset($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getOffset(), 'Make sure getOffset uses the settings of setOffset.');
    $this
      ->assertEquals(0, $view
      ->getCurrentPage(), 'Per default the current page is 0.');
    $rand_number = rand(1, 5);
    $view
      ->setCurrentPage($rand_number);
    $rand_number = rand(6, 11);
    $view->pager
      ->setCurrentPage($rand_number);
    $this
      ->assertEquals($rand_number, $view
      ->getCurrentPage(), 'Make sure getCurrentPage uses the settings of set_current_page.');

    // Set an invalid page and make sure the method takes care about it.
    $view
      ->setCurrentPage(-1);
    $this
      ->assertEquals(0, $view
      ->getCurrentPage(), 'Make sure setCurrentPage always sets a valid page number.');
  }

  /**
   * Tests translating the pager using config_translation.
   */
  public function testPagerConfigTranslation() {
    $view = Views::getView('content');
    $display =& $view->storage
      ->getDisplay('default');
    $display['display_options']['pager']['options']['items_per_page'] = 5;
    $view
      ->save();

    // Enable locale, config_translation and language module.
    $this->container
      ->get('module_installer')
      ->install([
      'locale',
      'language',
      'config_translation',
    ]);
    $this
      ->resetAll();
    $admin_user = $this
      ->drupalCreateUser([
      'access content overview',
      'administer nodes',
      'bypass node access',
      'translate configuration',
    ]);
    $this
      ->drupalLogin($admin_user);
    $langcode = 'nl';

    // Add a default locale storage for this test.
    $this->localeStorage = $this->container
      ->get('locale.storage');

    // Add Dutch language programmatically.
    ConfigurableLanguage::createFromLangcode($langcode)
      ->save();
    $edit = [
      'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][first]' => '« Eerste',
      'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][previous]' => '‹ Vorige',
      'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][next]' => 'Volgende ›',
      'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][last]' => 'Laatste »',
    ];
    $this
      ->drupalGet('admin/structure/views/view/content/translate/nl/edit');
    $this
      ->submitForm($edit, 'Save translation');

    // We create 11 nodes, this will give us 3 pages.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }

    // Go to the second page so we see both previous and next buttons.
    $this
      ->drupalGet('nl/admin/content', [
      'query' => [
        'page' => 1,
      ],
    ]);

    // Translation mapping..
    $labels = [
      '« First' => '« Eerste',
      '‹ Previous' => '‹ Vorige',
      'Next ›' => 'Volgende ›',
      'Last »' => 'Laatste »',
    ];
    foreach ($labels as $label => $translation) {

      // Check if we can find the translation.
      $this
        ->assertSession()
        ->pageTextContains($translation);
    }
  }

  /**
   * Tests translating the pager using locale.
   */
  public function testPagerLocale() {

    // Enable locale and language module.
    $this->container
      ->get('module_installer')
      ->install([
      'locale',
      'language',
    ]);
    $this
      ->resetAll();
    $langcode = 'nl';

    // Add a default locale storage for this test.
    $this->localeStorage = $this->container
      ->get('locale.storage');

    // Add Dutch language programmatically.
    ConfigurableLanguage::createFromLangcode($langcode)
      ->save();

    // Labels that need translations.
    $labels = [
      '« First' => '« Eerste',
      '‹ Previous' => '‹ Vorige',
      'Next ›' => 'Volgende ›',
      'Last »' => 'Laatste »',
    ];
    foreach ($labels as $label => $translation) {

      // Create source string.
      $source = $this->localeStorage
        ->createString([
        'source' => $label,
      ]);
      $source
        ->save();
      $this
        ->createTranslation($source, $translation, $langcode);
    }

    // We create 11 nodes, this will give us 3 pages.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    for ($i = 0; $i < 11; $i++) {
      $this
        ->drupalCreateNode();
    }

    // Go to the second page so we see both previous and next buttons.
    $this
      ->drupalGet('nl/test_pager_full', [
      'query' => [
        'page' => 1,
      ],
    ]);
    foreach ($labels as $label => $translation) {

      // Check if we can find the translation.
      $this
        ->assertSession()
        ->pageTextContains($translation);
    }
  }

  /**
   * Creates single translation for source string.
   */
  protected function createTranslation($source, $translation, $langcode) {
    $values = [
      'lid' => $source->lid,
      'language' => $langcode,
      'translation' => $translation,
    ];
    return $this->localeStorage
      ->createTranslation($values)
      ->save();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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::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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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::$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. 1
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. 20
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. 1
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
PagerTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PagerTest::$localeStorage protected property String translation storage object.
PagerTest::$modules protected static property Modules to enable. Overrides ViewTestBase::$modules
PagerTest::$testViews public static property Views used by this test.
PagerTest::createTranslation protected function Creates single translation for source string.
PagerTest::testLimit public function Tests the some pager plugin.
PagerTest::testNoLimit public function Tests the none-pager-query.
PagerTest::testNormalPager public function Tests the normal pager.
PagerTest::testPagerApi public function Tests the api functions on the view object.
PagerTest::testPagerConfigTranslation public function Tests translating the pager using config_translation.
PagerTest::testPagerLocale public function Tests translating the pager using locale.
PagerTest::testRenderNullPager public function Tests rendering with NULL pager.
PagerTest::testStorePagerSettings public function Pagers was sometimes not stored.
PagerTest::testViewTotalRowsWithoutPager public function
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::setUp protected function Overrides BrowserTestBase::setUp 74
ViewTestBase::viewsData protected function Returns the views data definition. 8
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.