interface ConditionInterface in Access Filter 8

Provides an interface defining a filter condition.

Hierarchy

• interface \Drupal\access_filter\Plugin\ConditionInterface

1 file declares its use of ConditionInterface

ConditionBase.php in src/Plugin/AccessFilter/Condition/ConditionBase.php

File

src/Plugin/ConditionInterface.php, line 10

Namespace

Drupal\access_filter\Plugin

interface ConditionInterface {

  /**
   * Gets summary text for the condition.
   *
   * @return string
   *   A summary string.
   */
  public function summary();

  /**
   * Validates configuration data.
   *
   * @param array $configuration
   *   The array containing configurations.
   *
   * @return array
   *   An array of error messages.
   */
  public function validateConfiguration(array $configuration);

  /**
   * Checks the current access is matched to the condition.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A request instance.
   *
   * @return bool
   *   Boolean TRUE if condition is matched or FALSE otherwise.
   */
  public function isMatched(Request $request);

  /**
   * Determines whether condition result will be negated.
   *
   * @return bool
   *   Whether the condition result will be negated.
   */
  public function isNegated();

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionInterface::isMatched	public	function	Checks the current access is matched to the condition.	7
ConditionInterface::isNegated	public	function	Determines whether condition result will be negated.	1
ConditionInterface::summary	public	function	Gets summary text for the condition.	4
ConditionInterface::validateConfiguration	public	function	Validates configuration data.	4