class ConfigFilter in Config Filter 8

Defines a Config filter plugin item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\config_filter\Annotation\ConfigFilter

See also

\Drupal\config_filter\Plugin\ConfigFilterPluginManager

Plugin API

2 classes are annotated with ConfigFilter

PirateFilter in tests/modules/config_filter_test/src/Plugin/ConfigFilter/PirateFilter.php

Provides a pirate filter that adds "Arrr" to the site name.

TestSplitFilter in tests/modules/config_filter_split_test/src/Plugin/ConfigFilter/TestSplitFilter.php

Provides a TestSplitFilter.

File

src/Annotation/ConfigFilter.php, line 15

Namespace

Drupal\config_filter\Annotation

class ConfigFilter extends Plugin {

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

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

  /**
   * The plugin weight.
   *
   * The higher the weight the later in the filter order the plugin will be.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * The status of the plugin.
   *
   * This is an easy way to turn off plugins.
   *
   * @var bool
   */
  public $status = TRUE;

  /**
   * The storages the plugin filters on.
   *
   * If it is left empty ['config.storage.sync'] will be assumed.
   * The only storage which is currently filtered is 'config.storage.sync'.
   *
   * @var string[]
   */
  public $storages = [];

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFilter::$id	public	property	The plugin ID.
ConfigFilter::$label	public	property	The label of the plugin.
ConfigFilter::$status	public	property	The status of the plugin.
ConfigFilter::$storages	public	property	The storages the plugin filters on.
ConfigFilter::$weight	public	property	The plugin weight.
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