class LanguageCookieConditionBlacklistedPaths in Language Cookie 8

Class for the Blacklisted paths condition plugin.

Plugin annotation


@LanguageCookieCondition(
  id = "blacklisted_paths",
  weight = -50,
  name = @Translation("Blacklisted paths"),
  description = @Translation("Ignore paths that are blacklisted.")
)

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_cookie\LanguageCookieConditionBase implements ContainerFactoryPluginInterface, LanguageCookieConditionInterface
    class \Drupal\language_cookie\Plugin\LanguageCookieCondition\LanguageCookieConditionBlacklistedPaths

Expanded class hierarchy of LanguageCookieConditionBlacklistedPaths

File

src/Plugin/LanguageCookieCondition/LanguageCookieConditionBlacklistedPaths.php, line 24

Namespace

Drupal\language_cookie\Plugin\LanguageCookieCondition

View source

class LanguageCookieConditionBlacklistedPaths extends LanguageCookieConditionBase {

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

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

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

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

  /**
   * 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 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 path 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, '/');

      // @todo get the right alias for the current language (pass along langcode), or alternatively, store the system path only, so we don't have to compare against aliases.
      $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 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 cookie 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 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())))));
  }

  /**
   * {@inheritdoc}
   */
  public function postConfigSave(Config $config, array &$form, FormStateInterface $form_state) {
    parent::postConfigSave($config, $form, $form_state);
    $config
      ->set('blacklisted_paths', $form_state
      ->getValue('blacklisted_paths'));
  }

}

Members

Name	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.
LanguageCookieConditionBase::$currentLanguage	protected	property	The current language.
LanguageCookieConditionBase::$weight	protected	property	The condition's weight, order of execution.
LanguageCookieConditionBase::block	public	function	Wrapper function that returns FALSE. Overrides LanguageCookieConditionInterface::block
LanguageCookieConditionBase::getCurrentLanguage	public	function	Get the current language. Overrides LanguageCookieConditionInterface::getCurrentLanguage
LanguageCookieConditionBase::getDescription	public	function	Returns the description of the plugin. Overrides LanguageCookieConditionInterface::getDescription
LanguageCookieConditionBase::getName	public	function	Returns the name of the plugin. Overrides LanguageCookieConditionInterface::getName
LanguageCookieConditionBase::getWeight	public	function	Returns the weight of the plugin. Overrides LanguageCookieConditionInterface::getWeight
LanguageCookieConditionBase::pass	public	function	Wrapper function that returns FALSE. Overrides LanguageCookieConditionInterface::pass
LanguageCookieConditionBase::setCurrentLanguage	public	function	Set the current language. Overrides LanguageCookieConditionInterface::setCurrentLanguage
LanguageCookieConditionBase::setWeight	public	function	Set the weight of the plugin. Overrides LanguageCookieConditionInterface::setWeight
LanguageCookieConditionBase::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
LanguageCookieConditionBase::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
LanguageCookieConditionBlacklistedPaths::$aliasManager	protected	property	An alias manager to find the alias for the current system path.
LanguageCookieConditionBlacklistedPaths::$currentPath	protected	property	The current path.
LanguageCookieConditionBlacklistedPaths::$pathMatcher	protected	property	The path matcher.
LanguageCookieConditionBlacklistedPaths::$requestStack	protected	property	The request stack.
LanguageCookieConditionBlacklistedPaths::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
LanguageCookieConditionBlacklistedPaths::create	public static	function	Creates an instance of the plugin. Overrides LanguageCookieConditionBase::create
LanguageCookieConditionBlacklistedPaths::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides LanguageCookieConditionBase::evaluate
LanguageCookieConditionBlacklistedPaths::postConfigSave	public	function	Post config save method. Overrides LanguageCookieConditionBase::postConfigSave
LanguageCookieConditionBlacklistedPaths::validateConfigurationForm	public	function	Form validation handler. Overrides ConditionPluginBase::validateConfigurationForm
LanguageCookieConditionBlacklistedPaths::__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

You are here

class LanguageCookieConditionBlacklistedPaths in Language Cookie 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation