final class LanguageSelectionPageConditionBlacklistedPaths in Language Selection Page 8.2
Class for the Blacklisted paths condition plugin.
Plugin annotation
@LanguageSelectionPageCondition(
id="blacklisted_paths",
weight=-50,
name=@Translation("Blacklisted paths"),
description=@Translation("Ignore paths that are blacklisted."),
runInBlock=TRUE,
)
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\Executable\ExecutablePluginBase implements ExecutableInterface
- class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
- class \Drupal\language_selection_page\LanguageSelectionPageConditionBase implements ConditionInterface, ContainerFactoryPluginInterface, LanguageSelectionPageConditionInterface
- class \Drupal\language_selection_page\Plugin\LanguageSelectionPageCondition\LanguageSelectionPageConditionBlacklistedPaths implements LanguageSelectionPageConditionInterface
- class \Drupal\language_selection_page\LanguageSelectionPageConditionBase implements ConditionInterface, ContainerFactoryPluginInterface, LanguageSelectionPageConditionInterface
- class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
- class \Drupal\Core\Executable\ExecutablePluginBase implements ExecutableInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of LanguageSelectionPageConditionBlacklistedPaths
File
- src/
Plugin/ LanguageSelectionPageCondition/ LanguageSelectionPageConditionBlacklistedPaths.php, line 27
Namespace
Drupal\language_selection_page\Plugin\LanguageSelectionPageConditionView source
final class LanguageSelectionPageConditionBlacklistedPaths extends LanguageSelectionPageConditionBase implements LanguageSelectionPageConditionInterface {
/**
* An alias manager to find the alias for the current system path.
*
* @var \Drupal\path_alias\AliasManagerInterface
*/
protected $aliasManager;
/**
* The current path.
*
* @var \Drupal\Core\Path\CurrentPathStack
*/
protected $currentPath;
/**
* 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 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(AliasManagerInterface $alias_manager, PathMatcherInterface $path_matcher, RequestStack $request_stack, CurrentPathStack $current_path, array $configuration, $plugin_id, array $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->aliasManager = $alias_manager;
$this->pathMatcher = $path_matcher;
$this->requestStack = $request_stack;
$this->currentPath = $current_path;
}
/**
* {@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 language selection pages should be circumvented.') . '<br />' . $this
->t("Specify pages by using their paths. A path must start with <em>/</em>. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %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'), $configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public function evaluate() {
// 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 ((array) $this->configuration[$this
->getPluginId()] 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, '/');
$path_alias = mb_strtolower($this->aliasManager
->getAliasByPath($path));
$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())))));
}
}