class MenuLinkTreeManipulators in Menu Manipulator 8.2
Same name and namespace in other branches
- 8 src/Menu/MenuLinkTreeManipulators.php \Drupal\menu_manipulator\Menu\MenuLinkTreeManipulators
- 3.0.x src/Menu/MenuLinkTreeManipulators.php \Drupal\menu_manipulator\Menu\MenuLinkTreeManipulators
- 2.0.x src/Menu/MenuLinkTreeManipulators.php \Drupal\menu_manipulator\Menu\MenuLinkTreeManipulators
Provides a couple of menu link tree manipulators.
This class provides menu link tree manipulators to:
- perform render cached menu-optimized access checking
- optimized node access checking
- generate a unique index for the elements in a tree and sorting by it
- flatten a tree (i.e. a 1-dimensional tree)
- See https://www.drupal.org/project/drupal/issues/2466553#comment-12455018
Hierarchy
- class \Drupal\Core\Menu\DefaultMenuLinkTreeManipulators
- class \Drupal\menu_manipulator\Menu\MenuLinkTreeManipulators
Expanded class hierarchy of MenuLinkTreeManipulators
See also
menu_manipulator_get_multilingual_menu() To see an example of use.
1 string reference to 'MenuLinkTreeManipulators'
1 service uses MenuLinkTreeManipulators
File
- src/
Menu/ MenuLinkTreeManipulators.php, line 30
Namespace
Drupal\menu_manipulator\MenuView source
class MenuLinkTreeManipulators extends DefaultMenuLinkTreeManipulators {
/**
* The access manager.
*
* @var \Drupal\Core\Access\AccessManagerInterface
*/
protected $accessManager;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $account;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The entity repository.
*
* @var \Drupal\Core\Entity\EntityRepository
*/
protected $entityRepository;
/**
* The current language ID.
*
* @var string
*/
protected $langcode;
/**
* The list of available languages.
*
* @var array
* \Drupal\Core\Language\LanguageInterface[] An associative array of
* languages keyed by the language code.
*/
protected $languages;
/**
* Drupal\Core\Entity\EntityStorageInterface.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
* A storage instance.
*/
protected $menuLinkContentStorage;
/**
* Constructs a \Drupal\Core\Menu\DefaultMenuLinkTreeManipulators object.
*
* @param \Drupal\Core\Access\AccessManagerInterface $access_manager
* The access manager.
* @param \Drupal\Core\Session\AccountInterface $account
* The current user.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Language\LanguageManager $language_manager
* The language manager.
* @param \Drupal\Core\Entity\EntityRepository $entity_repository
* The entity repository.
*/
public function __construct(AccessManagerInterface $access_manager, AccountInterface $account, EntityTypeManagerInterface $entity_type_manager, LanguageManager $language_manager, EntityRepository $entity_repository) {
$this->accessManager = $access_manager;
$this->account = $account;
$this->entityTypeManager = $entity_type_manager;
$this->entityRepository = $entity_repository;
$this->langcode = $language_manager
->getCurrentLanguage()
->getId();
$this->languages = $language_manager
->getLanguages();
$this->menuLinkContentStorage = $this->entityTypeManager
->getStorage('menu_link_content');
}
/**
* Filter a menu tree by current language MenuLinks.
*
* @param \Drupal\Core\Menu\MenuLinkTreeElement[] $tree
* The menu link tree to manipulate.
*
* @return \Drupal\Core\Menu\MenuLinkTreeElement[]
* The manipulated menu link tree.
*/
public function filterByCurrentLanguage(array $tree) {
foreach ($tree as $key => $element) {
if ($element->link instanceof MenuLinkContent) {
$link =& $element->link;
$langcode = $this
->getLinkLanguage($link);
$entity = $this
->getLinkEntity($link);
if ($entity instanceof ContentEntityInterface && method_exists($entity, 'hasTranslation')) {
// Check language of targeted Entity.
$access = $entity
->hasTranslation($this->langcode);
}
else {
// Check menu link item's language.
$access = $this->langcode == $langcode;
}
// Deny access and stop now.
if (!$access) {
$tree[$key]->link = new InaccessibleMenuLink($tree[$key]->link);
$tree[$key]->access = AccessResult::forbidden();
$tree[$key]->subtree = [];
continue;
}
// Default access check.
$tree[$key]->access = parent::menuLinkCheckAccess($element->link);
// Filter children items recursively.
if ($element->hasChildren) {
$element->subtree = $this
->filterByCurrentLanguage($element->subtree);
}
}
}
return $tree;
}
/**
* Force the MenuLinkContent to tell us its language code.
*
* @param \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent $link
* `The Menu Link Content entity.
*
* @return string
* The Menu Link Content entity's language ID.
*/
protected function getLinkLanguage(MenuLinkContent $link) {
$metadata = $link
->getMetaData();
$loaded_link = $this->menuLinkContentStorage
->load($metadata['entity_id']);
$loaded_lang_link = $this->entityRepository
->getTranslationFromContext($loaded_link);
return $loaded_lang_link
->language()
->getId();
}
/**
* Get targeted entity for a given MenuLinkContent.
*
* @param \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent $link
* `The Menu Link Content entity.
*
* @return \Drupal\Core\Entity\EntityInterface|null|bool
* FALSE if Url is unrouted or an entity object variant or NULL if the entity does not exist.
*/
protected function getLinkEntity(MenuLinkContent $link) {
$metadata = $link
->getMetaData();
$loaded_link = $this->menuLinkContentStorage
->load($metadata['entity_id']);
$url = Url::fromUri($loaded_link
->get('link')
->getString());
if (!$url instanceof Url || !$url
->isRouted()) {
return FALSE;
}
// Get entity info from route.
list($entity_type, $entity_id) = explode('/', $url
->getInternalPath());
return !\is_string($entity_type) || empty($entity_id) ? FALSE : $this->entityRepository
->getActive($entity_type, $entity_id);
}
}