class FormatterType in Custom Formatters 8.3

Defines a formatter type annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\custom_formatters\Annotation\FormatterType

4 classes are annotated with FormatterType

FormatterPreset in src/Plugin/CustomFormatters/FormatterType/FormatterPreset.php

Plugin implementation of the Formatter Preset Formatter type.

HTMLToken in src/Plugin/CustomFormatters/FormatterType/HTMLToken.php

Plugin implementation of the HTML + Token Formatter type.

PHP in src/Plugin/CustomFormatters/FormatterType/PHP.php

Plugin implementation of the PHP Formatter type.

Twig in src/Plugin/CustomFormatters/FormatterType/Twig.php

Plugin implementation of the Twig type.

File

src/Annotation/FormatterType.php, line 12

Namespace

Drupal\custom_formatters\Annotation

class FormatterType extends Plugin {

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

  /**
   * The formatter type plugin label.
   *
   * @var string
   */
  public $label;

  /**
   * A description of the formatter type.
   *
   * @var string
   */
  public $description;

  /**
   * Whether the formatter type plugin supports multiple fields.
   *
   * @var bool
   */
  public $multipleFields = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
FormatterType::$description	public	property	A description of the formatter type.
FormatterType::$id	public	property	The formatter type plugin ID.
FormatterType::$label	public	property	The formatter type plugin label.
FormatterType::$multipleFields	public	property	Whether the formatter type plugin supports multiple fields.
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