class DropdownLanguage in Dropdown Language 8.3

Same name in this branch

8.3 src/Plugin/Derivative/DropdownLanguage.php \Drupal\dropdown_language\Plugin\Derivative\DropdownLanguage
8.3 src/Plugin/Block/DropdownLanguage.php \Drupal\dropdown_language\Plugin\Block\DropdownLanguage

Same name and namespace in other branches

8 src/Plugin/Block/DropdownLanguage.php \Drupal\dropdown_language\Plugin\Block\DropdownLanguage
8.2 src/Plugin/Block/DropdownLanguage.php \Drupal\dropdown_language\Plugin\Block\DropdownLanguage
3.0.x src/Plugin/Block/DropdownLanguage.php \Drupal\dropdown_language\Plugin\Block\DropdownLanguage

Provides an alternative language switcher block.

Plugin annotation


@Block(
  id = "dropdown_language",
  admin_label = @Translation("Dropdown Language Selector"),
  category = @Translation("Custom Blocks"),
  deriver = "Drupal\dropdown_language\Plugin\Derivative\DropdownLanguage"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\dropdown_language\Plugin\Block\DropdownLanguage implements ContainerFactoryPluginInterface

Expanded class hierarchy of DropdownLanguage

File

src/Plugin/Block/DropdownLanguage.php, line 28

Namespace

Drupal\dropdown_language\Plugin\Block

View source

class DropdownLanguage extends BlockBase implements ContainerFactoryPluginInterface {

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

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  private $configFactory;

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

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

  /**
   * Constructs a new DropdownLanguage instance.
   *
   * @param array $block_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\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   The path matcher.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route Matcher.
   */
  public function __construct(array $block_configuration, $plugin_id, $plugin_definition, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, PathMatcherInterface $path_matcher, RouteMatchInterface $route_match) {
    parent::__construct($block_configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->configFactory = $config_factory;
    $this->pathMatcher = $path_matcher;
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $block_configuration, $plugin_id, $plugin_definition) {
    return new static($block_configuration, $plugin_id, $plugin_definition, $container
      ->get('language_manager'), $container
      ->get('config.factory'), $container
      ->get('path.matcher'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'label_display' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    $access = $this->languageManager
      ->isMultilingual() ? AccessResult::allowed() : AccessResult::forbidden();
    return $access
      ->addCacheTags([
      'config:configurable_language_list',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $block = [];
    $build = [];
    $languages = $this->languageManager
      ->getLanguages();
    if (count($languages) > 1) {
      $derivative_id = $this
        ->getDerivativeId();
      $route = $this->pathMatcher
        ->isFrontPage() ? '<front>' : '<current>';
      $current_language = $this->languageManager
        ->getCurrentLanguage($derivative_id)
        ->getId();
      $links = $this->languageManager
        ->getLanguageSwitchLinks($derivative_id, Url::fromRoute($route))->links;

      // Place active language ontop of list.
      if (isset($links[$current_language])) {
        $links = [
          $current_language => $links[$current_language],
        ] + $links;

        // Set an active class for styling.
        $links[$current_language]['attributes']['class'][] = 'active-language';

        // Remove self-referencing link.
        $links[$current_language]['url'] = Url::fromRoute('<nolink>');
      }

      // Get block instance and general settings.
      $block_config = $this
        ->getConfiguration();
      $general_config = $this->configFactory
        ->get('dropdown_language.setting');
      $wrapper_default = $general_config
        ->get('wrapper');
      $display_language_id = $general_config
        ->get('display_language_id');
      $filter_untranslated = $general_config
        ->get('filter_untranslated');
      $always_show_block = $general_config
        ->get('always_show_block');

      // Only load once, rather than in switch (in a loop).
      $native_names = FALSE;
      if ($display_language_id == 2) {
        $native_names = $this->languageManager
          ->getStandardLanguageList();
      }

      /**
       * Discover the entity we are currently viewing.
       * Note:  page manager (and other) entities need routines. @v3 plugin.
       *
       * With mulitle param:
       *   a. items may be of any type.
       *   b. last object seems be ideal target object to use as 'self'.
       *
       **/
      $entity = FALSE;
      if ($filter_untranslated == '1') {
        $routedItems = $this->routeMatch;
        foreach ($routedItems
          ->getParameters() as $param) {
          if ($param instanceof EntityInterface) {
            $entity['EntityInterface'] = $param;
          }
        }
      }
      foreach ($links as $lid => $link) {

        // Re-label as per general setting.
        switch ($display_language_id) {
          case '1':
            $links[$lid]['title'] = mb_strtoupper($lid);
            break;
          case '2':
            $name = $link['language']
              ->getName();
            $links[$lid]['title'] = isset($native_names[$lid]) ? $native_names[$lid][1] : $name;
            if (isset($native_names[$lid]) && (isset($native_names[$lid]) && $native_names[$lid][1] != $name)) {
              $links[$lid]['attributes']['title'] = $name;
            }
            break;
          case '3':
            $links[$lid]['title'] = isset($block_config['labels'][$lid]) ? $block_config['labels'][$lid] : $link['language']
              ->getName();
            break;
        }

        // Removes unused languages from the dropdown. @v3
        if ($entity && $entity['EntityInterface'] && $filter_untranslated == '1') {
          $has_translation = method_exists($entity['EntityInterface'], 'getTranslationStatus') ? $entity['EntityInterface']
            ->getTranslationStatus($lid) : FALSE;
          $this_translation = $has_translation && method_exists($entity['EntityInterface'], 'getTranslation') ? $entity['EntityInterface']
            ->getTranslation($lid) : FALSE;
          $access_translation = $this_translation && method_exists($this_translation, 'access') && $this_translation
            ->access('view') ? TRUE : FALSE;
          if (!$this_translation || !$access_translation) {
            unset($links[$lid]);
          }
        }
      }
      $dropdown_button = [
        '#type' => 'dropbutton',
        '#subtype' => 'dropdown_language',
        '#links' => $links,
        '#attributes' => [
          'class' => [
            'dropdown-language-item',
          ],
        ],
        '#attached' => [
          'library' => [
            'dropdown_language/dropdown-language-selector',
          ],
        ],
      ];
      if ($wrapper_default == 1) {
        $block['switcher'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Switch Language'),
        ];
        $block['switcher']['switch-language'] = $dropdown_button;
      }
      else {
        $block['switch-language'] = $dropdown_button;
      }
    }
    if (count($links) > 1 || $always_show_block) {
      $build['dropdown-language'] = $block;
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $form['#attached']['library'][] = 'dropdown_language/dropdown-language-admin';
    $general_config = $this->configFactory
      ->get('dropdown_language.setting');
    $display_language_id = $general_config
      ->get('display_language_id');
    $current_path = Url::fromRoute('<current>')
      ->toString();
    $general_settings = [
      '#type' => 'link',
      '#title' => $this
        ->t('General Settings for all Dropdown Language Blocks'),
      '#url' => Url::fromRoute('dropdown_language.setting', [
        [
          'destination' => $current_path,
        ],
      ]),
      '#attributes' => [
        'class' => [
          'dropdown-general-settings',
        ],
      ],
    ];
    if ($display_language_id == 3) {
      $block_config = $this
        ->getConfiguration();
      $languages = $this->languageManager
        ->getLanguages();
      $form['labels'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Custom Labels for Language Names'),
        '#open' => TRUE,
        '#tree' => TRUE,
      ];
      foreach ($languages as $lid => $item) {
        $form['labels'][$lid] = [
          '#type' => 'textfield',
          '#required' => TRUE,
          '#title' => $this
            ->t('Label for <q>@lng</q>', [
            '@lng' => $item
              ->getName(),
          ]),
          '#default_value' => isset($block_config['labels'][$lid]) ? $block_config['labels'][$lid] : $item
            ->getName(),
        ];
      }
      $form['labels']['translation-note'] = [
        '#type' => 'inline_template',
        '#template' => '<dl class="dropdown-language-help"><dt>{{ title }}</dt><dd>{{ text }}</dd></dl>',
        '#context' => [
          'title' => $this
            ->t('How to translate custom labels'),
          'text' => $this
            ->t('Create a unique block instance for each language then assign via Language Visibility per block.  This is due to the general idea that you are now changing labels that were otherwise normally translatable strings by using these Custom Labels.'),
        ],
      ];
      $form['labels']['setting-link'] = $general_settings;
    }
    else {
      $form['setting-link'] = $general_settings;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this
      ->setConfigurationValue('labels', $form_state
      ->getValue('labels'));
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

}

Members

Name	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::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::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
DropdownLanguage::$configFactory	private	property	The config factory.
DropdownLanguage::$languageManager	protected	property	The language manager.
DropdownLanguage::$pathMatcher	protected	property	The path matcher.
DropdownLanguage::$routeMatch	protected	property	The Route Matcher.
DropdownLanguage::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
DropdownLanguage::blockForm	public	function	Overrides BlockPluginTrait::blockForm
DropdownLanguage::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
DropdownLanguage::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
DropdownLanguage::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DropdownLanguage::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
DropdownLanguage::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
DropdownLanguage::__construct	public	function	Constructs a new DropdownLanguage instance. Overrides BlockPluginTrait::__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::$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

You are here

class DropdownLanguage in Dropdown Language 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation