You are here

Home » API reference » Menu Block 8 » MenuBlockTest.php

class MenuBlockTest in Menu Block 8

Tests for the menu_block module.

@group menu_block

Hierarchy

Expanded class hierarchy of MenuBlockTest

File

tests/src/Functional/MenuBlockTest.php, line 13

Namespace

Drupal\Tests\menu_block\Functional
View source 
class MenuBlockTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'block',
    'menu_block',
    'menu_block_test',
  ];

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

  /**
   * An administrative user to configure the test environment.
   *
   * @var \Drupal\user\Entity\User|false
   */
  protected $adminUser;

  /**
   * The menu link plugin manager.
   *
   * @var \Drupal\Core\Menu\MenuLinkManagerInterface
   */
  protected $menuLinkManager;

  /**
   * The block storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $blockStorage;

  /**
   * The block view builder.
   *
   * @var \Drupal\Core\Entity\EntityViewBuilderInterface
   */
  protected $blockViewBuilder;

  /**
   * The menu link content storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $menuLinkContentStorage;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * An array containing the menu link plugin ids.
   *
   * @var array
   */
  protected $links;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this->menuLinkManager = \Drupal::service('plugin.manager.menu.link');
    $this->blockStorage = \Drupal::service('entity_type.manager')
      ->getStorage('block');
    $this->blockViewBuilder = \Drupal::service('entity_type.manager')
      ->getViewBuilder('block');
    $this->menuLinkContentStorage = \Drupal::service('entity_type.manager')
      ->getStorage('menu_link_content');
    $this->moduleHandler = \Drupal::moduleHandler();
    $this->links = $this
      ->createLinkHierarchy();

    // Create and log in an administrative user.
    $this->adminUser = $this
      ->drupalCreateUser([
      'administer blocks',
      'access administration pages',
    ]);
    $this
      ->drupalLogin($this->adminUser);
  }

  /**
   * Creates a simple hierarchy of links.
   */
  protected function createLinkHierarchy() {

    // First remove all the menu links in the menu.
    $this->menuLinkManager
      ->deleteLinksInMenu('main');

    // Then create a simple link hierarchy:
    // - parent menu item
    //   - child-1 menu item
    //     - child-1-1 menu item
    //     - child-1-2 menu item
    //   - child-2 menu item.
    $base_options = [
      'provider' => 'menu_block',
      'menu_name' => 'main',
    ];
    $parent = $base_options + [
      'title' => 'parent menu item',
      'link' => [
        'uri' => 'internal:/menu-block-test/hierarchy/parent',
      ],
    ];

    /** @var \Drupal\menu_link_content\MenuLinkContentInterface $link */
    $link = $this->menuLinkContentStorage
      ->create($parent);
    $link
      ->save();
    $links['parent'] = $link
      ->getPluginId();
    $child_1 = $base_options + [
      'title' => 'child-1 menu item',
      'link' => [
        'uri' => 'internal:/menu-block-test/hierarchy/parent/child-1',
      ],
      'parent' => $links['parent'],
    ];
    $link = $this->menuLinkContentStorage
      ->create($child_1);
    $link
      ->save();
    $links['child-1'] = $link
      ->getPluginId();
    $child_1_1 = $base_options + [
      'title' => 'child-1-1 menu item',
      'link' => [
        'uri' => 'internal:/menu-block-test/hierarchy/parent/child-1/child-1-1',
      ],
      'parent' => $links['child-1'],
    ];
    $link = $this->menuLinkContentStorage
      ->create($child_1_1);
    $link
      ->save();
    $links['child-1-1'] = $link
      ->getPluginId();
    $child_1_2 = $base_options + [
      'title' => 'child-1-2 menu item',
      'link' => [
        'uri' => 'internal:/menu-block-test/hierarchy/parent/child-1/child-1-2',
      ],
      'parent' => $links['child-1'],
    ];
    $link = $this->menuLinkContentStorage
      ->create($child_1_2);
    $link
      ->save();
    $links['child-1-2'] = $link
      ->getPluginId();
    $child_2 = $base_options + [
      'title' => 'child-2 menu item',
      'link' => [
        'uri' => 'internal:/menu-block-test/hierarchy/parent/child-2',
      ],
      'parent' => $links['parent'],
    ];
    $link = $this->menuLinkContentStorage
      ->create($child_2);
    $link
      ->save();
    $links['child-2'] = $link
      ->getPluginId();
    return $links;
  }

  /**
   * Checks if all menu block configuration options are available.
   */
  public function testMenuBlockFormDisplay() {
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->assertSession()
      ->pageTextContains('Initial visibility level');
    $this
      ->assertSession()
      ->pageTextContains('Number of levels to display');
    $this
      ->assertSession()
      ->pageTextContains('Expand all menu items');
    $this
      ->assertSession()
      ->pageTextContains('Fixed parent item');
    $this
      ->assertSession()
      ->pageTextContains('Make the initial visibility level follow the active menu item.');
    $this
      ->assertSession()
      ->pageTextContains('Theme hook suggestion');
  }

  /**
   * Checks if all menu block settings are saved correctly.
   */
  public function testMenuBlockUi() {
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[level]' => 2,
      'settings[depth]' => 6,
      'settings[expand_all_items]' => TRUE,
      'settings[parent]' => 'main:',
      'settings[follow]' => TRUE,
      'settings[follow_parent]' => 'active',
      'settings[suggestion]' => 'main',
      'region' => 'primary_menu',
    ], 'Save block');
    $block = $this->blockStorage
      ->load($block_id);
    $block_settings = $block
      ->get('settings');
    $this
      ->assertSame(2, $block_settings['level']);
    $this
      ->assertSame(6, $block_settings['depth']);
    $this
      ->assertTrue($block_settings['expand_all_items']);
    $this
      ->assertSame('main:', $block_settings['parent']);
    $this
      ->assertTrue($block_settings['follow']);
    $this
      ->assertSame('active', $block_settings['follow_parent']);
    $this
      ->assertSame('main', $block_settings['suggestion']);
  }

  /**
   * Tests the menu_block level option.
   */
  public function testMenuBlockLevel() {

    // Add new menu block.
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[level]' => 1,
      'region' => 'primary_menu',
    ], 'Save block');

    // Check if the parent menu item is visible, but the child menu items not.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-2 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[level]' => 2,
    ], 'Save block');

    // Check if the menu items of level 2 are visible, but not the parent menu
    // item.
    $this
      ->drupalGet('menu-block-test/hierarchy/parent');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-2 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
  }

  /**
   * Tests the menu_block depth option.
   */
  public function testMenuBlockDepth() {

    // Add new menu block.
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[level]' => 1,
      'settings[depth]' => 1,
      'settings[expand_all_items]' => TRUE,
      'region' => 'primary_menu',
    ], 'Save block');

    // Check if the parent menu item is visible, but the child menu items not.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-2 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[depth]' => 2,
    ], 'Save block');

    // Check if the menu items of level 2 are visible, but not the parent menu
    // item.
    $this
      ->drupalGet('menu-block-test/hierarchy/parent');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-2 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[depth]' => 0,
    ], 'Save block');

    // Check if the menu items of level 2 are visible, but not the parent menu
    // item.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-2 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-1 menu item');
  }

  /**
   * Tests the menu_block expand option.
   */
  public function testMenuBlockExpand() {
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[level]' => 1,
      'settings[expand_all_items]' => TRUE,
      'region' => 'primary_menu',
    ], 'Save block');

    // Check if the parent menu item is visible, but the child menu items not.
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-2 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[expand_all_items]' => FALSE,
    ], 'Save block');
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-2 menu item');
  }

  /**
   * Tests the menu_block parent option.
   */
  public function testMenuBlockParent() {
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[parent]' => 'main:' . $this->links['parent'],
      'region' => 'primary_menu',
    ], 'Save block');
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextNotContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[parent]' => 'main:' . $this->links['child-1'],
    ], 'Save block');
    $this
      ->assertSession()
      ->pageTextNotContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-2 menu item');
  }

  /**
   * Tests the menu_block follow and follow_parent option.
   */
  public function testMenuBlockFollow() {
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[follow]' => TRUE,
      'settings[follow_parent]' => 'child',
      'region' => 'primary_menu',
    ], 'Save block');
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->drupalGet('menu-block-test/hierarchy/parent');
    $this
      ->assertSession()
      ->pageTextNotContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-2 menu item');
    $this
      ->drupalGet('menu-block-test/hierarchy/parent/child-1');
    $this
      ->assertSession()
      ->pageTextNotContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-1 menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1-2 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-2 menu item');
    $this
      ->drupalGet('admin/structure/block/manage/' . $block_id);
    $this
      ->submitForm([
      'settings[follow_parent]' => 'active',
    ], 'Save block');
    $this
      ->drupalGet('<front>');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
    $this
      ->drupalGet('menu-block-test/hierarchy/parent');
    $this
      ->assertSession()
      ->pageTextContains('parent menu item');
    $this
      ->assertSession()
      ->pageTextContains('child-1 menu item');
    $this
      ->assertSession()
      ->pageTextNotContains('child-1-1 menu item');
  }

  /**
   * Tests the menu_block suggestion option.
   */
  public function testMenuBlockSuggestion() {
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Main navigation',
      'settings[label_display]' => FALSE,
      'settings[suggestion]' => 'mainnav',
      'region' => 'primary_menu',
    ], 'Save block');

    /** @var \Drupal\block\BlockInterface $block */
    $block = $this->blockStorage
      ->load($block_id);
    $plugin = $block
      ->getPlugin();

    // Check theme suggestions for block template.
    $variables = [];
    $variables['elements']['#configuration'] = $plugin
      ->getConfiguration();
    $variables['elements']['#plugin_id'] = $plugin
      ->getPluginId();
    $variables['elements']['#id'] = $block
      ->id();
    $variables['elements']['#base_plugin_id'] = $plugin
      ->getBaseId();
    $variables['elements']['#derivative_plugin_id'] = $plugin
      ->getDerivativeId();
    $variables['elements']['content'] = [];
    $suggestions = $this->moduleHandler
      ->invokeAll('theme_suggestions_block', [
      $variables,
    ]);
    $base_theme_hook = 'menu_block';
    $hooks = [
      'theme_suggestions',
      'theme_suggestions_' . $base_theme_hook,
    ];
    $this->moduleHandler
      ->alter($hooks, $suggestions, $variables, $base_theme_hook);
    $this
      ->assertSame($suggestions, [
      'block__menu_block',
      'block__menu_block',
      'block__menu_block__main',
      'block__main',
      'block__menu_block__mainnav',
    ], 'Found expected block suggestions.');

    // Check theme suggestions for menu template.
    $variables = [
      'menu_name' => 'main',
      'menu_block_configuration' => $plugin
        ->getConfiguration(),
    ];
    $suggestions = $this->moduleHandler
      ->invokeAll('theme_suggestions_menu', [
      $variables,
    ]);
    $base_theme_hook = 'menu';
    $hooks = [
      'theme_suggestions',
      'theme_suggestions_' . $base_theme_hook,
    ];
    $this->moduleHandler
      ->alter($hooks, $suggestions, $variables, $base_theme_hook);
    $this
      ->assertSame($suggestions, [
      'menu__main',
      'menu__mainnav',
    ], 'Found expected menu suggestions.');
  }

  /**
   * Test menu block label type options.
   */
  public function testMenuBlockTitleOptions() {

    // Create a block, and edit it repeatedly to test the title display options.
    $block_id = 'main';
    $this
      ->drupalGet('admin/structure/block/add/menu_block:main');
    $this
      ->submitForm([
      'id' => $block_id,
      'settings[label]' => 'Block title',
      'settings[label_display]' => TRUE,
      'settings[label_link]' => FALSE,
      'settings[parent]' => 'main:' . $this->links['child-1'],
      'region' => 'primary_menu',
    ], 'Save block');
    $options = [
      'block label' => [
        'option' => MenuBlock::LABEL_BLOCK,
        'title' => 'Block title',
      ],
      'menu label' => [
        'option' => MenuBlock::LABEL_MENU,
        'title' => 'Main navigation',
      ],
      'fixed menu item' => [
        'option' => MenuBlock::LABEL_FIXED,
        'title' => 'child-1 menu item',
      ],
      'fixed menu item as link' => [
        'option' => MenuBlock::LABEL_FIXED,
        'title' => 'child-1 menu item',
        'label_link' => TRUE,
      ],
      'fixed menu item parent' => [
        'option' => MenuBlock::LABEL_FIXED,
        'title' => 'child-1 menu item',
        'test_link' => 'menu-block-test/hierarchy/parent',
      ],
      'active item' => [
        'option' => MenuBlock::LABEL_ACTIVE_ITEM,
        'title' => 'child-1-1 menu item',
      ],
      'active item as link' => [
        'option' => MenuBlock::LABEL_ACTIVE_ITEM,
        'title' => 'child-1-1 menu item',
        'label_link' => TRUE,
      ],
      'parent item' => [
        'option' => MenuBlock::LABEL_PARENT,
        'title' => 'child-1 menu item',
      ],
      'parent item as link' => [
        'option' => MenuBlock::LABEL_PARENT,
        'title' => 'child-1 menu item',
        'label_link' => TRUE,
      ],
      'parent item top level' => [
        'option' => MenuBlock::LABEL_PARENT,
        'title' => 'parent menu item',
        'test_link' => 'menu-block-test/hierarchy/parent',
      ],
      'parent item 2' => [
        'option' => MenuBlock::LABEL_PARENT,
        'title' => 'parent menu item',
        'test_link' => 'menu-block-test/hierarchy/parent/child-1',
      ],
      'parent item 3' => [
        'option' => MenuBlock::LABEL_PARENT,
        'title' => 'child-1 menu item',
        'test_link' => 'menu-block-test/hierarchy/parent/child-1/child-1-2',
      ],
      'menu root' => [
        'option' => MenuBlock::LABEL_ROOT,
        'title' => 'parent menu item',
      ],
      'menu root as link' => [
        'option' => MenuBlock::LABEL_ROOT,
        'title' => 'parent menu item',
        'label_link' => TRUE,
      ],
      'menu root 2' => [
        'option' => MenuBlock::LABEL_ROOT,
        'title' => 'parent menu item',
        'test_link' => 'menu-block-test/hierarchy/parent/child-1',
      ],
      'menu root 3' => [
        'option' => MenuBlock::LABEL_ROOT,
        'title' => 'parent menu item',
        'test_link' => 'menu-block-test/hierarchy/parent/child-1/child-1-2',
      ],
      'menu root hidden title' => [
        'option' => MenuBlock::LABEL_ROOT,
        'title' => 'parent menu item',
        'label_display' => FALSE,
      ],
    ];
    foreach ($options as $case_id => $option) {

      // The 'label_display' setting should be TRUE if not defined explicitly.
      $label_display = $option['label_display'] ?? TRUE;

      // The 'label_link' setting should default to FALSE.
      $label_link = $option['label_link'] ?? FALSE;
      $this
        ->drupalGet('admin/structure/block/manage/main');
      $this
        ->submitForm([
        'settings[label_type]' => $option['option'],
        'settings[label_display]' => $label_display,
        'settings[label_link]' => $label_link,
      ], 'Save block');
      $test_link = empty($option['test_link']) ? 'menu-block-test/hierarchy/parent/child-1/child-1-1' : $option['test_link'];
      $this
        ->drupalGet($test_link);

      // Find the h2 associated with the main menu block.
      $block_label = $this
        ->assertSession()
        ->elementExists('css', 'h2#block-main-menu');

      // Check that the title is correct.
      $this
        ->assertEquals($option['title'], $block_label
        ->getText(), "Test case '{$case_id}' should have the right title.");

      // There is no notHasClass(), so we check for the "visually-hidden" class
      // and invert it to determine if the block title is visible or not.
      $visible = !$block_label
        ->hasClass('visually-hidden');
      $this
        ->assertEquals($label_display, $visible, "Test case '{$case_id}' should have the right visibility.");
      if ($label_link) {
        $this
          ->assertStringContainsString('<a href="', $block_label
          ->getHtml(), "Test case '{$case_id}' should have a link in the block title.");
      }
      else {
        $this
          ->assertStringNotContainsString('<a href="', $block_label
          ->getHtml(), "Test case '{$case_id}' should not have a link in the block title.");
      }
    }
  }

}

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.
MenuBlockTest::$adminUser protected property An administrative user to configure the test environment.
MenuBlockTest::$blockStorage protected property The block storage.
MenuBlockTest::$blockViewBuilder protected property The block view builder.
MenuBlockTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MenuBlockTest::$links protected property An array containing the menu link plugin ids.
MenuBlockTest::$menuLinkContentStorage protected property The menu link content storage.
MenuBlockTest::$menuLinkManager protected property The menu link plugin manager.
MenuBlockTest::$moduleHandler protected property The module handler service.
MenuBlockTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
MenuBlockTest::createLinkHierarchy protected function Creates a simple hierarchy of links.
MenuBlockTest::setUp public function Overrides BrowserTestBase::setUp
MenuBlockTest::testMenuBlockDepth public function Tests the menu_block depth option.
MenuBlockTest::testMenuBlockExpand public function Tests the menu_block expand option.
MenuBlockTest::testMenuBlockFollow public function Tests the menu_block follow and follow_parent option.
MenuBlockTest::testMenuBlockFormDisplay public function Checks if all menu block configuration options are available.
MenuBlockTest::testMenuBlockLevel public function Tests the menu_block level option.
MenuBlockTest::testMenuBlockParent public function Tests the menu_block parent option.
MenuBlockTest::testMenuBlockSuggestion public function Tests the menu_block suggestion option.
MenuBlockTest::testMenuBlockTitleOptions public function Test menu block label type options.
MenuBlockTest::testMenuBlockUi public function Checks if all menu block settings are saved correctly.
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
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.