Menu Class Reference

Inheritance diagram for Menu:

Public Member Functions
	getTopMenuItems ()
	navigate ($menuItem, $waitMenuItemNotVisible=true)
	isMenuItemVisible ($menuItem)

Protected Attributes
	$mainMenu = './/li[@role="menu-item"]/a[span="%s"]'
	$subMenu = './/li[@role="menu-item" and a[span="%s"]]/div[contains(@class, "submenu")]'
	$subMenuItem = '//li[@role="menu-item"]//a[span="%s"]'
	$parentMenuLevel = 'li.parent.level-0:nth-of-type(%s)'

Detailed Description

Top menu navigation block.

Definition at line 15 of file Menu.php.

Member Function Documentation

getTopMenuItems()

getTopMenuItems

(

)

Returns array of parent menu items present on dashboard menu.

Returns

array

Definition at line 50 of file Menu.php.

    {
        $navigationMenu = $this->_rootElement;
        $menuItems = [];
        $counter = 1;
        $textSelector = 'a span';
        while ($navigationMenu->find(sprintf($this->parentMenuLevel, $counter))->isVisible()) {
            $menuItems[] = strtolower(
                $navigationMenu->find(sprintf($this->parentMenuLevel, $counter))
                    ->find($textSelector)
                    ->getText()
            );
            $counter++;
        }
        return $menuItems;
    }

isMenuItemVisible()

isMenuItemVisible

(

$menuItem

)

Check if menu item is visible.

Parameters

string

$menuItem

Returns

bool

Definition at line 113 of file Menu.php.

    {
        $menuChain = array_map('trim', explode('>', $menuItem));
        $mainMenu = $menuChain[0];
        $subMenu = isset($menuChain[1]) ? $menuChain[1] : null;

        $mainMenuElement = $this->_rootElement->find(sprintf($this->mainMenu, $mainMenu), Locator::SELECTOR_XPATH);
        if (!$mainMenuElement->isVisible()) {
            return false;
        }
        if ($subMenu === null) {
            return true;
        }
        $mainMenuElement->click();

        $subMenuSelector = sprintf($this->subMenu, $mainMenu);
        $this->waitForElementVisible($subMenuSelector, Locator::SELECTOR_XPATH);
        $subMenuItem = $subMenuSelector . sprintf($this->subMenuItem, $subMenu);
        return $this->_rootElement->find($subMenuItem, Locator::SELECTOR_XPATH)->isVisible();
    }

navigate()

navigate	(		$menuItem,
			$waitMenuItemNotVisible = true
	)

Open backend page via menu.

Parameters

string	$menuItem
bool	$waitMenuItemNotVisible

Returns

void

Exceptions

Definition at line 75 of file Menu.php.

    {
        $menuChain = array_map('trim', explode('>', $menuItem));
        $mainMenu = $menuChain[0];
        $subMenu = isset($menuChain[1]) ? $menuChain[1] : null;

        // Click on element in main menu
        $mainMenuElement = $this->_rootElement->find(sprintf($this->mainMenu, $mainMenu), Locator::SELECTOR_XPATH);
        if (!$mainMenuElement->isVisible()) {
            throw new \Exception('Main menu item "' . $mainMenu . '" is not visible.');
        }
        $mainMenuElement->click();

        // Click on element in submenu
        if ($subMenu === null) {
            return;
        }
        $subMenuSelector = sprintf($this->subMenu, $mainMenu);
        $this->waitForElementVisible($subMenuSelector, Locator::SELECTOR_XPATH);
        $subMenuItem = $subMenuSelector . sprintf($this->subMenuItem, $subMenu);
        $this->waitForElementVisible($subMenuItem, Locator::SELECTOR_XPATH);
        // Resolve an issue on with "Offset within element cannot be scrolled into view" on low screen resolution
        try {
            $this->_rootElement->find($subMenuItem, Locator::SELECTOR_XPATH)->hover();
        } catch (\PHPUnit_Extensions_Selenium2TestCase_WebDriverException  $e) {
        }
        $this->_rootElement->find($subMenuItem, Locator::SELECTOR_XPATH)->click();
        if ($waitMenuItemNotVisible) {
            $this->waitForElementNotVisible($subMenuSelector, Locator::SELECTOR_XPATH);
        }
    }

Field Documentation

$mainMenu

$mainMenu = './/li[@role="menu-item"]/a[span="%s"]'

protected

Definition at line 22 of file Menu.php.

$parentMenuLevel

$parentMenuLevel = 'li.parent.level-0:nth-of-type(%s)'

protected

Definition at line 43 of file Menu.php.

$subMenu

$subMenu = './/li[@role="menu-item" and a[span="%s"]]/div[contains(@class, "submenu")]'

protected

Definition at line 29 of file Menu.php.

$subMenuItem

$subMenuItem = '//li[@role="menu-item"]//a[span="%s"]'

protected

Definition at line 36 of file Menu.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/functional/tests/app/Magento/Backend/Test/Block/Menu.php