class RequestPath in Drupal 9

Same name and namespace in other branches

8 core/modules/system/src/Plugin/Condition/RequestPath.php \Drupal\system\Plugin\Condition\RequestPath

Provides a 'Request Path' condition.

Plugin annotation


@Condition(
  id = "request_path",
  label = @Translation("Request Path"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Executable\ExecutablePluginBase implements CacheableDependencyInterface, ExecutableInterface, ContextAwarePluginInterface uses ContextAwarePluginTrait
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\system\Plugin\Condition\RequestPath implements ContainerFactoryPluginInterface

Expanded class hierarchy of RequestPath

File

core/modules/system/src/Plugin/Condition/RequestPath.php, line 22

Namespace

Drupal\system\Plugin\Condition

View source

class RequestPath extends ConditionPluginBase implements ContainerFactoryPluginInterface {

  /**
   * 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 defaultConfiguration() {
    return [
      'pages' => '',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['pages'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Pages'),
      '#default_value' => $this->configuration['pages'],
      '#description' => $this
        ->t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. An example path is %user-wildcard for every user page. %front is the front page.", [
        '%user-wildcard' => '/user/*',
        '%front' => '<front>',
      ]),
    ];
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['pages'] = $form_state
      ->getValue('pages');
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    if (empty($this->configuration['pages'])) {
      return $this
        ->t('No page is specified');
    }
    $pages = array_map('trim', explode("\n", $this->configuration['pages']));
    $pages = implode(', ', $pages);
    if (!empty($this->configuration['negate'])) {
      return $this
        ->t('Do not return true on the following pages: @pages', [
        '@pages' => $pages,
      ]);
    }
    return $this
      ->t('Return true on the following pages: @pages', [
      '@pages' => $pages,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function evaluate() {

    // Convert path to lowercase. This allows comparison of the same path
    // with different case. Ex: /Page, /page, /PAGE.
    $pages = mb_strtolower($this->configuration['pages']);
    if (!$pages) {
      return TRUE;
    }
    $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));
    return $this->pathMatcher
      ->matchPath($path_alias, $pages) || $path != $path_alias && $this->pathMatcher
      ->matchPath($path, $pages);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    $contexts = parent::getCacheContexts();
    $contexts[] = 'url.path';
    return $contexts;
  }

}

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::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.
ContextAwarePluginTrait::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig	protected	property	Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheMaxAge	public	function		7
ContextAwarePluginTrait::getCacheTags	public	function		4
ContextAwarePluginTrait::getContext	public	function
ContextAwarePluginTrait::getContextDefinition	public	function
ContextAwarePluginTrait::getContextDefinitions	public	function
ContextAwarePluginTrait::getContextMapping	public	function
ContextAwarePluginTrait::getContexts	public	function
ContextAwarePluginTrait::getContextValue	public	function
ContextAwarePluginTrait::getContextValues	public	function
ContextAwarePluginTrait::getPluginDefinition	abstract protected	function		1
ContextAwarePluginTrait::setContext	public	function		1
ContextAwarePluginTrait::setContextMapping	public	function
ContextAwarePluginTrait::setContextValue	public	function
ContextAwarePluginTrait::validateContexts	public	function
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RequestPath::$aliasManager	protected	property	An alias manager to find the alias for the current system path.
RequestPath::$currentPath	protected	property	The current path.
RequestPath::$pathMatcher	protected	property	The path matcher.
RequestPath::$requestStack	protected	property	The request stack.
RequestPath::buildConfigurationForm	public	function	Form constructor. Overrides ConditionPluginBase::buildConfigurationForm
RequestPath::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RequestPath::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConditionPluginBase::defaultConfiguration
RequestPath::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate
RequestPath::getCacheContexts	public	function	Overrides ContextAwarePluginTrait::getCacheContexts
RequestPath::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionPluginBase::submitConfigurationForm
RequestPath::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ConditionInterface::summary
RequestPath::__construct	public	function	Constructs a RequestPath condition plugin. Overrides ConditionPluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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

You are here

class RequestPath in Drupal 9

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation