You are here

Home » API reference » Drupal 9 » MenuTreeStorageTest.php

class MenuTreeStorageTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/tests/Drupal/KernelTests/Core/Menu/MenuTreeStorageTest.php \Drupal\KernelTests\Core\Menu\MenuTreeStorageTest

Tests the menu tree storage.

@group Menu

Hierarchy

Expanded class hierarchy of MenuTreeStorageTest

See also

\Drupal\Core\Menu\MenuTreeStorage

File

core/tests/Drupal/KernelTests/Core/Menu/MenuTreeStorageTest.php, line 17

Namespace

Drupal\KernelTests\Core\Menu
View source 
class MenuTreeStorageTest extends KernelTestBase {

  /**
   * The tested tree storage.
   *
   * @var \Drupal\Core\Menu\MenuTreeStorage
   */
  protected $treeStorage;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->treeStorage = new MenuTreeStorage($this->container
      ->get('database'), $this->container
      ->get('cache.menu'), $this->container
      ->get('cache_tags.invalidator'), 'menu_tree');
    $this->connection = $this->container
      ->get('database');
  }

  /**
   * Tests the tree storage when no tree was built yet.
   */
  public function testBasicMethods() {
    $this
      ->doTestEmptyStorage();
    $this
      ->doTestTable();
  }

  /**
   * Ensures that there are no menu links by default.
   */
  protected function doTestEmptyStorage() {
    $this
      ->assertEquals(0, $this->treeStorage
      ->countMenuLinks());
  }

  /**
   * Ensures that table gets created on the fly.
   */
  protected function doTestTable() {

    // Test that we can create a tree storage with an arbitrary table name and
    // that selecting from the storage creates the table.
    $tree_storage = new MenuTreeStorage($this->container
      ->get('database'), $this->container
      ->get('cache.menu'), $this->container
      ->get('cache_tags.invalidator'), 'test_menu_tree');
    $this
      ->assertFalse($this->connection
      ->schema()
      ->tableExists('test_menu_tree'), 'Test table is not yet created');
    $tree_storage
      ->countMenuLinks();
    $this
      ->assertTrue($this->connection
      ->schema()
      ->tableExists('test_menu_tree'), 'Test table was created');
  }

  /**
   * Tests with a simple linear hierarchy.
   */
  public function testSimpleHierarchy() {

    // Add some links with parent on the previous one and test some values.
    // <tools>
    // - test1
    // -- test2
    // --- test3
    $this
      ->addMenuLink('test1', '');
    $this
      ->assertMenuLink('test1', [
      'has_children' => 0,
      'depth' => 1,
    ]);
    $this
      ->addMenuLink('test2', 'test1');
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test2',
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 0,
      'depth' => 2,
    ], [
      'test1',
    ]);
    $this
      ->addMenuLink('test3', 'test2');
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test2',
      'test3',
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test1',
    ], [
      'test3',
    ]);
    $this
      ->assertMenuLink('test3', [
      'has_children' => 0,
      'depth' => 3,
    ], [
      'test2',
      'test1',
    ]);
  }

  /**
   * Tests the tree with moving links inside the hierarchy.
   */
  public function testMenuLinkMoving() {

    // Before the move.
    // <tools>
    // - test1
    // -- test2
    // --- test3
    // - test4
    // -- test5
    // --- test6
    $this
      ->addMenuLink('test1', '');
    $this
      ->addMenuLink('test2', 'test1');
    $this
      ->addMenuLink('test3', 'test2');
    $this
      ->addMenuLink('test4', '');
    $this
      ->addMenuLink('test5', 'test4');
    $this
      ->addMenuLink('test6', 'test5');
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test2',
      'test3',
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test1',
    ], [
      'test3',
    ]);
    $this
      ->assertMenuLink('test4', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test5',
      'test6',
    ]);
    $this
      ->assertMenuLink('test5', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test4',
    ], [
      'test6',
    ]);
    $this
      ->assertMenuLink('test6', [
      'has_children' => 0,
      'depth' => 3,
    ], [
      'test5',
      'test4',
    ]);
    $this
      ->moveMenuLink('test2', 'test5');

    // After the 1st move.
    // <tools>
    // - test1
    // - test4
    // -- test5
    // --- test2
    // ---- test3
    // --- test6
    $this
      ->assertMenuLink('test1', [
      'has_children' => 0,
      'depth' => 1,
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 1,
      'depth' => 3,
    ], [
      'test5',
      'test4',
    ], [
      'test3',
    ]);
    $this
      ->assertMenuLink('test3', [
      'has_children' => 0,
      'depth' => 4,
    ], [
      'test2',
      'test5',
      'test4',
    ]);
    $this
      ->assertMenuLink('test4', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test5',
      'test2',
      'test3',
      'test6',
    ]);
    $this
      ->assertMenuLink('test5', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test4',
    ], [
      'test2',
      'test3',
      'test6',
    ]);
    $this
      ->assertMenuLink('test6', [
      'has_children' => 0,
      'depth' => 3,
    ], [
      'test5',
      'test4',
    ]);
    $this
      ->moveMenuLink('test4', 'test1');
    $this
      ->moveMenuLink('test3', 'test1');

    // After the next 2 moves.
    // <tools>
    // - test1
    // -- test3
    // -- test4
    // --- test5
    // ---- test2
    // ---- test6
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test4',
      'test5',
      'test2',
      'test3',
      'test6',
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 0,
      'depth' => 4,
    ], [
      'test5',
      'test4',
      'test1',
    ]);
    $this
      ->assertMenuLink('test3', [
      'has_children' => 0,
      'depth' => 2,
    ], [
      'test1',
    ]);
    $this
      ->assertMenuLink('test4', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test1',
    ], [
      'test2',
      'test5',
      'test6',
    ]);
    $this
      ->assertMenuLink('test5', [
      'has_children' => 1,
      'depth' => 3,
    ], [
      'test4',
      'test1',
    ], [
      'test2',
      'test6',
    ]);
    $this
      ->assertMenuLink('test6', [
      'has_children' => 0,
      'depth' => 4,
    ], [
      'test5',
      'test4',
      'test1',
    ]);

    // Deleting a link in the middle should re-attach child links to the parent.
    $this->treeStorage
      ->delete('test4');

    // After the delete.
    // <tools>
    // - test1
    // -- test3
    // -- test5
    // --- test2
    // --- test6
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], [
      'test5',
      'test2',
      'test3',
      'test6',
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 0,
      'depth' => 3,
    ], [
      'test5',
      'test1',
    ]);
    $this
      ->assertMenuLink('test3', [
      'has_children' => 0,
      'depth' => 2,
    ], [
      'test1',
    ]);
    $this
      ->assertFalse($this->treeStorage
      ->load('test4'));
    $this
      ->assertMenuLink('test5', [
      'has_children' => 1,
      'depth' => 2,
    ], [
      'test1',
    ], [
      'test2',
      'test6',
    ]);
    $this
      ->assertMenuLink('test6', [
      'has_children' => 0,
      'depth' => 3,
    ], [
      'test5',
      'test1',
    ]);
  }

  /**
   * Tests with disabled child links.
   */
  public function testMenuDisabledChildLinks() {

    // Add some links with parent on the previous one and test some values.
    // <tools>
    // - test1
    // -- test2 (disabled)
    $this
      ->addMenuLink('test1', '');
    $this
      ->assertMenuLink('test1', [
      'has_children' => 0,
      'depth' => 1,
    ]);
    $this
      ->addMenuLink('test2', 'test1', '<front>', [], 'tools', [
      'enabled' => 0,
    ]);

    // The 1st link does not have any visible children, so has_children is 0.
    $this
      ->assertMenuLink('test1', [
      'has_children' => 0,
      'depth' => 1,
    ]);
    $this
      ->assertMenuLink('test2', [
      'has_children' => 0,
      'depth' => 2,
      'enabled' => 0,
    ], [
      'test1',
    ]);

    // Add more links with parent on the previous one.
    // <footer>
    // - footerA
    // ===============
    // <tools>
    // - test1
    // -- test2 (disabled)
    // --- test3
    // ---- test4
    // ----- test5
    // ------ test6
    // ------- test7
    // -------- test8
    // --------- test9
    $this
      ->addMenuLink('footerA', '', '<front>', [], 'footer');
    $visible_children = [];
    for ($i = 3; $i <= $this->treeStorage
      ->maxDepth(); $i++) {
      $parent = $i - 1;
      $this
        ->addMenuLink("test{$i}", "test{$parent}");
      $visible_children[] = "test{$i}";
    }

    // The 1st link does not have any visible children, so has_children is still
    // 0. However, it has visible links below it that will be found.
    $this
      ->assertMenuLink('test1', [
      'has_children' => 0,
      'depth' => 1,
    ], [], $visible_children);

    // This should fail since test9 would end up at greater than max depth.
    try {
      $this
        ->moveMenuLink('test1', 'footerA');
      $this
        ->fail('Exception was not thrown');
    } catch (PluginException $e) {

      // Expected exception; just continue testing.
    }

    // The opposite move should work, and change the has_children flag.
    $this
      ->moveMenuLink('footerA', 'test1');
    $visible_children[] = 'footerA';
    $this
      ->assertMenuLink('test1', [
      'has_children' => 1,
      'depth' => 1,
    ], [], $visible_children);
  }

  /**
   * Tests the loadTreeData method.
   */
  public function testLoadTree() {
    $this
      ->addMenuLink('test1', '', 'test1');
    $this
      ->addMenuLink('test2', 'test1', 'test2');
    $this
      ->addMenuLink('test3', 'test2', 'test3');
    $this
      ->addMenuLink('test4', '', 'test4');
    $this
      ->addMenuLink('test5', 'test4', NULL);
    $data = $this->treeStorage
      ->loadTreeData('tools', new MenuTreeParameters());
    $tree = $data['tree'];
    $this
      ->assertCount(1, $tree['test1']['subtree']);
    $this
      ->assertCount(1, $tree['test1']['subtree']['test2']['subtree']);
    $this
      ->assertCount(0, $tree['test1']['subtree']['test2']['subtree']['test3']['subtree']);
    $this
      ->assertCount(1, $tree['test4']['subtree']);
    $this
      ->assertCount(0, $tree['test4']['subtree']['test5']['subtree']);

    // Ensure that route names element exists.
    $this
      ->assertNotEmpty($data['route_names']);

    // Ensure that the actual route names are set.
    $this
      ->assertContains('test1', $data['route_names']);
    $this
      ->assertNotContains('test5', $data['route_names']);
    $parameters = new MenuTreeParameters();
    $parameters
      ->setActiveTrail([
      'test4',
      'test5',
    ]);
    $data = $this->treeStorage
      ->loadTreeData('tools', $parameters);
    $tree = $data['tree'];
    $this
      ->assertCount(1, $tree['test1']['subtree']);
    $this
      ->assertFalse($tree['test1']['in_active_trail']);
    $this
      ->assertCount(1, $tree['test1']['subtree']['test2']['subtree']);
    $this
      ->assertFalse($tree['test1']['subtree']['test2']['in_active_trail']);
    $this
      ->assertCount(0, $tree['test1']['subtree']['test2']['subtree']['test3']['subtree']);
    $this
      ->assertFalse($tree['test1']['subtree']['test2']['subtree']['test3']['in_active_trail']);
    $this
      ->assertCount(1, $tree['test4']['subtree']);
    $this
      ->assertTrue($tree['test4']['in_active_trail']);
    $this
      ->assertCount(0, $tree['test4']['subtree']['test5']['subtree']);
    $this
      ->assertTrue($tree['test4']['subtree']['test5']['in_active_trail']);

    // Add some conditions to ensure that conditions work as expected.
    $parameters = new MenuTreeParameters();
    $parameters
      ->addCondition('parent', 'test1');
    $data = $this->treeStorage
      ->loadTreeData('tools', $parameters);
    $this
      ->assertCount(1, $data['tree']);
    $this
      ->assertEquals('test2', $data['tree']['test2']['definition']['id']);
    $this
      ->assertEquals([], $data['tree']['test2']['subtree']);

    // Test for only enabled links.
    $link = $this->treeStorage
      ->load('test3');
    $link['enabled'] = FALSE;
    $this->treeStorage
      ->save($link);
    $link = $this->treeStorage
      ->load('test4');
    $link['enabled'] = FALSE;
    $this->treeStorage
      ->save($link);
    $link = $this->treeStorage
      ->load('test5');
    $link['enabled'] = FALSE;
    $this->treeStorage
      ->save($link);
    $parameters = new MenuTreeParameters();
    $parameters
      ->onlyEnabledLinks();
    $data = $this->treeStorage
      ->loadTreeData('tools', $parameters);
    $this
      ->assertCount(1, $data['tree']);
    $this
      ->assertEquals('test1', $data['tree']['test1']['definition']['id']);
    $this
      ->assertCount(1, $data['tree']['test1']['subtree']);
    $this
      ->assertEquals('test2', $data['tree']['test1']['subtree']['test2']['definition']['id']);
    $this
      ->assertEquals([], $data['tree']['test1']['subtree']['test2']['subtree']);
  }

  /**
   * Tests finding the subtree height with content menu links.
   */
  public function testSubtreeHeight() {

    // root
    // - child1
    // -- child2
    // --- child3
    // ---- child4
    $this
      ->addMenuLink('root');
    $this
      ->addMenuLink('child1', 'root');
    $this
      ->addMenuLink('child2', 'child1');
    $this
      ->addMenuLink('child3', 'child2');
    $this
      ->addMenuLink('child4', 'child3');
    $this
      ->assertEquals(5, $this->treeStorage
      ->getSubtreeHeight('root'));
    $this
      ->assertEquals(4, $this->treeStorage
      ->getSubtreeHeight('child1'));
    $this
      ->assertEquals(3, $this->treeStorage
      ->getSubtreeHeight('child2'));
    $this
      ->assertEquals(2, $this->treeStorage
      ->getSubtreeHeight('child3'));
    $this
      ->assertEquals(1, $this->treeStorage
      ->getSubtreeHeight('child4'));
  }

  /**
   * Ensure hierarchy persists after a menu rebuild.
   */
  public function testMenuRebuild() {

    // root
    // - child1
    // -- child2
    // --- child3
    // ---- child4
    $this
      ->addMenuLink('root');
    $this
      ->addMenuLink('child1', 'root');
    $this
      ->addMenuLink('child2', 'child1');
    $this
      ->addMenuLink('child3', 'child2');
    $this
      ->addMenuLink('child4', 'child3');
    $this
      ->assertEquals(5, $this->treeStorage
      ->getSubtreeHeight('root'));
    $this
      ->assertEquals(4, $this->treeStorage
      ->getSubtreeHeight('child1'));
    $this
      ->assertEquals(3, $this->treeStorage
      ->getSubtreeHeight('child2'));
    $this
      ->assertEquals(2, $this->treeStorage
      ->getSubtreeHeight('child3'));
    $this
      ->assertEquals(1, $this->treeStorage
      ->getSubtreeHeight('child4'));

    // Intentionally leave child3 out to mimic static or external links.
    $definitions = $this->treeStorage
      ->loadMultiple([
      'root',
      'child1',
      'child2',
      'child4',
    ]);
    $this->treeStorage
      ->rebuild($definitions);
    $this
      ->assertEquals(5, $this->treeStorage
      ->getSubtreeHeight('root'));
    $this
      ->assertEquals(4, $this->treeStorage
      ->getSubtreeHeight('child1'));
    $this
      ->assertEquals(3, $this->treeStorage
      ->getSubtreeHeight('child2'));
    $this
      ->assertEquals(2, $this->treeStorage
      ->getSubtreeHeight('child3'));
    $this
      ->assertEquals(1, $this->treeStorage
      ->getSubtreeHeight('child4'));
  }

  /**
   * Tests MenuTreeStorage::loadByProperties().
   */
  public function testLoadByProperties() {
    $tests = [
      [
        'foo' => 'bar',
      ],
      [
        0 => 'wrong',
      ],
    ];
    $message = 'An invalid property name throws an exception.';
    foreach ($tests as $properties) {
      try {
        $this->treeStorage
          ->loadByProperties($properties);
        $this
          ->fail($message);
      } catch (\InvalidArgumentException $e) {
        $this
          ->assertMatchesRegularExpression('/^An invalid property name, .+ was specified. Allowed property names are:/', $e
          ->getMessage(), 'Found expected exception message.');
      }
    }
    $this
      ->addMenuLink('test_link.1', '', 'test', [], 'menu1');
    $properties = [
      'menu_name' => 'menu1',
    ];
    $links = $this->treeStorage
      ->loadByProperties($properties);
    $this
      ->assertEquals('menu1', $links['test_link.1']['menu_name']);
    $this
      ->assertEquals('test', $links['test_link.1']['route_name']);
  }

  /**
   * Adds a link with the given ID and supply defaults.
   */
  protected function addMenuLink($id, $parent = '', $route_name = 'test', $route_parameters = [], $menu_name = 'tools', $extra = []) {
    $link = [
      'id' => $id,
      'menu_name' => $menu_name,
      'route_name' => $route_name,
      'route_parameters' => $route_parameters,
      'title' => 'test',
      'parent' => $parent,
      'options' => [],
      'metadata' => [],
    ] + $extra;
    $this->treeStorage
      ->save($link);
  }

  /**
   * Moves the link with the given ID so it's under a new parent.
   *
   * @param string $id
   *   The ID of the menu link to move.
   * @param string $new_parent
   *   The ID of the new parent link.
   */
  protected function moveMenuLink($id, $new_parent) {
    $menu_link = $this->treeStorage
      ->load($id);
    $menu_link['parent'] = $new_parent;
    $this->treeStorage
      ->save($menu_link);
  }

  /**
   * Tests that a link's stored representation matches the expected values.
   *
   * @param string $id
   *   The ID of the menu link to test
   * @param array $expected_properties
   *   A keyed array of column names and values like has_children and depth.
   * @param array $parents
   *   An ordered array of the IDs of the menu links that are the parents.
   * @param array $children
   *   Array of child IDs that are visible (enabled == 1).
   */
  protected function assertMenuLink($id, array $expected_properties, array $parents = [], array $children = []) {
    $query = $this->connection
      ->select('menu_tree');
    $query
      ->fields('menu_tree');
    $query
      ->condition('id', $id);
    foreach ($expected_properties as $field => $value) {
      $query
        ->condition($field, $value);
    }
    $all = $query
      ->execute()
      ->fetchAll(\PDO::FETCH_ASSOC);
    $this
      ->assertCount(1, $all, "Found link {$id} matching all the expected properties");
    $raw = reset($all);

    // Put the current link onto the front.
    array_unshift($parents, $raw['id']);
    $query = $this->connection
      ->select('menu_tree');
    $query
      ->fields('menu_tree', [
      'id',
      'mlid',
    ]);
    $query
      ->condition('id', $parents, 'IN');
    $found_parents = $query
      ->execute()
      ->fetchAllKeyed(0, 1);
    $this
      ->assertSameSize($parents, $found_parents, 'Found expected number of parents');
    $this
      ->assertCount($raw['depth'], $found_parents, 'Number of parents is the same as the depth');
    $materialized_path = $this->treeStorage
      ->getRootPathIds($id);
    $this
      ->assertEquals(array_values($parents), array_values($materialized_path), 'Parents match the materialized path');

    // Check that the selected mlid values of the parents are in the correct
    // column, including the link's own.
    for ($i = $raw['depth']; $i >= 1; $i--) {
      $parent_id = array_shift($parents);
      $this
        ->assertEquals($found_parents[$parent_id], $raw["p{$i}"], "mlid of parent matches at column p{$i}");
    }
    for ($i = $raw['depth'] + 1; $i <= $this->treeStorage
      ->maxDepth(); $i++) {
      $this
        ->assertEquals(0, $raw["p{$i}"], "parent is 0 at column p{$i} greater than depth");
    }
    if ($parents) {
      $this
        ->assertEquals(end($parents), $raw['parent'], 'Ensure that the parent field is set properly');
    }

    // Verify that the child IDs match.
    $this
      ->assertEqualsCanonicalizing($children, array_keys($this->treeStorage
      ->loadAllChildren($id)));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$modules protected static property Modules to enable. 457
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
MenuTreeStorageTest::$connection protected property The database connection.
MenuTreeStorageTest::$treeStorage protected property The tested tree storage.
MenuTreeStorageTest::addMenuLink protected function Adds a link with the given ID and supply defaults.
MenuTreeStorageTest::assertMenuLink protected function Tests that a link's stored representation matches the expected values.
MenuTreeStorageTest::doTestEmptyStorage protected function Ensures that there are no menu links by default.
MenuTreeStorageTest::doTestTable protected function Ensures that table gets created on the fly.
MenuTreeStorageTest::moveMenuLink protected function Moves the link with the given ID so it's under a new parent.
MenuTreeStorageTest::setUp protected function Overrides KernelTestBase::setUp
MenuTreeStorageTest::testBasicMethods public function Tests the tree storage when no tree was built yet.
MenuTreeStorageTest::testLoadByProperties public function Tests MenuTreeStorage::loadByProperties().
MenuTreeStorageTest::testLoadTree public function Tests the loadTreeData method.
MenuTreeStorageTest::testMenuDisabledChildLinks public function Tests with disabled child links.
MenuTreeStorageTest::testMenuLinkMoving public function Tests the tree with moving links inside the hierarchy.
MenuTreeStorageTest::testMenuRebuild public function Ensure hierarchy persists after a menu rebuild.
MenuTreeStorageTest::testSimpleHierarchy public function Tests with a simple linear hierarchy.
MenuTreeStorageTest::testSubtreeHeight public function Tests finding the subtree height with content menu links.
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.
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.