You are here

Home » API reference » Menu Admin per Menu 8 » MenuAdminPerMenuAccessTest.php

class MenuAdminPerMenuAccessTest in Menu Admin per Menu 8

Class MenuAdminPerMenuAccessTest.

@group menu_admin_per_menu

@coversDefaultClass \Drupal\menu_admin_per_menu\Access\MenuAdminPerMenuAccess

Hierarchy

Expanded class hierarchy of MenuAdminPerMenuAccessTest

File

tests/src/Kernel/MenuAdminPerMenuAccessTest.php, line 18

Namespace

Drupal\Tests\menu_admin_per_menu\Kernel
View source 
class MenuAdminPerMenuAccessTest extends KernelTestBase {
  use UserCreationTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'menu_admin_per_menu',
    'menu_admin_per_menu_test',
    'link',
    'menu_link_content',
    'menu_ui',
    'system',
    'user',
  ];

  /**
   * A menu entity.
   *
   * @var \Drupal\System\MenuInterface
   */
  protected $menu1;

  /**
   * A menu entity.
   *
   * @var \Drupal\System\MenuInterface
   */
  protected $menu2;

  /**
   * A menu entity.
   *
   * @var \Drupal\System\MenuInterface
   */
  protected $menu3;

  /**
   * A user entity.
   *
   * An anonymous user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $anonymousUser;

  /**
   * A user entity.
   *
   * An authenticated user without any of the administer menu permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $authenticatedUser;

  /**
   * A user entity.
   *
   * An admin user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * A user entity.
   *
   * This user has the 'administer menu' permission.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminMenuUser;

  /**
   * A user entity.
   *
   * This user has the 'administer menu_1 permissions'.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $menu1User;

  /**
   * A user entity.
   *
   * This user has the 'administer menu_2 permissions'.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $menu2User;

  /**
   * A user entity.
   *
   * This user has permission to alter menu items on menu_3 because of
   * hook_menu_admin_per_menu_get_permissions_alter that is provided in the
   * test module.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $menu3User;

  /**
   * The allowed menus provider.
   *
   * @var \Drupal\menu_admin_per_menu\Access\MenuAdminPerMenuAccess
   */
  protected $menuAdminPerMenuAllowedMenus;

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

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

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('menu');
    $this
      ->installEntitySchema('menu_link_content');
    $this
      ->installSchema('system', 'sequences');
    $this
      ->installConfig('system');
    $this
      ->installEntitySchema('user');
    $this
      ->installConfig('user');
    $this
      ->installConfig('menu_admin_per_menu_test');
    $this->menuAdminPerMenuAllowedMenus = $this->container
      ->get('menu_admin_per_menu.allowed_menus');
    $this->menuLinkContentStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('menu_link_content');
    $this->menuLinkManager = $this->container
      ->get('plugin.manager.menu.link');
    $this->menuStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('menu');
    $this->menu1 = $this->menuStorage
      ->load('menu_1');
    $this->menu2 = $this->menuStorage
      ->load('menu_2');
    $this->menu3 = $this->menuStorage
      ->load('menu_3');
    $this->anonymousUser = new AnonymousUserSession();

    // The admin user is created as first user, so this user has ID 1.
    $this->adminUser = $this
      ->createUser([], 'Admin', TRUE);
    $this->authenticatedUser = $this
      ->createUser([], 'Authenticated user');
    $this->adminMenuUser = $this
      ->createUser([
      'administer menu',
    ], 'Admin menu user');
    $this->menu1User = $this
      ->createUser([
      'administer menu_1 menu items',
    ], 'Menu 1 user');
    $this->menu2User = $this
      ->createUser([
      'administer menu_2 menu items',
    ], 'Menu 2 user');

    // Access to menu_3 is added in menu_admin_per_menu_hook_test.
    $this->menu3User = $this
      ->createUser([], 'Menu 3 user');

    // Make sure that links provided in menu_admin_per_menu_test.links.menu.yml
    // are picked up.
    $this->container
      ->get('router.builder')
      ->rebuild();
  }

  /**
   * Test getPerMenuPermissions method.
   *
   * @covers ::getPerMenuPermissions
   */
  public function testGetMenuPermissions() {

    // Anonymous users should not have access to the menus.
    $this
      ->assertEmpty(array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->anonymousUser)));

    // The authenticated user should not have access to the menus since this
    // user has none of the appropriate permissions.
    $this
      ->assertEmpty(array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->authenticatedUser)));

    // Admin user has access to all menus.
    $this
      ->assertEquals([
      'administer admin menu items',
      'administer footer menu items',
      'administer main menu items',
      'administer menu_1 menu items',
      'administer menu_2 menu items',
      'administer menu_3 menu items',
      'administer tools menu items',
      'administer account menu items',
    ], array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->adminUser)));

    // User with 'administer menu' permission has no menu permission. In the
    // access checks this is fixed by checking the 'administer menu'
    // permission.
    $this
      ->assertEmpty(array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->adminMenuUser)));

    // User with administer menu_1 permission should have access to menu_1.
    $this
      ->assertEquals([
      'administer menu_1 menu items',
    ], array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->menu1User)));

    // User with administer menu_2 permission should have access to menu_2.
    $this
      ->assertEquals([
      'administer menu_2 menu items',
    ], array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->menu2User)));

    // User that has access to menu_3 because of the hook implementation should
    // also be listed here.
    $this
      ->assertEquals([
      'administer menu_3 menu items',
    ], array_keys($this->menuAdminPerMenuAllowedMenus
      ->getPerMenuPermissions($this->menu3User)));
  }

  /**
   * Test result for the menu overview access callback.
   *
   * @covers ::menusOverviewAccess
   */
  public function testMenusOverviewAccess() {
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->anonymousUser));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->authenticatedUser));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->adminUser));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->adminMenuUser));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->menu1User));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->menu2User));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menusOverviewAccess($this->menu3User));
  }

  /**
   * Test menu edit page access callback.
   *
   * @covers ::menuAccess
   */
  public function testMenuAccess() {

    // Anonymous users has no access to one of the menus.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->anonymousUser, $this->menu1));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->anonymousUser, $this->menu2));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->anonymousUser, $this->menu3));

    // Anonymous users has no access to one of the menus.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->authenticatedUser, $this->menu1));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->authenticatedUser, $this->menu2));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->authenticatedUser, $this->menu3));

    // Admin user has access to all menus.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminUser, $this->menu1));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminUser, $this->menu2));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminUser, $this->menu3));

    // User with 'administer menu' permission has access to all menus.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminMenuUser, $this->menu1));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminMenuUser, $this->menu2));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->adminMenuUser, $this->menu3));

    // Menu 1 user has only access to menu 1.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu1User, $this->menu1));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu1User, $this->menu2));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu1User, $this->menu3));

    // Menu 2 user has only access to menu 2.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu2User, $this->menu1));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu2User, $this->menu2));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu2User, $this->menu3));

    // Menu 3 user has only access to menu 3 because of the hook
    // implementation.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu3User, $this->menu1));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu3User, $this->menu2));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuAccess($this->menu3User, $this->menu3));
  }

  /**
   * Access check for menu link content access callback.
   *
   * @covers ::menuItemAccess
   */
  public function testMenuItemAccess() {
    $menu_1_link = $this->menuLinkContentStorage
      ->create([
      'menu_name' => $this->menu1
        ->id(),
    ]);
    $menu_2_link = $this->menuLinkContentStorage
      ->create([
      'menu_name' => $this->menu2
        ->id(),
    ]);
    $menu_3_link = $this->menuLinkContentStorage
      ->create([
      'menu_name' => $this->menu3
        ->id(),
    ]);

    // Anonymous users has no access to one of the menu items.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->anonymousUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->anonymousUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->anonymousUser, $menu_3_link));

    // Authenticated user has no access to one of the menu items.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->authenticatedUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->authenticatedUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->authenticatedUser, $menu_3_link));

    // Admin user has access to all of the menu items.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminUser, $menu_3_link));

    // User with 'administer menu' permission has access to all menus items.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminMenuUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminMenuUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminMenuUser, $menu_3_link));

    // Menu 1 user has only access to menu items of menu 1.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu1User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu1User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu1User, $menu_3_link));

    // Menu 2 user has only access to menu items of menu 2.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu2User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu2User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu2User, $menu_3_link));

    // Menu 3 user has only access to menu items of menu 3 because of the hook
    // implementation.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu3User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu3User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->menu3User, $menu_3_link));

    // Make sure that calling the menuItemAccess method without menu link does
    // not result in a fatal error.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuItemAccess($this->adminUser));
  }

  /**
   * Test the access callbacks for menu links provided by *.links.menu.yml.
   *
   * @covers ::menuLinkAccess
   */
  public function testMenuLinkAccess() {
    $menu_1_link = $this->menuLinkManager
      ->getInstance([
      'id' => 'menu_1.link',
    ]);
    $menu_2_link = $this->menuLinkManager
      ->getInstance([
      'id' => 'menu_2.link',
    ]);
    $menu_3_link = $this->menuLinkManager
      ->getInstance([
      'id' => 'menu_3.link',
    ]);

    // Anonymous users has no access to one of the menu items.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->anonymousUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->anonymousUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->anonymousUser, $menu_3_link));

    // Authenticated user has no access to one of the menu items.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->authenticatedUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->authenticatedUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->authenticatedUser, $menu_3_link));

    // Admin user has access to all of the menu items.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminUser, $menu_3_link));

    // User with 'administer menu' permission has access to all menus items.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminMenuUser, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminMenuUser, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminMenuUser, $menu_3_link));

    // Menu 1 user has only access to menu items of menu 1.
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu1User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu1User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu1User, $menu_3_link));

    // Menu 2 user has only access to menu items of menu 2.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu2User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu2User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu2User, $menu_3_link));

    // Menu 3 user has only access to menu items of menu 3 because of the hook
    // implementation.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu3User, $menu_1_link));
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu3User, $menu_2_link));
    $this
      ->assertEquals(new AccessResultAllowed(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->menu3User, $menu_3_link));

    // Make sure that calling the MenuLinkAccess method without menu link does
    // not result in a fatal error.
    $this
      ->assertEquals(new AccessResultNeutral(), $this->menuAdminPerMenuAllowedMenus
      ->menuLinkAccess($this->adminUser));
  }

}

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.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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.
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::$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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
MenuAdminPerMenuAccessTest::$adminMenuUser protected property A user entity.
MenuAdminPerMenuAccessTest::$adminUser protected property A user entity.
MenuAdminPerMenuAccessTest::$anonymousUser protected property A user entity.
MenuAdminPerMenuAccessTest::$authenticatedUser protected property A user entity.
MenuAdminPerMenuAccessTest::$menu1 protected property A menu entity.
MenuAdminPerMenuAccessTest::$menu1User protected property A user entity.
MenuAdminPerMenuAccessTest::$menu2 protected property A menu entity.
MenuAdminPerMenuAccessTest::$menu2User protected property A user entity.
MenuAdminPerMenuAccessTest::$menu3 protected property A menu entity.
MenuAdminPerMenuAccessTest::$menu3User protected property A user entity.
MenuAdminPerMenuAccessTest::$menuAdminPerMenuAllowedMenus protected property The allowed menus provider.
MenuAdminPerMenuAccessTest::$menuLinkContentStorage protected property The menu link content storage.
MenuAdminPerMenuAccessTest::$menuLinkManager protected property The menu link manager.
MenuAdminPerMenuAccessTest::$menuStorage protected property The menu storage.
MenuAdminPerMenuAccessTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
MenuAdminPerMenuAccessTest::setUp protected function Overrides KernelTestBase::setUp
MenuAdminPerMenuAccessTest::testGetMenuPermissions public function Test getPerMenuPermissions method.
MenuAdminPerMenuAccessTest::testMenuAccess public function Test menu edit page access callback.
MenuAdminPerMenuAccessTest::testMenuItemAccess public function Access check for menu link content access callback.
MenuAdminPerMenuAccessTest::testMenuLinkAccess public function Test the access callbacks for menu links provided by *.links.menu.yml.
MenuAdminPerMenuAccessTest::testMenusOverviewAccess public function Test result for the menu overview access callback.
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.
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.
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.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
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.