You are here

class MicrositeMenuItem in Entity Reference Hierarchy 3.x

Same name and namespace in other branches
  1. 8.2 modules/entity_hierarchy_microsite/src/Plugin/Menu/MicrositeMenuItem.php \Drupal\entity_hierarchy_microsite\Plugin\Menu\MicrositeMenuItem

Defines a class for a menu item based on hierarchy.

Hierarchy

Expanded class hierarchy of MicrositeMenuItem

3 files declare their use of MicrositeMenuItem
entity_hierarchy_microsite.module in modules/entity_hierarchy_microsite/entity_hierarchy_microsite.module
Contains main module functionality.
entity_hierarchy_microsite_test.module in modules/entity_hierarchy_microsite/tests/modules/entity_hierarchy_microsite_test/entity_hierarchy_microsite_test.module
Helper module for the microsite menu tests.
MicrositeMenuLinkDiscovery.php in modules/entity_hierarchy_microsite/src/MicrositeMenuLinkDiscovery.php
1 string reference to 'MicrositeMenuItem'
entity_hierarchy_microsite.links.menu.yml in modules/entity_hierarchy_microsite/entity_hierarchy_microsite.links.menu.yml
modules/entity_hierarchy_microsite/entity_hierarchy_microsite.links.menu.yml

File

modules/entity_hierarchy_microsite/src/Plugin/Menu/MicrositeMenuItem.php, line 15

Namespace

Drupal\entity_hierarchy_microsite\Plugin\Menu
View source
class MicrositeMenuItem extends MenuLinkBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  protected $overrideAllowed = [
    'parent' => 1,
    'weight' => 1,
    'expanded' => 1,
    'enabled' => 1,
    'title' => 1,
  ];

  /**
   * The menu link content entity connected to this plugin instance.
   *
   * @var \Drupal\entity_hierarchy_microsite\Entity\MicrositeMenuItemOverrideInterface
   */
  protected $overrideEntity;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  private $moduleHandler;

  /**
   * Constructs a new MicrositeMenuItem.
   *
   * @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\Extension\ModuleHandlerInterface $module_handler
   *   Module handler.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@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('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function isDeletable() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteLink() {
    if (!$this
      ->getOverrideEntity()
      ->isNew()) {
      $this
        ->getOverrideEntity()
        ->delete();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
    if (!$this
      ->getOverrideEntity()
      ->isNew()) {
      return $this
        ->getOverrideEntity()
        ->toUrl('delete-form');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
    if (!$this
      ->getOverrideEntity()
      ->isNew()) {
      return $this
        ->getOverrideEntity()
        ->toUrl('edit-form');
    }
    return new Url('entity.eh_microsite_menu_override.add', [
      'target' => $this
        ->getDerivativeId(),
    ]);
  }

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

    // We don't allow resetting, but instead allow deleting.
    return FALSE;
  }

  /**
   * Loads the override entity associated with this menu link.
   *
   * @return \Drupal\entity_hierarchy_microsite\Entity\MicrositeMenuItemOverrideInterface
   *   The menu link override
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If the entity ID and UUID are both invalid or missing.
   */
  protected function getOverrideEntity() {
    $storage = $this->entityTypeManager
      ->getStorage('eh_microsite_menu_override');
    if (empty($this->overrideEntity)) {
      if ($items = $storage
        ->loadByProperties([
        'target' => $this
          ->getDerivativeId(),
      ])) {
        $this->overrideEntity = reset($items);
        return $this->overrideEntity;
      }
      $this->overrideEntity = $storage
        ->create([
        'target' => $this
          ->getDerivativeId(),
        'enabled' => $this
          ->isEnabled(),
        'weight' => $this
          ->getWeight(),
        'title' => $this
          ->getTitle(),
        'parent' => $this
          ->getParent(),
      ]);
    }
    return $this->overrideEntity;
  }

  /**
   * {@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.
    $original = $this
      ->getPluginDefinition();
    $metadata = $original['metadata'] + [
      'original' => array_intersect_key($original, [
        'title' => TRUE,
        'weight' => TRUE,
        'enabled' => TRUE,
        'expanded' => TRUE,
        'parent' => TRUE,
      ]),
    ];
    $this->pluginDefinition = [
      'metadata' => $metadata,
    ] + $overrides + $original;
    if ($persist) {
      $overrideEntity = $this
        ->getOverrideEntity();
      foreach ($overrides as $key => $value) {
        $overrideEntity->{$key}->value = $value;
      }
      $overrideEntity
        ->setSyncing(TRUE);
      $overrideEntity
        ->save();
      $overrideEntity
        ->setSyncing(FALSE);
    }
    return $this->pluginDefinition;
  }

  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->pluginDefinition['title'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->pluginDefinition['description'];
  }

  /**
   * {@inheritdoc}
   */
  public function getUrlObject($title_attribute = TRUE) {
    $url = parent::getUrlObject($title_attribute);
    $override_entity = $this
      ->getOverrideEntity();
    $this->moduleHandler
      ->alter('entity_hierarchy_microsite_menu_item_url', $url, $override_entity, $this);
    return $url;
  }

}

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::getTranslateRoute public function Returns route information for a route to translate the menu link. Overrides MenuLinkInterface::getTranslateRoute 1
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
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
MicrositeMenuItem::$entityTypeManager protected property The entity type manager.
MicrositeMenuItem::$moduleHandler private property The module handler.
MicrositeMenuItem::$overrideAllowed protected property The list of definition values where an override is allowed. Overrides MenuLinkBase::$overrideAllowed
MicrositeMenuItem::$overrideEntity protected property The menu link content entity connected to this plugin instance.
MicrositeMenuItem::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MicrositeMenuItem::deleteLink public function Deletes a menu link. Overrides MenuLinkBase::deleteLink
MicrositeMenuItem::getDeleteRoute public function Returns route information for a route to delete the menu link. Overrides MenuLinkBase::getDeleteRoute
MicrositeMenuItem::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
MicrositeMenuItem::getEditRoute public function Returns route information for a custom edit form for the menu link. Overrides MenuLinkBase::getEditRoute
MicrositeMenuItem::getOverrideEntity protected function Loads the override entity associated with this menu link.
MicrositeMenuItem::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
MicrositeMenuItem::getUrlObject public function Returns a URL object containing either the external path or route. Overrides MenuLinkBase::getUrlObject
MicrositeMenuItem::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkBase::isDeletable
MicrositeMenuItem::isResettable public function Returns whether this link can be reset. Overrides MenuLinkBase::isResettable
MicrositeMenuItem::isTranslatable public function Returns whether this link can be translated. Overrides MenuLinkBase::isTranslatable
MicrositeMenuItem::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
MicrositeMenuItem::__construct public function Constructs a new MicrositeMenuItem. Overrides PluginBase::__construct
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.