class FormatterExtras in Custom Formatters 8.3

Defines a formatter extras annotation object.

Hierarchy

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

1 class is annotated with FormatterExtras

Contextual in src/Plugin/CustomFormatters/FormatterExtras/Contextual.php

Contextual links optional integration plugin.

File

src/Annotation/FormatterExtras.php, line 12

Namespace

Drupal\custom_formatters\Annotation

class FormatterExtras extends Plugin {

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

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

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

  /**
   * A boolean flag determining if the extra is optional.
   *
   * @var bool
   */
  public $optional = TRUE;

  /**
   * A keyed array of dependencies.
   *
   * @var array
   */
  public $dependencies;

}

Members

Name	Modifiers	Type	Description	Overrides
FormatterExtras::$dependencies	public	property	A keyed array of dependencies.
FormatterExtras::$description	public	property	A description of the formatter extra.
FormatterExtras::$id	public	property	The formatter extra plugin ID.
FormatterExtras::$label	public	property	The formatter extra plugin label.
FormatterExtras::$optional	public	property	A boolean flag determining if the extra is optional.
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