You are here

Home » API reference » Config menu link 8 » MenuLinkConfig.php

class MenuLinkConfig in Config menu link 8

Same name in this branch
  1. 8 src/Entity/MenuLinkConfig.php \Drupal\menu_link_config\Entity\MenuLinkConfig
  2. 8 src/Plugin/Derivative/MenuLinkConfig.php \Drupal\menu_link_config\Plugin\Derivative\MenuLinkConfig
  3. 8 src/Plugin/Menu/MenuLinkConfig.php \Drupal\menu_link_config\Plugin\Menu\MenuLinkConfig

Provides a menu link plugin based upon storage in config.

@todo Instead of extending MenuLinkContent, there should be a generic base class for the generic entity handling.

Hierarchy

Expanded class hierarchy of MenuLinkConfig

1 string reference to 'MenuLinkConfig'
menu_link_config.links.menu.yml in ./menu_link_config.links.menu.yml
menu_link_config.links.menu.yml

File

src/Plugin/Menu/MenuLinkConfig.php, line 23
Contains \Drupal\menu_link_config\Plugin\Menu\MenuLinkConfig.

Namespace

Drupal\menu_link_config\Plugin\Menu
View source 
class MenuLinkConfig extends MenuLinkContent {

  /**
   * The config menu link entity connected to this plugin instance.
   *
   * @var \Drupal\menu_link_config\MenuLinkConfigInterface
   */
  protected $entity;

  /**
   * The config translation mapper manager.
   *
   * Used to provide the translation route in case Config Translation module is
   * installed.
   *
   * @var \Drupal\config_translation\ConfigMapperManagerInterface
   */
  protected $mapperManager;

  /**
   * Constructs a MenuLinkConfig.
   *
   * @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_manager
   *   The entity manager.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $mapper_manager
   *   The config translation mapper manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_manager, LanguageManagerInterface $language_manager, ConfigMapperManagerInterface $mapper_manager = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_manager, $language_manager);
    $this->mapperManager = $mapper_manager;
  }

  /**
   * {@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('plugin.manager.config_translation.mapper', ContainerInterface::NULL_ON_INVALID_REFERENCE));
  }

  /**
   * Loads the entity associated with this menu link.
   *
   * @return \Drupal\menu_link_config\MenuLinkConfigInterface
   *   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() {
    if (empty($this->entity)) {
      $entity = NULL;
      $storage = $this->entityManager
        ->getStorage('menu_link_config');
      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 loadMultple(). 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 = array();
      }
      if (!$entity) {

        // Fallback to the loading by the ID.
        $entity = $storage
          ->load($this
          ->getDerivativeId());
      }
      if (!$entity) {
        throw new PluginException(sprintf('Entity not found through the menu link plugin definition and could not fallback on ID %s', $this
          ->getDerivativeId()));
      }

      // Clone the entity object to avoid tampering with the static cache.
      $this->entity = clone $entity;
      $this->entity = $this->entityManager
        ->getTranslationFromContext($this->entity);
    }
    return $this->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {

    // @todo
    return NULL;
  }

  /**
   * {@inheritdoc}
   *
   * @todo This could be moved upstream, as it is generic.
   */
  public function getEditRoute() {
    return $this
      ->getEntity()
      ->toUrl('edit-form');
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslateRoute() {

    // @todo There should be some way for Config Translation module to alter
    //   this information in on its own.
    if ($this->mapperManager) {
      $entity_type = 'menu_link_config';

      /** @var \Drupal\menu_link_config\MenuLinkConfigMapper $mapper */
      $mapper = $this->mapperManager
        ->createInstance($entity_type);
      $mapper
        ->setEntity($this
        ->getEntity());
      return array(
        'route_name' => $mapper
          ->getOverviewRouteName(),
        'route_parameters' => $mapper
          ->getOverviewRouteParameters(),
      );
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getUuid() {
    return $this
      ->getEntity()
      ->uuid();
  }

  /**
   * {@inheritdoc}
   *
   * @todo Simply storing the entity type ID in a variable would alleviate the
   *   need to override this entire method.
   */
  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;
      }
      $this->entityManager
        ->getStorage('menu_link_config')
        ->save($entity);
    }
    return $this->pluginDefinition;
  }

  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {

    // @todo Injecting the module handler for a proper moduleExists() check
    //   might be a bit cleaner.
    return (bool) $this->mapperManager;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
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
MenuLinkConfig::$entity protected property The config menu link entity connected to this plugin instance. Overrides MenuLinkContent::$entity
MenuLinkConfig::$mapperManager protected property The config translation mapper manager.
MenuLinkConfig::create public static function Creates an instance of the plugin. Overrides MenuLinkContent::create
MenuLinkConfig::getDeleteRoute public function Returns route information for a route to delete the menu link. Overrides MenuLinkContent::getDeleteRoute
MenuLinkConfig::getEditRoute public function @todo This could be moved upstream, as it is generic. Overrides MenuLinkContent::getEditRoute
MenuLinkConfig::getEntity public function Loads the entity associated with this menu link. Overrides MenuLinkContent::getEntity
MenuLinkConfig::getTranslateRoute public function Returns route information for a route to translate the menu link. Overrides MenuLinkContent::getTranslateRoute
MenuLinkConfig::getUuid protected function Returns the unique ID representing the menu link. Overrides MenuLinkContent::getUuid
MenuLinkConfig::isTranslatable public function Returns whether this link can be translated. Overrides MenuLinkContent::isTranslatable
MenuLinkConfig::updateLink public function @todo Simply storing the entity type ID in a variable would alleviate the need to override this entire method. Overrides MenuLinkContent::updateLink
MenuLinkConfig::__construct public function Constructs a MenuLinkConfig. Overrides MenuLinkContent::__construct
MenuLinkContent::$deprecatedProperties protected property
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::deleteLink public function Deletes a menu link. Overrides MenuLinkBase::deleteLink
MenuLinkContent::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
MenuLinkContent::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
MenuLinkContent::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkBase::isDeletable
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.