class PathCondition in Access Filter 8

Filter condition using drupal path.

Plugin annotation

@AccessFilterCondition(
  id = "path",
  description = @Translation("Drupal path."),
  examples = {
    "- { type: path, path: /foo/bar }",
    "- { type: path, path: '/\/foo\/(bar|baz)/i', regex: 1 }"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\access_filter\Plugin\AccessFilter\Condition\ConditionBase implements ConditionInterface, ContainerFactoryPluginInterface
      • class \Drupal\access_filter\Plugin\AccessFilter\Condition\PathCondition

File

src/Plugin/AccessFilter/Condition/PathCondition.php, line 21

Namespace

Drupal\access_filter\Plugin\AccessFilter\Condition

class PathCondition extends ConditionBase {

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

  /**
   * Creates a new PathCondition object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   The path matcher.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PathMatcherInterface $path_matcher) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->pathMatcher = $path_matcher;
  }

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

  /**
   * {@inheritdoc}
   */
  public function summary() {
    $regex = !empty($this->configuration['regex']) ? '<span class="regex">[Regex]</span>' : '';
    return $this->configuration['path'] . $regex;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfiguration(array $configuration) {
    $errors = [];
    if (!isset($configuration['path']) || !strlen($configuration['path'])) {
      $errors[] = $this
        ->t("'@property' is required.", [
        '@property' => 'path',
      ]);
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function isMatched(Request $request) {
    $path = $request
      ->getPathInfo();
    if (empty($this->configuration['regex'])) {
      return $this->pathMatcher
        ->matchPath($path, $this->configuration['path']);
    }
    else {
      return (bool) preg_match($this->configuration['path'], $path);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionBase::isNegated	public	function	Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PathCondition::$pathMatcher	protected	property	The path matcher.
PathCondition::create	public static	function	Creates an instance of the plugin. Overrides ConditionBase::create
PathCondition::isMatched	public	function	Checks the current access is matched to the condition. Overrides ConditionInterface::isMatched
PathCondition::summary	public	function	Gets summary text for the condition. Overrides ConditionInterface::summary
PathCondition::validateConfiguration	public	function	Validates configuration data. Overrides ConditionInterface::validateConfiguration
PathCondition::__construct	public	function	Creates a new PathCondition object. Overrides PluginBase::__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
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.