class MenuLinkContent

Same name in this branch
  1. 11.x core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
Same name and namespace in other branches
  1. 9 core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  2. 9 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
  3. 8.9.x core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  4. 8.9.x core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent
  5. 10 core/modules/menu_link_content/src/Entity/MenuLinkContent.php \Drupal\menu_link_content\Entity\MenuLinkContent
  6. 10 core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent

Provides the menu link plugin for content menu links.

Hierarchy

  • class \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Menu\MenuLinkBase

Expanded class hierarchy of MenuLinkContent

3 files declare their use of MenuLinkContent
MenuForm.php in core/modules/menu_ui/src/MenuForm.php
MenuLinkPluginTest.php in core/modules/menu_link_content/tests/src/Unit/MenuLinkPluginTest.php
MenuLinksTest.php in core/modules/menu_link_content/tests/src/Kernel/MenuLinksTest.php
1 string reference to 'MenuLinkContent'
menu_link_content.links.menu.yml in core/modules/menu_link_content/menu_link_content.links.menu.yml
core/modules/menu_link_content/menu_link_content.links.menu.yml

File

core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php, line 17

Namespace

Drupal\menu_link_content\Plugin\Menu
View source
class MenuLinkContent extends MenuLinkBase implements ContainerFactoryPluginInterface {
  
  /**
   * Entities IDs to load.
   *
   * It is an array of entity IDs keyed by entity IDs.
   *
   * @var array
   */
  protected static $entityIdsToLoad = [];
  
  /**
   * {@inheritdoc}
   */
  protected $overrideAllowed = [
    'menu_name' => 1,
    'parent' => 1,
    'weight' => 1,
    'expanded' => 1,
    'enabled' => 1,
    'title' => 1,
    'description' => 1,
    'route_name' => 1,
    'route_parameters' => 1,
    'url' => 1,
    'options' => 1,
  ];
  
  /**
   * The menu link content entity connected to this plugin instance.
   *
   * @var \Drupal\menu_link_content\MenuLinkContentInterface
   */
  protected $entity;
  
  /**
   * An array of entity operations links.
   *
   * @var array
   */
  protected $listBuilderOperations;
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;
  
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;
  
  /**
   * Constructs a new MenuLinkContent.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, EntityRepositoryInterface $entity_repository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    if (!empty($this->pluginDefinition['metadata']['entity_id'])) {
      $entity_id = $this->pluginDefinition['metadata']['entity_id'];
      // Builds a list of entity IDs to take advantage of the more efficient
      // EntityStorageInterface::loadMultiple() in getEntity() at render time.
      static::$entityIdsToLoad[$entity_id] = $entity_id;
    }
    $this->entityTypeManager = $entity_type_manager;
    $this->languageManager = $language_manager;
    $this->entityRepository = $entity_repository;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('language_manager'), $container->get('entity.repository'));
  }
  
  /**
   * Loads the entity associated with this menu link.
   *
   * @return \Drupal\menu_link_content\MenuLinkContentInterface
   *   The menu link content entity.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If the entity ID and UUID are both invalid or missing.
   */
  public function getEntity() : MenuLinkContentInterface {
    if (empty($this->entity)) {
      $entity = NULL;
      $storage = $this->entityTypeManager
        ->getStorage('menu_link_content');
      if (!empty($this->pluginDefinition['metadata']['entity_id'])) {
        $entity_id = $this->pluginDefinition['metadata']['entity_id'];
        // Make sure the current ID is in the list, since each plugin empties
        // the list after calling loadMultiple(). Note that the list may include
        // multiple IDs added earlier in each plugin's constructor.
        static::$entityIdsToLoad[$entity_id] = $entity_id;
        $entities = $storage->loadMultiple(array_values(static::$entityIdsToLoad));
        $entity = $entities[$entity_id] ?? NULL;
        static::$entityIdsToLoad = [];
      }
      if (!$entity) {
        // Fallback to the loading by the UUID.
        $uuid = $this->getUuid();
        $entity = $this->entityRepository
          ->loadEntityByUuid('menu_link_content', $uuid);
      }
      if (!$entity) {
        throw new PluginException("Entity not found through the menu link plugin definition and could not fallback on UUID '{$uuid}'");
      }
      // Clone the entity object to avoid tampering with the static cache.
      $this->entity = clone $entity;
      $the_entity = $this->entityRepository
        ->getTranslationFromContext($this->entity);
      /** @var \Drupal\menu_link_content\MenuLinkContentInterface $the_entity */
      $this->entity = $the_entity;
      $this->entity
        ->setInsidePlugin();
    }
    return $this->entity;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    // We only need to get the title from the actual entity if it may be a
    // translation based on the current language context. This can only happen
    // if the site is configured to be multilingual.
    if ($this->languageManager
      ->isMultilingual()) {
      return $this->getEntity()
        ->getTitle();
    }
    return $this->pluginDefinition['title'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    // We only need to get the description from the actual entity if it may be a
    // translation based on the current language context. This can only happen
    // if the site is configured to be multilingual.
    if ($this->languageManager
      ->isMultilingual()) {
      return $this->getEntity()
        ->getDescription();
    }
    return $this->pluginDefinition['description'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
    $operations = $this->getListBuilderOperations();
    return isset($operations['delete']) ? $operations['delete']['url'] : NULL;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
    $operations = $this->getListBuilderOperations();
    return isset($operations['edit']) ? $operations['edit']['url'] : NULL;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getTranslateRoute() {
    $operations = $this->getListBuilderOperations();
    return isset($operations['translate']) ? $operations['translate']['url'] : NULL;
  }
  
  /**
   * Load entity operations from the list builder.
   *
   * @return array
   *   An array of operations.
   */
  protected function getListBuilderOperations() {
    if (is_null($this->listBuilderOperations)) {
      $this->listBuilderOperations = $this->entityTypeManager
        ->getListBuilder($this->getEntity()
        ->getEntityTypeId())
        ->getOperations($this->getEntity());
    }
    return $this->listBuilderOperations;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getOperations() : array {
    return $this->getListBuilderOperations();
  }
  
  /**
   * Returns the unique ID representing the menu link.
   *
   * @return string
   *   The menu link ID.
   */
  protected function getUuid() {
    return $this->getDerivativeId();
  }
  
  /**
   * {@inheritdoc}
   */
  public function updateLink(array $new_definition_values, $persist) {
    // Filter the list of updates to only those that are allowed.
    $overrides = array_intersect_key($new_definition_values, $this->overrideAllowed);
    // Update the definition.
    $this->pluginDefinition = $overrides + $this->getPluginDefinition();
    if ($persist) {
      $entity = $this->getEntity();
      foreach ($overrides as $key => $value) {
        $entity->{$key}->value = $value;
      }
      $entity->save();
    }
    return $this->pluginDefinition;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isDeletable() {
    return TRUE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {
    return $this->getEntity()
      ->isTranslatable();
  }
  
  /**
   * {@inheritdoc}
   */
  public function deleteLink() {
    $this->getEntity()
      ->delete();
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MenuLinkBase::getCacheContexts public function Overrides CacheableDependencyInterface::getCacheContexts 3
MenuLinkBase::getCacheMaxAge public function Overrides CacheableDependencyInterface::getCacheMaxAge 2
MenuLinkBase::getCacheTags public function Overrides CacheableDependencyInterface::getCacheTags 2
MenuLinkBase::getFormClass public function Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName public function Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData public function Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions public function Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent public function Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider public function Overrides MenuLinkInterface::getProvider
MenuLinkBase::getResetRoute public function Overrides MenuLinkInterface::getResetRoute 1
MenuLinkBase::getRouteName public function Overrides MenuLinkInterface::getRouteName 2
MenuLinkBase::getRouteParameters public function Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getUrlObject public function Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight public function Overrides MenuLinkInterface::getWeight
MenuLinkBase::isEnabled public function Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded public function Overrides MenuLinkInterface::isExpanded 1
MenuLinkBase::isResettable public function Overrides MenuLinkInterface::isResettable 1
MenuLinkContent::$entity protected property The menu link content entity connected to this plugin instance.
MenuLinkContent::$entityIdsToLoad protected static property Entities IDs to load.
MenuLinkContent::$entityRepository protected property The entity repository.
MenuLinkContent::$entityTypeManager protected property The entity type manager.
MenuLinkContent::$languageManager protected property The language manager.
MenuLinkContent::$listBuilderOperations protected property An array of entity operations links.
MenuLinkContent::$overrideAllowed protected property Overrides MenuLinkBase::$overrideAllowed
MenuLinkContent::create public static function Overrides ContainerFactoryPluginInterface::create
MenuLinkContent::deleteLink public function Overrides MenuLinkBase::deleteLink
MenuLinkContent::getDeleteRoute public function Overrides MenuLinkBase::getDeleteRoute
MenuLinkContent::getDescription public function Overrides MenuLinkInterface::getDescription
MenuLinkContent::getEditRoute public function Overrides MenuLinkBase::getEditRoute
MenuLinkContent::getEntity public function Loads the entity associated with this menu link.
MenuLinkContent::getListBuilderOperations protected function Load entity operations from the list builder.
MenuLinkContent::getOperations public function Overrides MenuLinkBase::getOperations
MenuLinkContent::getTitle public function Overrides MenuLinkInterface::getTitle
MenuLinkContent::getTranslateRoute public function Overrides MenuLinkBase::getTranslateRoute
MenuLinkContent::getUuid protected function Returns the unique ID representing the menu link.
MenuLinkContent::isDeletable public function Overrides MenuLinkBase::isDeletable
MenuLinkContent::isTranslatable public function Overrides MenuLinkBase::isTranslatable
MenuLinkContent::updateLink public function Overrides MenuLinkInterface::updateLink
MenuLinkContent::__construct public function Constructs a new MenuLinkContent.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.