class FieldGroupFormatter in Field Group 8

Defines a FieldGroupFormatter annotation object.

Formatters handle the display of fieldgroups.

Additional annotation keys for formatters can be defined in hook_field_group_formatter_info_alter().

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\field_group\Annotation\FieldGroupFormatter

See also

\Drupal\field_group\FieldGroupFormatterPluginManager

\Drupal\field_group\FieldGroupFormatterInterface

7 classes are annotated with FieldGroupFormatter

Accordion in src/Plugin/field_group/FieldGroupFormatter/Accordion.php

Plugin implementation of the 'accordion' formatter.

AccordionItem in src/Plugin/field_group/FieldGroupFormatter/AccordionItem.php

Plugin implementation of the 'accordion_item' formatter.

Details in src/Plugin/field_group/FieldGroupFormatter/Details.php

Details element.

Fieldset in src/Plugin/field_group/FieldGroupFormatter/Fieldset.php

Plugin implementation of the 'fieldset' formatter.

HtmlElement in src/Plugin/field_group/FieldGroupFormatter/HtmlElement.php

Plugin implementation of the 'html_element' formatter.

... See full list

File

src/Annotation/FieldGroupFormatter.php, line 22

Namespace

Drupal\field_group\Annotation

class FieldGroupFormatter extends Plugin {

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

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

  /**
   * A short description of the formatter type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The name of the fieldgroup formatter class.
   *
   * This is not provided manually, it will be added by the discovery mechanism.
   *
   * @var string
   */
  public $class;

  /**
   * An array of contexts the formatter supports (form / view).
   *
   * @var array
   */
  public $supported_contexts = array();

  /**
   * The different format types available for this formatter.
   *
   * @var array
   */
  public $format_types = array();

  /**
   * An integer to determine the weight of this formatter relative to other
   * formatter in the Field UI when selecting a formatter for a given group.
   *
   * @var int optional
   */
  public $weight = NULL;

}

Members

Name	Modifiers	Type	Description	Overrides
FieldGroupFormatter::$class	public	property	The name of the fieldgroup formatter class.
FieldGroupFormatter::$description	public	property	A short description of the formatter type.
FieldGroupFormatter::$format_types	public	property	The different format types available for this formatter.
FieldGroupFormatter::$id	public	property	The plugin ID.
FieldGroupFormatter::$label	public	property	The human-readable name of the formatter type.
FieldGroupFormatter::$supported_contexts	public	property	An array of contexts the formatter supports (form / view).
FieldGroupFormatter::$weight	public	property	An integer to determine the weight of this formatter relative to other formatter in the Field UI when selecting a formatter for a given group.
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