You are here

Home » API reference » Drupal 9 » MenuLinkContent.php

class MenuLinkContent in Drupal 9

Same name in this branch
  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
Same name and namespace in other branches
  1. 8 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

Expanded class hierarchy of MenuLinkContent

2 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
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 16

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;

  /**
   * 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.
   */
  protected function getEntity() {
    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 = isset($entities[$entity_id]) ? $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() {
    return $this
      ->getEntity()
      ->toUrl('delete-form');
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
    return $this
      ->getEntity()
      ->toUrl();
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslateRoute() {
    return $this
      ->getEntity()
      ->toUrl('drupal:content-translation-overview');
  }

  /**
   * 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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MenuLinkBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 3
MenuLinkBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 2
MenuLinkBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 2
MenuLinkBase::getFormClass public function Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName public function Returns the menu name of the menu link. Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData public function Returns any metadata for this link. Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions public function Returns the options for this link. Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent public function Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider public function Returns the provider (module name) of the menu link. Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName public function Returns the route name, if available. Overrides MenuLinkInterface::getRouteName 2
MenuLinkBase::getRouteParameters public function Returns the route parameters, if available. Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getUrlObject public function Returns a URL object containing either the external path or route. Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight public function Returns the weight of the menu link. Overrides MenuLinkInterface::getWeight
MenuLinkBase::isEnabled public function Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded public function Returns whether the child menu links should always been shown. Overrides MenuLinkInterface::isExpanded 1
MenuLinkBase::isResettable public function Returns whether this link can be reset. 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::$overrideAllowed protected property The list of definition values where an override is allowed. Overrides MenuLinkBase::$overrideAllowed
MenuLinkContent::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MenuLinkContent::deleteLink public function Deletes a menu link. Overrides MenuLinkBase::deleteLink
MenuLinkContent::getDeleteRoute public function Returns route information for a route to delete the menu link. Overrides MenuLinkBase::getDeleteRoute
MenuLinkContent::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
MenuLinkContent::getEditRoute public function Returns route information for a custom edit form for the menu link. Overrides MenuLinkBase::getEditRoute
MenuLinkContent::getEntity protected function Loads the entity associated with this menu link.
MenuLinkContent::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
MenuLinkContent::getTranslateRoute public function Returns route information for a route to translate the menu link. Overrides MenuLinkBase::getTranslateRoute
MenuLinkContent::getUuid protected function Returns the unique ID representing the menu link.
MenuLinkContent::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkBase::isDeletable
MenuLinkContent::isTranslatable public function Returns whether this link can be translated. Overrides MenuLinkBase::isTranslatable
MenuLinkContent::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
MenuLinkContent::__construct public function Constructs a new MenuLinkContent. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.