You are here

class LanguageSwitcherBlock in Open Social 8.4

Same name and namespace in other branches
  1. 8.9 modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  2. 8.5 modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  3. 8.6 modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  4. 8.7 modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  5. 8.8 modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  6. 10.3.x modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  7. 10.0.x modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  8. 10.1.x modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock
  9. 10.2.x modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php \Drupal\social_language\Plugin\Block\LanguageSwitcherBlock

Provides a 'LanguageSwitcherBlock' block.

This replaces the Drupal core language switcher block because that block breaks with the SocialLanguageMetadataBubblingUrlGenerator which is needed to keep users within the same language when viewing content (such as posts) in a language other than their current.

It also customises the look to match that of the Open Social menubar.

Plugin annotation


@Block(
 id = "language_switcher_block",
 admin_label = @Translation("Language switcher block"),
)

Hierarchy

Expanded class hierarchy of LanguageSwitcherBlock

File

modules/custom/social_language/src/Plugin/Block/LanguageSwitcherBlock.php, line 23

Namespace

Drupal\social_language\Plugin\Block
View source
class LanguageSwitcherBlock extends LanguageBlock {

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

    /** @var \Drupal\Core\Language\Language $currentLanguage */
    $currentLanguage = $this->languageManager
      ->getCurrentLanguage();

    // Build the menu.
    $block = [
      '#attributes' => [
        'class' => [
          'navbar-user',
        ],
      ],
      'menu_items' => [
        '#theme' => 'item_list',
        '#list_type' => 'ul',
        '#attributes' => [
          'class' => [
            'nav',
            'navbar-nav',
          ],
        ],
        '#items' => [],
      ],
    ];

    // Add `'#icon' => 'language',` to this array to replace the text
    // with an icon.
    $block['menu_items']['#items']['language'] = [
      '#type' => 'account_header_element',
      '#title' => $currentLanguage
        ->getName() . " (" . $currentLanguage
        ->getId() . ")",
      '#label' => $currentLanguage
        ->getName(),
      '#url' => Url::fromRoute('<none>'),
      '#wrapper_attributes' => [
        'class' => [
          'dropdown',
        ],
      ],
    ];

    // Generate the routes for the current page.
    $route_name = $this->pathMatcher
      ->isFrontPage() ? '<front>' : '<current>';
    $type = $this
      ->getDerivativeId();
    $switchLinks = $this->languageManager
      ->getLanguageSwitchLinks($type, Url::fromRoute($route_name));

    // Use the default URL generator that does not rewrite the language.
    $url_generator = \Drupal::service('drupal_core_url_generator');

    // Add languages as links.
    foreach ($switchLinks->links as $langcode => $link) {
      $link['url']
        ->setOption('language', $this->languageManager
        ->getLanguage($langcode));
      $link['url']
        ->setUrlGenerator($url_generator);
      $block['menu_items']['#items']['language'][$langcode] = [
        '#type' => 'link',
        '#label' => $link['title'] . " (" . $langcode . ")",
        '#title' => $link['title'] . " (" . $langcode . ")",
        '#url' => $link['url'],
        '#attributes' => [
          'class' => [
            $langcode === $currentLanguage
              ->getId() ? 'active' : NULL,
          ],
        ],
      ];
    }
    return $block;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
LanguageBlock::$languageManager protected property The language manager.
LanguageBlock::$pathMatcher protected property The path matcher.
LanguageBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
LanguageBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageBlock::getCacheMaxAge public function @todo Make cacheable in https://www.drupal.org/node/2232375. Overrides ContextAwarePluginBase::getCacheMaxAge
LanguageBlock::__construct public function Constructs an LanguageBlock object. Overrides BlockPluginTrait::__construct
LanguageSwitcherBlock::build public function Builds and returns the renderable array for this block plugin. Overrides LanguageBlock::build
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.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2