You are here

Home » API reference » Menu Item Extras 8.2 » MenuLinkContentId.php

class MenuLinkContentId in Menu Item Extras 8.2

Active menu item id default argument.

Plugin annotation


@ViewsArgumentDefault(
  id = "mlc_id",
  title = @Translation("Active menu item ID")
)

Hierarchy

Expanded class hierarchy of MenuLinkContentId

File

src/Plugin/views/argument_default/MenuLinkContentId.php, line 23

Namespace

Drupal\menu_item_extras\Plugin\views\argument_default
View source 
class MenuLinkContentId extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

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

  /**
   * Menu tree.
   *
   * @var \Drupal\Core\Menu\MenuLinkTreeInterface
   */
  protected $menuTree;

  /**
   * Current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * Constructs a new Tid instance.
   *
   * @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\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menu_tree
   *   Menu tree.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Current request.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, EntityTypeManagerInterface $entity_type_manager, MenuLinkTreeInterface $menu_tree, Request $request) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
    $this->entityTypeManager = $entity_type_manager;
    $this->menuTree = $menu_tree;
    $this->currentRequest = $request;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'), $container
      ->get('entity_type.manager'), $container
      ->get('menu.link_tree'), $container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['menu'] = [
      'default' => 'main',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $options = [];

    /** @var \Drupal\system\Entity\Menu[] $menus */
    $menus = $this
      ->getMenus();
    foreach ($menus as $menu) {
      $options[$menu
        ->id()] = $menu
        ->label();
    }
    $default = $this->options['menu'];
    if (!isset($options[$default])) {
      $default = isset($options['main']) ? 'main' : '';
    }
    $form['menu'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Menu'),
      '#options' => $options,
      '#default_value' => $default,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getArgument() {
    if ($this->options['menu']) {
      $current_path = $this->currentRequest
        ->getRequestUri();

      /** @var \Drupal\Core\Menu\MenuTreeParameters $parameters */
      $parameters = $this->menuTree
        ->getCurrentRouteMenuTreeParameters($this->options['menu']);
      $parameters
        ->onlyEnabledLinks();

      /** @var \Drupal\Core\Menu\MenuLinkTreeElement[] $menu_level */
      $menu_level = $this->menuTree
        ->load($this->options['menu'], $parameters);

      /** @var \Drupal\Core\Menu\MenuLinkTreeElement $active_item */
      $active_item = $this
        ->getActiveMenuItem($menu_level, $current_path);
      if ($active_item) {

        /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
        $link = $active_item->link;
        $metadata = $link
          ->getMetaData();
        return $metadata['entity_id'];
      }
    }
  }

  /**
   * Get active menu item.
   *
   * @param array $menu_level
   *   Menu tree.
   * @param string $current_path
   *   Current path.
   *
   * @return \Drupal\Core\Menu\MenuLinkTreeElement|null
   *   Active menu item.
   */
  public function getActiveMenuItem(array $menu_level, $current_path) {
    $active_item = NULL;

    /** @var \Drupal\Core\Menu\MenuLinkTreeElement[] $menu_level */
    foreach ($menu_level as $menu_item) {
      if ($menu_item->inActiveTrail) {

        /** @var \Drupal\menu_link_content\Plugin\Menu\MenuLinkContent $link */
        $link = $menu_item->link;

        /** @var \Drupal\Core\Url $url_object */
        $url_object = $link
          ->getUrlObject();
        $item_path = $url_object
          ->toString();
        if ($item_path === $current_path) {
          $active_item = $menu_item;
        }
        if ($menu_item->subtree && !$active_item) {
          $active_item = $this
            ->getActiveMenuItem($menu_item->subtree, $current_path);
        }
      }
    }
    return $active_item;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return Cache::PERMANENT;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [
      'url',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    return $dependencies;
  }

  /**
   * Get menus.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   List of menu entities.
   */
  public function getMenus() {
    $menus = $this->entityTypeManager
      ->getStorage('menu')
      ->loadMultiple();
    return $menus;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentDefaultPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentDefaultPluginBase::access public function Determine if the administrator has the privileges to use this plugin
ArgumentDefaultPluginBase::checkAccess protected function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
ArgumentDefaultPluginBase::getCacheTags public function
ArgumentDefaultPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentDefaultPluginBase::submitOptionsForm public function Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm 1
ArgumentDefaultPluginBase::validateOptionsForm public function Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
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
MenuLinkContentId::$currentRequest protected property Current request.
MenuLinkContentId::$entityTypeManager protected property Entity type manager.
MenuLinkContentId::$menuTree protected property Menu tree.
MenuLinkContentId::$routeMatch protected property The route match.
MenuLinkContentId::buildOptionsForm public function Provide the default form for setting options. Overrides ArgumentDefaultPluginBase::buildOptionsForm
MenuLinkContentId::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
MenuLinkContentId::create public static function Creates an instance of the plugin. Overrides PluginBase::create
MenuLinkContentId::defineOptions protected function Retrieve the options when this is a new access control plugin Overrides ArgumentDefaultPluginBase::defineOptions
MenuLinkContentId::getActiveMenuItem public function Get active menu item.
MenuLinkContentId::getArgument public function Return the default argument. Overrides ArgumentDefaultPluginBase::getArgument
MenuLinkContentId::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
MenuLinkContentId::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
MenuLinkContentId::getMenus public function Get menus.
MenuLinkContentId::__construct public function Constructs a new Tid instance. Overrides PluginBase::__construct
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query 8
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.