You are here

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

final class LanguageSelectionPageConditionPath in Language Selection Page 8.2

Class for the Path condition plugin.

Plugin annotation


@LanguageSelectionPageCondition(
    id="path",
    weight=-100,
    name=@Translation("Language selection page path"),
    description=@Translation("Set the path of the language selection page."),
    runInBlock=TRUE,
)

Hierarchy

Expanded class hierarchy of LanguageSelectionPageConditionPath

File

src/Plugin/LanguageSelectionPageCondition/LanguageSelectionPageConditionPath.php, line 31

Namespace

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

  /**
   * An alias manager to find the alias for the current system path.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * The instantiated Cache backend.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cacheConfig;

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

  /**
   * The current path.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $currentPath;

  /**
   * The Drupal messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The path validator.
   *
   * @var \Drupal\Core\Path\PathValidatorInterface
   */
  protected $pathValidator;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The route builder service.
   *
   * @var \Drupal\Core\Routing\RouteBuilderInterface
   */
  protected $routeBuilder;

  /**
   * Constructs a LanguageSelectionPageConditionPath plugin.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   The alias manager.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Path\CurrentPathStack $current_path
   *   The current path.
   * @param \Drupal\Core\Routing\RouteBuilderInterface $route_builder
   *   The route builder service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_config
   *   A cache backend used to store configuration.
   * @param \Drupal\Core\Path\PathValidatorInterface $path_validator
   *   The path validator.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The drupal messenger.
   * @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(ConfigFactoryInterface $config_factory, AliasManagerInterface $alias_manager, RequestStack $request_stack, CurrentPathStack $current_path, RouteBuilderInterface $route_builder, CacheBackendInterface $cache_config, PathValidatorInterface $path_validator, MessengerInterface $messenger, array $configuration, $plugin_id, array $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
    $this->aliasManager = $alias_manager;
    $this->requestStack = $request_stack;
    $this->currentPath = $current_path;
    $this->routeBuilder = $route_builder;
    $this->cacheConfig = $cache_config;
    $this->pathValidator = $path_validator;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $form[$this
      ->getPluginId()] = [
      '#type' => 'textfield',
      '#default_value' => $this->configuration[$this
        ->getPluginId()],
      '#description' => t('The path of the page displaying the Language Selection Page'),
      '#required' => TRUE,
      '#size' => 40,
      '#field_prefix' => $base_url,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('config.factory'), $container
      ->get('path_alias.manager'), $container
      ->get('request_stack'), $container
      ->get('path.current'), $container
      ->get('router.builder'), $container
      ->get('cache.config'), $container
      ->get('path.validator'), $container
      ->get('messenger'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $configuration = $this
      ->getConfiguration();
    $configuration_lsp = $this->configFactory
      ->getEditable('language_selection_page.negotiation');
    $system_site = $this->configFactory
      ->getEditable('system.site');
    if ($configuration['path'] === $system_site
      ->get('page.front')) {
      $configuration_lsp
        ->set('path', '/language_selection_page')
        ->save();
      $system_site
        ->set('page.front', '/node')
        ->save();
      $this->messenger
        ->addError($this
        ->t('The Language Selection Page cannot be used as frontpage. To avoid infinite redirect loops, the language selection page path has been reset to <strong>/language_selection_page</strong> and the default frontpage setting has been reset to <strong>/node</strong>.'));
      return $this
        ->block();
    }
    $current_path = $this->currentPath
      ->getPath($this->requestStack
      ->getCurrentRequest());
    $alias = $this->aliasManager
      ->getAliasByPath($current_path);
    foreach ([
      $current_path,
      $alias,
    ] as $path) {
      if ($path === $configuration[$this
        ->getPluginId()]) {
        return $this
          ->block();
      }
    }
    return $this
      ->pass();
  }

  /**
   * {@inheritdoc}
   */
  public function postConfigSave(array &$form, FormStateInterface $form_state) {
    $this->routeBuilder
      ->rebuildIfNeeded();
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Flush only if there is a change in the path.
    if ($this->configuration[$this
      ->getPluginId()] !== $form_state
      ->getValue($this
      ->getPluginId())) {
      $this->routeBuilder
        ->setRebuildNeeded();
    }
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $configuration_lsp = $this->configFactory
      ->getEditable('language_selection_page.negotiation');

    // Check for empty path.
    if ($form_state
      ->isValueEmpty($this
      ->getPluginId())) {

      // Set to default "/language_selection_page".
      $form_state
        ->setValueForElement($form['conditions'][$this
        ->getPluginId()], '/language_selection_page');
    }
    else {
      $form_state
        ->setValueForElement($form['conditions'][$this
        ->getPluginId()], $this->aliasManager
        ->getPathByAlias($form_state
        ->getValue($this
        ->getPluginId())));
    }

    // Validate path.
    if (($value = $form_state
      ->getValue($this
      ->getPluginId())) && $value[0] !== '/') {
      $form_state
        ->setErrorByName($this
        ->getPluginId(), $this
        ->t("The path '%path' has to start with a slash.", [
        '%path' => $form_state
          ->getValue($this
          ->getPluginId()),
      ]));
    }

    // Check if the path already exists.
    if ($this->pathValidator
      ->isValid($form_state
      ->getValue($this
      ->getPluginId())) && $form_state
      ->getValue($this
      ->getPluginId()) !== $configuration_lsp
      ->get('path')) {
      $form_state
        ->setErrorByName($this
        ->getPluginId(), $this
        ->t("The path '%path' is invalid.", [
        '%path' => $form_state
          ->getValue($this
          ->getPluginId()),
      ]));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
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
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::alterPageContent public function Alter the $content render array used to build the LSP page. Overrides LanguageSelectionPageConditionInterface::alterPageContent 2
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::setWeight public function Set the weight of the plugin. Overrides LanguageSelectionPageConditionInterface::setWeight
LanguageSelectionPageConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
LanguageSelectionPageConditionPath::$aliasManager protected property An alias manager to find the alias for the current system path.
LanguageSelectionPageConditionPath::$cacheConfig protected property The instantiated Cache backend.
LanguageSelectionPageConditionPath::$configFactory protected property The configuration factory.
LanguageSelectionPageConditionPath::$currentPath protected property The current path.
LanguageSelectionPageConditionPath::$messenger protected property The Drupal messenger.
LanguageSelectionPageConditionPath::$pathValidator protected property The path validator.
LanguageSelectionPageConditionPath::$requestStack protected property The request stack.
LanguageSelectionPageConditionPath::$routeBuilder protected property The route builder service.
LanguageSelectionPageConditionPath::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
LanguageSelectionPageConditionPath::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LanguageSelectionPageConditionPath::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides LanguageSelectionPageConditionBase::evaluate
LanguageSelectionPageConditionPath::postConfigSave public function Post config save method. Overrides LanguageSelectionPageConditionBase::postConfigSave
LanguageSelectionPageConditionPath::submitConfigurationForm public function Form submission handler. Overrides LanguageSelectionPageConditionBase::submitConfigurationForm
LanguageSelectionPageConditionPath::validateConfigurationForm public function Form validation handler. Overrides ConditionPluginBase::validateConfigurationForm
LanguageSelectionPageConditionPath::__construct public function Constructs a LanguageSelectionPageConditionPath 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