You are here

Home » API reference » Cheeseburger Menu 5.0.x » LanguageSwitchMenuLink.php

class LanguageSwitchMenuLink in Cheeseburger Menu 5.0.x

Language swithcher link - dynamically changes based on langcode.

Hierarchy

Expanded class hierarchy of LanguageSwitchMenuLink

1 string reference to 'LanguageSwitchMenuLink'
cheeseburger_menu.links.menu.yml in ./cheeseburger_menu.links.menu.yml
cheeseburger_menu.links.menu.yml

File

src/Plugin/Menu/LanguageSwitchMenuLink.php, line 17

Namespace

Drupal\cheeseburger_menu\Plugin\Menu
View source 
class LanguageSwitchMenuLink extends MenuLinkBase implements ContainerFactoryPluginInterface {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Path matcher.
   *
   * @var \Drupal\Core\Path\PathMatcherInterface
   */
  protected $pathMatcher;

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

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

  /**
   * 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\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   Path matcher.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LanguageManagerInterface $language_manager, PathMatcherInterface $path_matcher, EntityTypeManagerInterface $entity_type_manager, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->pathMatcher = $path_matcher;
    $this->entityTypeManager = $entity_type_manager;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('language_manager'), $container
      ->get('path.matcher'), $container
      ->get('entity_type.manager'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritDoc}
   */
  public function getTitle() {
    $language_menu = $this->entityTypeManager
      ->getStorage('menu')
      ->load('language');
    $langcode = $this
      ->getPluginDefinition()['options']['langcode'];
    return $language_menu
      ->getThirdPartySetting('cheeseburger_menu', 'use_langcode', TRUE) ? $langcode : $this->languageManager
      ->getLanguageName($langcode);
  }

  /**
   * {@inheritDoc}
   */
  public function getUrlObject($title_attribute = TRUE) {
    if ($this->pathMatcher
      ->isFrontPage()) {
      $url = Url::fromRoute('<front>');
    }
    else {
      $current_route = $this->routeMatch
        ->getRouteObject();
      $options = $current_route
        ->getOptions();
      $url = Url::fromRoute($this->routeMatch
        ->getRouteName(), $this->routeMatch
        ->getRawParameters()
        ->all(), $options);
    }
    $language = $this->languageManager
      ->getLanguage($this
      ->getPluginDefinition()['options']['langcode']);
    return $url
      ->setOption('language', $language);
  }

  /**
   * {@inheritDoc}
   */
  public function getDescription() {
    return $this
      ->t('Menu link to current page on certain language');
  }

  /**
   * {@inheritDoc}
   */
  public function updateLink(array $new_definition_values, $persist) {
    return $new_definition_values;
  }

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

  /**
   * {@inheritDoc}
   */
  public function getCacheTags() {
    return [
      'config:system.menu.language',
    ];
  }

}

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
LanguageSwitchMenuLink::$entityTypeManager protected property Entity type manager.
LanguageSwitchMenuLink::$languageManager protected property The language manager.
LanguageSwitchMenuLink::$pathMatcher protected property Path matcher.
LanguageSwitchMenuLink::$routeMatch protected property Route match.
LanguageSwitchMenuLink::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageSwitchMenuLink::getCacheContexts public function The cache contexts associated with this object. Overrides MenuLinkBase::getCacheContexts
LanguageSwitchMenuLink::getCacheTags public function The cache tags associated with this object. Overrides MenuLinkBase::getCacheTags
LanguageSwitchMenuLink::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
LanguageSwitchMenuLink::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle
LanguageSwitchMenuLink::getUrlObject public function Returns a URL object containing either the external path or route. Overrides MenuLinkBase::getUrlObject
LanguageSwitchMenuLink::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
LanguageSwitchMenuLink::__construct public function Constructs a new MenuLinkContent. Overrides PluginBase::__construct
MenuLinkBase::$overrideAllowed protected property The list of definition values where an override is allowed. 3
MenuLinkBase::deleteLink public function Deletes a menu link. Overrides MenuLinkInterface::deleteLink 2
MenuLinkBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 2
MenuLinkBase::getDeleteRoute public function Returns route information for a route to delete the menu link. Overrides MenuLinkInterface::getDeleteRoute 1
MenuLinkBase::getEditRoute public function Returns route information for a custom edit form for the menu link. Overrides MenuLinkInterface::getEditRoute 1
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::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkInterface::isDeletable 2
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
MenuLinkBase::isTranslatable public function Returns whether this link can be translated. Overrides MenuLinkInterface::isTranslatable 1
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.