Menu Class Reference

Inheritance diagram for Menu:

Public Member Functions
	__construct (LoggerInterface $logger, $pathInMenuStructure='', Factory $menuItemFactory=null, SerializerInterface $serializer=null)
	add (Item $item, $parentId=null, $index=null)
	move ($itemId, $toItemId, $sortIndex=null)
	isLast (Item $item)
	getParentItems ($itemId)
	serialize ()
	toArray ()
	unserialize ($serialized)
	populateFromArray (array $data)

Protected Attributes
	$_path = ''
	$_logger

Detailed Description

Backend menu model

@api

Since

100.0.2

Definition at line 20 of file Menu.php.

Constructor & Destructor Documentation

__construct()

__construct	(	LoggerInterface	$logger,
			$pathInMenuStructure = '',
		Factory	$menuItemFactory = null,
		SerializerInterface	$serializer = null
	)

Menu constructor

Parameters

LoggerInterface	$logger
string	$pathInMenuStructure
Factory | null	$menuItemFactory
SerializerInterface | null	$serializer

Definition at line 52 of file Menu.php.

      {
        if ($pathInMenuStructure) {
            $this->_path = $pathInMenuStructure . '/';
        }
        $this->_logger = $logger;
        $this->setIteratorClass(\Magento\Backend\Model\Menu\Iterator::class);
        $this->menuItemFactory = $menuItemFactory ?: ObjectManager::getInstance()
            ->create(Factory::class);
        $this->serializer = $serializer ?: ObjectManager::getInstance()->create(SerializerInterface::class);
    }

Member Function Documentation

add()

add	(	Item	$item,
			$parentId = null,
			$index = null
	)

Add child to menu item

Parameters

Item	$item
string	$parentId
int	$index

Returns

void

Exceptions

Definition at line 77 of file Menu.php.

    {
        if ($parentId !== null) {
            $parentItem = $this->get($parentId);
            if ($parentItem === null) {
                throw new \InvalidArgumentException("Item with identifier {$parentId} does not exist");
            }
            $parentItem->getChildren()->add($item, null, $index);
        } else {
            $index = (int) $index;
            if (!isset($this[$index])) {
                $this->offsetSet($index, $item);
                $this->_logger->info(
                    sprintf('Add of item with id %s was processed', $item->getId())
                );
            } else {
                $this->add($item, $parentId, $index + 1);
            }
        }
    }

getParentItems()

getParentItems

(

$itemId

)

Get parent items by item id

Parameters

string

$itemId

Returns

Item[]

Definition at line 233 of file Menu.php.

    {
        $parents = [];
        $this->_findParentItems($this, $itemId, $parents);
        return array_reverse($parents);
    }

isLast()

isLast

(

Item

$item

)

Check whether provided item is last in list

Parameters

Item

$item

Returns

bool

Definition at line 197 of file Menu.php.

    {
        return $this->offsetGet(max(array_keys($this->getArrayCopy())))->getId() == $item->getId();
    }

move()

move	(		$itemId,
			$toItemId,
			$sortIndex = null
	)

Move menu item

Parameters

string	$itemId
string	$toItemId
int	$sortIndex

Returns

void

Exceptions

Definition at line 130 of file Menu.php.

    {
        $item = $this->get($itemId);
        if ($item === null) {
            throw new \InvalidArgumentException("Item with identifier {$itemId} does not exist");
        }
        $this->remove($itemId);
        $this->add($item, $toItemId, $sortIndex);
    }

populateFromArray()

populateFromArray

(

array

$data

)

Populate the menu with data from array

Parameters

array

$data

Returns

void

Since

100.2.0

Definition at line 310 of file Menu.php.

    {
        $items = [];
        foreach ($data as $itemData) {
            $item = $this->menuItemFactory->create($itemData);
            $items[] = $item;
        }
        $this->exchangeArray($items);
    }

serialize()

serialize

(

)

Serialize menu

Returns

string

Definition at line 270 of file Menu.php.

    {
        return $this->serializer->serialize($this->toArray());
    }

toArray()

toArray

(

)

Get menu data represented as an array

Returns

array

Since

100.2.0

Definition at line 281 of file Menu.php.

    {
        $data = [];
        foreach ($this as $item) {
            $data[] = $item->toArray();
        }
        return $data;
    }

unserialize()

unserialize

(

$serialized

)

Unserialize menu

Parameters

string

$serialized

Returns

void

Since

100.2.0

Definition at line 297 of file Menu.php.

    {
        $data = $this->serializer->unserialize($serialized);
        $this->populateFromArray($data);
    }

Field Documentation

$_logger

$_logger

protected

Definition at line 32 of file Menu.php.

$_path

$_path = ''

protected

Definition at line 27 of file Menu.php.

---

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

• vendor/magento/module-backend/Model/Menu.php