class DataFilter in Typed Data API enhancements 8

Annotation class for data filter plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\typed_data\Annotation\DataFilter

1 file declares its use of DataFilter

DataFilterManager.php in src/DataFilterManager.php

6 classes are annotated with DataFilter

DefaultFilter in src/Plugin/TypedDataFilter/DefaultFilter.php

A data filter providing a default value if no value is set.

EntityUrlFilter in src/Plugin/TypedDataFilter/EntityUrlFilter.php

A data filter that provides the URL of an entity.

FormatDateFilter in src/Plugin/TypedDataFilter/FormatDateFilter.php

A data filter for formatting dates.

FormatTextFilter in src/Plugin/TypedDataFilter/FormatTextFilter.php

A data filter which marks string data as sanitized.

LowerFilter in src/Plugin/TypedDataFilter/LowerFilter.php

A data filter lowering all string characters.

... See full list

File

src/Annotation/DataFilter.php, line 12

Namespace

Drupal\typed_data\Annotation

class DataFilter extends Plugin {

  /**
   * The machine-name of the data filter.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the filter.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
DataFilter::$id	public	property	The machine-name of the data filter.
DataFilter::$label	public	property	The human-readable name of the filter.
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