class AccessFilterRule in Access Filter 8

Defines a Plugin annotation object for access_filter rule plugins.

Plugin Namespace: Plugin\AccessFilter\Rule.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\access_filter\Annotation\AccessFilterRule

See also

\Drupal\access_filter\Plugin\AccessFilterPluginManager

\Drupal\access_filter\Plugin\RuleInterface

Plugin API

1 class is annotated with AccessFilterRule

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

Filter rule using IP address.

File

src/Annotation/AccessFilterRule.php, line 18

Namespace

Drupal\access_filter\Annotation

class AccessFilterRule extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The title of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * The example snippets for the plugin.
   *
   * @var array
   */
  public $examples;

}

Members

Name	Modifiers	Type	Description	Overrides
AccessFilterRule::$description	public	property	The description of the plugin.
AccessFilterRule::$examples	public	property	The example snippets for the plugin.
AccessFilterRule::$id	public	property	The plugin ID.
AccessFilterRule::$title	public	property	The title of the plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2