You are here

Home » API reference » Language Selection Page 8.2 » LanguageSelectionPageConditionLanguagePrefixes.php

final class LanguageSelectionPageConditionLanguagePrefixes in Language Selection Page 8.2

Class for the Language Prefixes plugin.

Plugin annotation


@LanguageSelectionPageCondition(
    id="language_prefixes",
    weight=-110,
    name=@Translation("Language prefixes"),
    description=@Translation("Bails out when enabled languages doesn't have prefixes."),
    runInBlock=TRUE,
)

Hierarchy

Expanded class hierarchy of LanguageSelectionPageConditionLanguagePrefixes

File

src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionLanguagePrefixes.php, line 27

Namespace

Drupal\language_selection_page\Plugin\LanguageSelectionPageCondition
View source 
final class LanguageSelectionPageConditionLanguagePrefixes extends LanguageSelectionPageConditionBase implements LanguageSelectionPageConditionInterface {

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

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

  /**
   * Constructs a LanguageSelectionPageConditionLanguagePrefixes plugin.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->languageManager = $language_manager;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function alterPageContent(array &$content = [], $destination = '<front>') {
    $links = [];
    $cacheable_metadata = new CacheableMetadata();
    $cacheable_metadata
      ->addCacheTags([
      'config:configurable_language_list',
      'config:language_selection_page.negotiation',
    ]);
    $cacheable_metadata
      ->addCacheContexts([
      'url',
    ]);

    // As we are generating a URL from user input, we need to catch any
    // exceptions thrown by invalid paths.
    try {

      // @todo This variable will be used in the template.
      // @todo We still have to decide what to send in it, and how.
      $links_array = [];
      foreach ($this->languageManager
        ->getNativeLanguages() as $language) {
        $url = Url::fromUserInput($destination, [
          'language' => $language,
        ]);
        $links_array[$language
          ->getId()] = [
          // We need to clone the $url object to avoid using the same one for
          // all links. When the links are rendered, options are set on the $url
          // object, so if we use the same one, they would be set for all links.
          'url' => clone $url,
          'title' => $language
            ->getName(),
          'language' => $language,
          'attributes' => [
            'class' => [
              'language-link',
            ],
          ],
        ];
      }
      foreach ($this->languageManager
        ->getNativeLanguages() as $language) {
        $url = Url::fromUserInput($destination, [
          'language' => $language,
        ]);
        $project_link = Link::fromTextAndUrl($language
          ->getName(), $url);
        $project_link = $project_link
          ->toRenderable();
        $project_link['#attributes'] = [
          'class' => [
            'language_selection_page_link_' . $language
              ->getId(),
          ],
        ];
        $links[$language
          ->getId()] = $project_link;
      }
    } catch (\InvalidArgumentException $exception) {
      $destination = '<front>';
    }
    $content[] = [
      '#theme' => 'language_selection_page_content',
      '#destination' => $destination,
      '#language_links' => [
        '#theme' => 'item_list',
        '#items' => $links,
      ],
    ];
    $cacheable_metadata
      ->applyTo($content);
  }

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

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $languages = $this->languageManager
      ->getNativeLanguages();
    $language_negotiation_config = $this->configFactory
      ->get('language.negotiation')
      ->get('url');
    $prefixes = array_filter($language_negotiation_config['prefixes']);
    if (\count($languages) !== \count($prefixes)) {
      return $this
        ->block();
    }
    return $this
      ->pass();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 5
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 5
ConditionPluginBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
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::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
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
ExecutablePluginBase::getConfig public function Gets all configuration values.
ExecutablePluginBase::getConfigDefinition public function Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions public function Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig public function Sets the value of a particular configuration option.
LanguageSelectionPageConditionBase::$weight protected property The condition's weight, order of execution.
LanguageSelectionPageConditionBase::alterPageResponse public function Alter the page response. Overrides LanguageSelectionPageConditionInterface::alterPageResponse
LanguageSelectionPageConditionBase::block public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::block
LanguageSelectionPageConditionBase::getDescription public function Returns the description of the plugin. Overrides LanguageSelectionPageConditionInterface::getDescription
LanguageSelectionPageConditionBase::getDestination public function Find the destination to redirect the user to after choosing the language. Overrides LanguageSelectionPageConditionInterface::getDestination 1
LanguageSelectionPageConditionBase::getName public function Returns the name of the plugin. Overrides LanguageSelectionPageConditionInterface::getName
LanguageSelectionPageConditionBase::getWeight public function Returns the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::getWeight
LanguageSelectionPageConditionBase::pass public function Wrapper function that returns FALSE. Overrides LanguageSelectionPageConditionInterface::pass
LanguageSelectionPageConditionBase::postConfigSave public function Post config save method. Overrides LanguageSelectionPageConditionInterface::postConfigSave 1
LanguageSelectionPageConditionBase::setWeight public function Set the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::setWeight
LanguageSelectionPageConditionBase::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm 1
LanguageSelectionPageConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
LanguageSelectionPageConditionLanguagePrefixes::$configFactory protected property The config factory.
LanguageSelectionPageConditionLanguagePrefixes::$languageManager protected property The language manager.
LanguageSelectionPageConditionLanguagePrefixes::alterPageContent public function Alter the $content render array used to build the LSP page. Overrides LanguageSelectionPageConditionBase::alterPageContent
LanguageSelectionPageConditionLanguagePrefixes::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageSelectionPageConditionLanguagePrefixes::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides LanguageSelectionPageConditionBase::evaluate
LanguageSelectionPageConditionLanguagePrefixes::__construct public function Constructs a LanguageSelectionPageConditionLanguagePrefixes plugin. Overrides ConditionPluginBase::__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 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.
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
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