You are here

Home » API reference » Administration Language Negotiation 8 » Paths.php

class Paths in Administration Language Negotiation 8

Class for the Blacklisted paths condition plugin.

Plugin annotation


@AdministrationLanguageNegotiationCondition(
  id = "paths",
  weight = -50,
  name = @Translation("Paths"),
  description = @Translation("Returns particular language on configured paths.")
)

Hierarchy

Expanded class hierarchy of Paths

File

src/Plugin/AdministrationLanguageNegotiationCondition/Paths.php, line 28

Namespace

Drupal\administration_language_negotiation\Plugin\AdministrationLanguageNegotiationCondition
View source 
class Paths extends AdministrationLanguageNegotiationConditionBase implements AdministrationLanguageNegotiationConditionInterface {

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

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

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

  /**
   * The configurable language manager.
   *
   * @var Drupal\language\ConfigurableLanguageManager
   */
  protected $languageManager;

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

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

  /**
   * Constructs a RequestPath condition plugin.
   *
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   An alias manager to find the alias for the current system path.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   The path matcher service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Path\CurrentPathStack $current_path
   *   The current path.
   * @param \Drupal\Core\Config\ConfigFactory $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.
   * @param \Drupal\language\ConfigurableLanguageManager $language_manager
   *   The language manager.
   */
  public function __construct(AliasManagerInterface $alias_manager, PathMatcherInterface $path_matcher, RequestStack $request_stack, CurrentPathStack $current_path, ConfigFactory $config_factory, array $configuration, $plugin_id, array $plugin_definition, ConfigurableLanguageManager $language_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->aliasManager = $alias_manager;
    $this->pathMatcher = $path_matcher;
    $this->requestStack = $request_stack;
    $this->currentPath = $current_path;
    $this->configFactory = $config_factory;
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[$this
      ->getPluginId()] = [
      '#type' => 'textarea',
      '#default_value' => implode(PHP_EOL, (array) $this->configuration[$this
        ->getPluginId()]),
      '#size' => 10,
      '#description' => $this
        ->t('Specify on which paths the administration language negotiations should be circumvented.') . '<br />' . $this
        ->t("Specify pages by using their paths. A path must start with <em>/</em>.\n                          Enter one path per line. The '*' character is a wildcard.\n                          Example paths are %blog for the blog page and %blog-wildcard for every personal blog.\n                          %front is the front page.", [
        '%blog' => '/blog',
        '%blog-wildcard' => '/blog/*',
        '%front' => '<front>',
      ]),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function evaluate() {
    $langcode = $this->languageManager
      ->getCurrentLanguage()
      ->getId();
    $prefixes = $this->configFactory
      ->get('language.negotiation')
      ->get('url.prefixes');
    $admin_paths = array_filter($this->configuration[$this
      ->getPluginId()]);
    foreach ($admin_paths as $admin_path) {
      foreach ($prefixes as $prefix) {
        $admin_paths[] = '/' . $prefix . '/' . trim($admin_path, '/');
      }
    }

    // Check the path against a list of paths where that the module shouldn't
    // run on.
    // This list of paths is configurable on the admin page.
    foreach ($admin_paths as $blacklisted_path) {
      $request = $this->requestStack
        ->getCurrentRequest();

      // Compare the lowercase path alias (if any) and internal path.
      $path = $this->currentPath
        ->getPath($request);

      // Do not trim a trailing slash if that is the complete path.
      $path = $path === '/' ? $path : rtrim($path, '/');

      // Aliases have a language property that must be used to
      // search for a match on the current path alias, or the
      // default language will be used instead.
      $path_alias = mb_strtolower($this->aliasManager
        ->getAliasByPath($path, $langcode));
      $is_on_blacklisted_path = $this->pathMatcher
        ->matchPath($path_alias, $blacklisted_path) || $path !== $path_alias && $this->pathMatcher
        ->matchPath($path, $blacklisted_path);
      if ($is_on_blacklisted_path) {
        return $this
          ->block();
      }
    }
    return $this
      ->pass();
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $form_state
      ->setValue($this
      ->getPluginId(), array_filter(array_map('trim', explode(PHP_EOL, $form_state
      ->getValue($this
      ->getPluginId())))));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdministrationLanguageNegotiationConditionBase::$weight protected property The condition's weight, order of execution.
AdministrationLanguageNegotiationConditionBase::block public function Wrapper function that returns FALSE. Overrides AdministrationLanguageNegotiationConditionInterface::block
AdministrationLanguageNegotiationConditionBase::getDescription public function Returns the description of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getDescription
AdministrationLanguageNegotiationConditionBase::getName public function Returns the name of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getName
AdministrationLanguageNegotiationConditionBase::getWeight public function Returns the weight of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::getWeight
AdministrationLanguageNegotiationConditionBase::pass public function Wrapper function that returns FALSE. Overrides AdministrationLanguageNegotiationConditionInterface::pass
AdministrationLanguageNegotiationConditionBase::postConfigSave public function Post config save method. Overrides AdministrationLanguageNegotiationConditionInterface::postConfigSave
AdministrationLanguageNegotiationConditionBase::setWeight public function Set the weight of the plugin. Overrides AdministrationLanguageNegotiationConditionInterface::setWeight
AdministrationLanguageNegotiationConditionBase::submitConfigurationForm public function Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
AdministrationLanguageNegotiationConditionBase::summary public function Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
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.
Paths::$aliasManager protected property An alias manager to find the alias for the current system path.
Paths::$configFactory protected property The config factory.
Paths::$currentPath protected property The current path.
Paths::$languageManager protected property The configurable language manager.
Paths::$pathMatcher protected property The path matcher.
Paths::$requestStack protected property The request stack.
Paths::buildConfigurationForm public function Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
Paths::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Paths::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides AdministrationLanguageNegotiationConditionBase::evaluate
Paths::validateConfigurationForm public function Form validation handler. Overrides ConditionPluginBase::validateConfigurationForm
Paths::__construct public function Constructs a RequestPath condition 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