interface RuleInterface in Access Filter 8

Provides an interface defining a filter rule.

Hierarchy

• interface \Drupal\access_filter\Plugin\RuleInterface

1 file declares its use of RuleInterface

IpRule.php in src/Plugin/AccessFilter/Rule/IpRule.php

File

src/Plugin/RuleInterface.php, line 10

Namespace

Drupal\access_filter\Plugin

interface RuleInterface {

  /**
   * Gets summary text for the rule.
   *
   * @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 by the rule.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A request instance.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function check(Request $request);

}

Members

Name	Modifiers	Type	Description	Overrides
RuleInterface::check	public	function	Checks the current access by the rule.	1
RuleInterface::summary	public	function	Gets summary text for the rule.	1
RuleInterface::validateConfiguration	public	function	Validates configuration data.	1