You are here

class TokenMenuTest in Token 8

Tests menu tokens.

@group token

Hierarchy

Expanded class hierarchy of TokenMenuTest

File

tests/src/Functional/TokenMenuTest.php, line 18

Namespace

Drupal\Tests\token\Functional
View source
class TokenMenuTest extends TokenTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'menu_ui',
    'node',
    'block',
    'language',
    'block_content',
    'content_translation',
  ];
  function testMenuTokens() {

    // Make sure we have a body field on the node type.
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);

    // Add a menu.
    $menu = Menu::create([
      'id' => 'main-menu',
      'label' => 'Main menu',
      'description' => 'The <em>Main</em> menu is used on many sites to show the major sections of the site, often in a top navigation bar.',
    ]);
    $menu
      ->save();

    // Place the menu block.
    $this
      ->drupalPlaceBlock('system_menu_block:main-menu');

    // Add a root link.

    /** @var \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent $root_link */
    $root_link = MenuLinkContent::create([
      'link' => [
        'uri' => 'internal:/admin',
      ],
      'title' => 'Administration',
      'menu_name' => 'main-menu',
    ]);
    $root_link
      ->save();

    // Add another link with the root link as the parent.

    /** @var \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent $parent_link */
    $parent_link = MenuLinkContent::create([
      'link' => [
        'uri' => 'internal:/admin/config',
      ],
      'title' => 'Configuration',
      'menu_name' => 'main-menu',
      'parent' => $root_link
        ->getPluginId(),
    ]);
    $parent_link
      ->save();

    // Test menu link tokens.
    $tokens = [
      'id' => $parent_link
        ->getPluginId(),
      'title' => 'Configuration',
      'menu' => 'Main menu',
      'menu:name' => 'Main menu',
      'menu:machine-name' => $menu
        ->id(),
      'menu:description' => 'The <em>Main</em> menu is used on many sites to show the major sections of the site, often in a top navigation bar.',
      'menu:menu-link-count' => '2',
      'menu:edit-url' => Url::fromRoute('entity.menu.edit_form', [
        'menu' => 'main-menu',
      ], [
        'absolute' => TRUE,
      ])
        ->toString(),
      'url' => Url::fromRoute('system.admin_config', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      'url:absolute' => Url::fromRoute('system.admin_config', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
      'url:relative' => Url::fromRoute('system.admin_config', [], [
        'absolute' => FALSE,
      ])
        ->toString(),
      'url:path' => '/admin/config',
      'url:alias' => '/admin/config',
      'edit-url' => Url::fromRoute('entity.menu_link_content.canonical', [
        'menu_link_content' => $parent_link
          ->id(),
      ], [
        'absolute' => TRUE,
      ])
        ->toString(),
      'parent' => 'Administration',
      'parent:id' => $root_link
        ->getPluginId(),
      'parent:title' => 'Administration',
      'parent:menu' => 'Main menu',
      'parent:parent' => NULL,
      'parents' => 'Administration',
      'parents:count' => 1,
      'parents:keys' => $root_link
        ->getPluginId(),
      'root' => 'Administration',
      'root:id' => $root_link
        ->getPluginId(),
      'root:parent' => NULL,
      'root:root' => NULL,
    ];
    $this
      ->assertTokens('menu-link', [
      'menu-link' => $parent_link,
    ], $tokens);

    // Add a node.
    $node = $this
      ->drupalCreateNode();

    // Allow main menu for this node type.

    //$this->config('menu.entity.node.' . $node->getType())->set('available_menus', ['main-menu'])->save();

    // Add a node menu link.

    /** @var \Drupal\menu_link_content\MenuLinkContentInterface $node_link */
    $node_link = MenuLinkContent::create([
      'link' => [
        'uri' => 'entity:node/' . $node
          ->id(),
      ],
      'title' => 'Node link',
      'parent' => $parent_link
        ->getPluginId(),
      'menu_name' => 'main-menu',
    ]);
    $node_link
      ->save();

    // Test [node:menu] tokens.
    $tokens = [
      'menu-link' => 'Node link',
      'menu-link:id' => $node_link
        ->getPluginId(),
      'menu-link:title' => 'Node link',
      'menu-link:menu' => 'Main menu',
      'menu-link:url' => $node
        ->toUrl('canonical', [
        'absolute' => TRUE,
      ])
        ->toString(),
      'menu-link:url:path' => '/node/' . $node
        ->id(),
      'menu-link:edit-url' => $node_link
        ->toUrl('edit-form', [
        'absolute' => TRUE,
      ])
        ->toString(),
      'menu-link:parent' => 'Configuration',
      'menu-link:parent:id' => $parent_link
        ->getPluginId(),
      'menu-link:parents' => 'Administration, Configuration',
      'menu-link:parents:count' => 2,
      'menu-link:parents:keys' => $root_link
        ->getPluginId() . ', ' . $parent_link
        ->getPluginId(),
      'menu-link:root' => 'Administration',
      'menu-link:root:id' => $root_link
        ->getPluginId(),
    ];
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], $tokens);

    // Reload the node which will not have $node->menu defined and re-test.
    $loaded_node = Node::load($node
      ->id());
    $this
      ->assertTokens('node', [
      'node' => $loaded_node,
    ], $tokens);

    // Regression test for http://drupal.org/node/1317926 to ensure the
    // original node object is not changed when calling menu_node_prepare().
    $this
      ->assertTrue(!isset($loaded_node->menu), 'The $node->menu property was not modified during token replacement.', 'Regression');

    // Now add a node with a menu-link from the UI and ensure it works.
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'create page content',
      'edit any page content',
      'administer menu',
      'administer nodes',
      'administer content types',
      'access administration pages',
    ]));

    // Setup node type menu options.
    $edit = [
      'menu_options[main-menu]' => 1,
      'menu_options[main]' => 1,
      'menu_parent' => 'main-menu:',
    ];
    $this
      ->drupalPostForm('admin/structure/types/manage/page', $edit, 'Save content type');

    // Use a menu-link token in the body.
    $this
      ->drupalGet('node/add/page');
    $this
      ->drupalPostForm(NULL, [
      // This should get replaced on save.
      // @see token_module_test_node_presave()
      'title[0][value]' => 'Node menu title test',
      'body[0][value]' => 'This is a [node:menu-link:title] token to the menu link title',
      'menu[enabled]' => 1,
      'menu[title]' => 'Test preview',
    ], 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Node menu title test');
    $this
      ->assertEquals('This is a Test preview token to the menu link title', $node->body->value);

    // Disable the menu link, save the node and verify that the menu link is
    // no longer displayed.
    $link = menu_ui_get_menu_link_defaults($node);
    $this
      ->drupalPostForm('admin/structure/menu/manage/main-menu', [
      'links[menu_plugin_id:' . $link['id'] . '][enabled]' => FALSE,
    ], 'Save');
    $this
      ->assertText('Menu Main menu has been updated.');
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', [], 'Save');
    $this
      ->assertSession()
      ->linkNotExists('Test preview');

    // Now test a parent link and token.
    $this
      ->drupalGet('node/add/page');

    // Make sure that the previous node save didn't result in two menu-links
    // being created by the computed menu-link ER field.
    // @see token_entity_base_field_info()
    // @see token_node_menu_link_submit()
    $selects = $this
      ->cssSelect('select[name="menu[menu_parent]"]');
    $select = reset($selects);
    $options = $select
      ->findAll('css', 'option');

    // Filter to items with title containing 'Test preview'.
    $options = array_filter($options, function (NodeElement $element) {
      return strpos($element
        ->getText(), 'Test preview') !== FALSE;
    });
    $this
      ->assertCount(1, $options);
    $this
      ->drupalPostForm(NULL, [
      'title[0][value]' => 'Node menu title parent path test',
      'body[0][value]' => 'This is a [node:menu-link:parent:url:path] token to the menu link parent',
      'menu[enabled]' => 1,
      'menu[title]' => 'Child link',
      'menu[menu_parent]' => 'main-menu:' . $parent_link
        ->getPluginId(),
    ], 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Node menu title parent path test');
    $this
      ->assertEquals('This is a /admin/config token to the menu link parent', $node->body->value);

    // Now edit the node and update the parent and title.
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', [
      'menu[menu_parent]' => 'main-menu:' . $node_link
        ->getPluginId(),
      'title[0][value]' => 'Node menu title edit parent path test',
      'body[0][value]' => 'This is a [node:menu-link:parent:url:path] token to the menu link parent',
    ], 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Node menu title edit parent path test', TRUE);
    $this
      ->assertEquals(sprintf('This is a /node/%d token to the menu link parent', $loaded_node
      ->id()), $node->body->value);

    // Make sure that the previous node edit didn't result in two menu-links
    // being created by the computed menu-link ER field.
    // @see token_entity_base_field_info()
    // @see token_node_menu_link_submit()
    $this
      ->drupalGet('node/add/page');
    $selects = $this
      ->cssSelect('select[name="menu[menu_parent]"]');
    $select = reset($selects);
    $options = $select
      ->findAll('css', 'option');

    // Filter to items with title containing 'Test preview'.
    $options = array_filter($options, function (NodeElement $item) {
      return strpos($item
        ->getText(), 'Child link') !== FALSE;
    });
    $this
      ->assertCount(1, $options);

    // Now add a new node with no menu.
    $this
      ->drupalGet('node/add/page');
    $this
      ->drupalPostForm(NULL, [
      'title[0][value]' => 'Node menu adding menu later test',
      'body[0][value]' => 'Going to add a menu link on edit',
      'menu[enabled]' => 0,
    ], 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Node menu adding menu later test');

    // Now edit it and add a menu item.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->drupalPostForm(NULL, [
      'title[0][value]' => 'Node menu adding menu later test',
      'body[0][value]' => 'This is a [node:menu-link:parent:url:path] token to the menu link parent',
      'menu[enabled]' => 1,
      'menu[title]' => 'Child link',
      'menu[menu_parent]' => 'main-menu:' . $parent_link
        ->getPluginId(),
    ], 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Node menu adding menu later test', TRUE);
    $this
      ->assertEquals('This is a /admin/config token to the menu link parent', $node->body->value);

    // And make sure the menu link exists with the right URI.
    $link = menu_ui_get_menu_link_defaults($node);
    $this
      ->assertNotEmpty($link['entity_id']);
    $query = \Drupal::entityQuery('menu_link_content')
      ->condition('link.uri', 'entity:node/' . $node
      ->id())
      ->sort('id', 'ASC')
      ->range(0, 1);
    $result = $query
      ->execute();
    $this
      ->assertNotEmpty($result);

    // Create a node with a menu link and create 2 menu links linking to this
    // node after. Verify that the menu link provided by the node has priority.
    $node_title = $this
      ->randomMachineName();
    $edit = [
      'title[0][value]' => $node_title,
      'menu[enabled]' => 1,
      'menu[title]' => 'menu link provided by node',
    ];
    $this
      ->drupalPostForm('node/add/page', $edit, 'Save');
    $this
      ->assertText('page ' . $node_title . ' has been created');
    $node = $this
      ->drupalGetNodeByTitle($node_title);
    $menu_ui_link1 = MenuLinkContent::create([
      'link' => [
        'uri' => 'entity:node/' . $node
          ->id(),
      ],
      'title' => 'menu link 1 provided by menu ui',
      'menu_name' => 'main-menu',
    ]);
    $menu_ui_link1
      ->save();
    $menu_ui_link2 = MenuLinkContent::create([
      'link' => [
        'uri' => 'entity:node/' . $node
          ->id(),
      ],
      'title' => 'menu link 2 provided by menu ui',
      'menu_name' => 'main-menu',
    ]);
    $menu_ui_link2
      ->save();
    $tokens = [
      'menu-link' => 'menu link provided by node',
      'menu-link:title' => 'menu link provided by node',
    ];
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], $tokens);
  }

  /**
   * Tests that the module doesn't affect integrity of the menu, when
   * translating them and that menu links tokens are correct.
   */
  function testMultilingualMenu() {

    // Place the menu block.
    $this
      ->drupalPlaceBlock('system_menu_block:main');

    // Add a second language.
    $language = ConfigurableLanguage::create([
      'id' => 'de',
      'label' => 'German',
    ]);
    $language
      ->save();

    // Create the article content type.
    $node_type = NodeType::create([
      'type' => 'article',
    ]);
    $node_type
      ->save();
    $permissions = [
      'access administration pages',
      'administer content translation',
      'administer content types',
      'administer languages',
      'create content translations',
      'create article content',
      'edit any article content',
      'translate any entity',
      'administer menu',
    ];
    $this
      ->drupalLogin($this
      ->drupalCreateUser($permissions));

    // Enable translation for articles and menu links.
    $this
      ->drupalGet('admin/config/regional/content-language');
    $edit = [
      'entity_types[node]' => TRUE,
      'entity_types[menu_link_content]' => TRUE,
      'settings[node][article][translatable]' => TRUE,
      'settings[node][article][fields][title]' => TRUE,
      'settings[menu_link_content][menu_link_content][translatable]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save configuration');
    $this
      ->assertText('Settings successfully updated.');

    // Create an english node with an english menu.
    $this
      ->drupalGet('/node/add/article');
    $edit = [
      'title[0][value]' => 'English test node with menu',
      'menu[enabled]' => TRUE,
      'menu[title]' => 'English menu title',
    ];
    $this
      ->drupalPostForm('/node/add/article', $edit, 'Save');
    $this
      ->assertText('English test node with menu has been created.');

    // Add a german translation.
    $this
      ->drupalGet('node/1/translations');
    $this
      ->clickLink('Add');
    $edit = [
      'title[0][value]' => 'German test node with menu',
      'menu[enabled]' => TRUE,
      'menu[title]' => 'German menu title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save (this translation)');
    $this
      ->assertText('German test node with menu has been updated.');

    // Verify that the menu links are correct.
    $this
      ->drupalGet('node/1');
    $this
      ->assertSession()
      ->linkExists('English menu title');
    $this
      ->drupalGet('de/node/1');
    $this
      ->assertSession()
      ->linkExists('German menu title');

    // Verify that tokens are correct.
    $node = Node::load(1);
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'menu-link' => 'English menu title',
    ]);
    $this
      ->assertTokens('node', [
      'node' => $node,
    ], [
      'menu-link' => 'German menu title',
      'menu-link:title' => 'German menu title',
    ], [
      'langcode' => 'de',
    ]);

    // Get the menu link and create a child menu link to assert parent and root
    // tokens.
    $url = $node
      ->toUrl();

    /** @var \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager */
    $menu_link_manager = \Drupal::service('plugin.manager.menu.link');
    $links = $menu_link_manager
      ->loadLinksByRoute($url
      ->getRouteName(), $url
      ->getRouteParameters());
    $link = reset($links);
    $base_options = [
      'provider' => 'menu_test',
      'menu_name' => 'menu_test',
    ];
    $child_1 = $base_options + [
      'title' => 'child_1 title EN',
      'link' => [
        'uri' => 'internal:/menu-test/hierarchy/parent/child_1',
      ],
      'parent' => $link
        ->getPluginId(),
      'langcode' => 'en',
    ];
    $child_1 = MenuLinkContent::create($child_1);
    $child_1
      ->save();

    // Add the german translation.
    $child_1
      ->addTranslation('de', [
      'title' => 'child_1 title DE',
    ] + $child_1
      ->toArray());
    $child_1
      ->save();
    $this
      ->assertTokens('menu-link', [
      'menu-link' => $child_1,
    ], [
      'title' => 'child_1 title EN',
      'parents' => 'English menu title',
      'root' => 'English menu title',
    ]);
    $this
      ->assertTokens('menu-link', [
      'menu-link' => $child_1,
    ], [
      'title' => 'child_1 title DE',
      'parents' => 'German menu title',
      'root' => 'German menu title',
    ], [
      'langcode' => 'de',
    ]);
  }

  /**
   * Tests menu link parents token.
   */
  public function testMenuLinkParentsToken() {

    // Create a menu with a simple link hierarchy :
    // - parent
    //   - child-1
    //      - child-1-1
    Menu::create([
      'id' => 'menu_test',
      'label' => 'Test menu',
    ])
      ->save();
    $base_options = [
      'provider' => 'menu_test',
      'menu_name' => 'menu_test',
    ];
    $parent = $base_options + [
      'title' => 'parent title',
      'link' => [
        'uri' => 'internal:/menu-test/hierarchy/parent',
      ],
    ];
    $parent = MenuLinkContent::create($parent);
    $parent
      ->save();
    $child_1 = $base_options + [
      'title' => 'child_1 title',
      'link' => [
        'uri' => 'internal:/menu-test/hierarchy/parent/child_1',
      ],
      'parent' => $parent
        ->getPluginId(),
    ];
    $child_1 = MenuLinkContent::create($child_1);
    $child_1
      ->save();
    $child_1_1 = $base_options + [
      'title' => 'child_1_1 title',
      'link' => [
        'uri' => 'internal:/menu-test/hierarchy/parent/child_1/child_1_1',
      ],
      'parent' => $child_1
        ->getPluginId(),
    ];
    $child_1_1 = MenuLinkContent::create($child_1_1);
    $child_1_1
      ->save();
    $this
      ->assertTokens('menu-link', [
      'menu-link' => $child_1_1,
    ], [
      'parents' => 'parent title, child_1 title',
    ]);

    // Change the parent of child_1_1 to 'parent' at the entity level.
    $child_1_1->parent->value = $parent
      ->getPluginId();
    $child_1_1
      ->save();
    $this
      ->assertTokens('menu-link', [
      'menu-link' => $child_1_1,
    ], [
      'parents' => 'parent title',
    ]);

    // Change the parent of child_1_1 to 'main', at the entity level.
    $child_1_1->parent->value = '';
    $child_1_1
      ->save();

    // The token shouldn't have been generated; the menu link has no parent.
    $this
      ->assertNoTokens('menu-link', [
      'menu-link' => $child_1_1,
    ], [
      'parents',
    ]);
  }

  /**
   * Tests that no menu link is generated when the node gets previewed.
   */
  public function testPreviewMenuLink() {
    $this
      ->drupalCreateContentType([
      'type' => 'article',
    ]);
    $permissions = [
      'access administration pages',
      'administer content types',
      'create article content',
      'edit any article content',
      'administer menu',
    ];
    $this
      ->drupalLogin($this
      ->drupalCreateUser($permissions));

    // Create an english node with an english menu.
    $this
      ->drupalGet('/node/add/article');
    $edit = [
      'title[0][value]' => 'English test node with menu',
      'menu[enabled]' => TRUE,
      'menu[title]' => 'English menu title',
    ];
    $this
      ->drupalGet('node/add/article');
    $this
      ->submitForm($edit, 'Preview');
    $menu_links = \Drupal::entityTypeManager()
      ->getStorage('menu_link_content')
      ->loadByProperties([
      'menu_name' => 'main',
    ]);
    $this
      ->assertEmpty($menu_links);
  }

}

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::setUp protected function 475
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
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
TokenMenuTest::$modules public static property Modules to enable. Overrides TokenTestBase::$modules
TokenMenuTest::testMenuLinkParentsToken public function Tests menu link parents token.
TokenMenuTest::testMenuTokens function
TokenMenuTest::testMultilingualMenu function Tests that the module doesn't affect integrity of the menu, when translating them and that menu links tokens are correct.
TokenMenuTest::testPreviewMenuLink public function Tests that no menu link is generated when the node gets previewed.
TokenTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
TokenTestTrait::assertNoTokens function
TokenTestTrait::assertPageTokens function Make a page request and test for token generation.
TokenTestTrait::assertToken function
TokenTestTrait::assertTokens function
TokenTestTrait::mapTokenNames function
TokenTestTrait::saveAlias function
TokenTestTrait::saveEntityAlias function
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.