class ExtraFieldDisplay in Extra Field 8

Defines a ExtraFieldDisplay item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\extra_field\Annotation\ExtraFieldDisplay

See also

\Drupal\extra_field\Plugin\ExtraFieldDisplayManager

11 classes are annotated with ExtraFieldDisplay

AllNodeTypesTest in tests/extra_field_test/src/Plugin/ExtraField/Display/AllNodeTypesTest.php

Extra field Display for all node types.

EmptyFormattedFieldTest in tests/extra_field_test/src/Plugin/ExtraField/Display/EmptyFormattedFieldTest.php

Extra field Display for a field without content.

ExampleAllNodes in modules/extra_field_example/src/Plugin/ExtraField/Display/ExampleAllNodes.php

Example Extra field Display.

ExampleArticle in modules/extra_field_example/src/Plugin/ExtraField/Display/ExampleArticle.php

Example Extra field Display.

ExampleFormattedField in modules/extra_field_example/src/Plugin/ExtraField/Display/ExampleFormattedField.php

Example Extra field with formatted output.

... See full list

File

src/Annotation/ExtraFieldDisplay.php, line 14

Namespace

Drupal\extra_field\Annotation

class ExtraFieldDisplay 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 entity + bundle combination(s) the plugin supports.
   *
   * Format: [entity].[bundle] for specific entity-bundle combinations or
   * [entity].* for all bundles of the entity.
   *
   * @var string[]
   */
  public $bundles = [];

  /**
   * The default weight of the field.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * Whether the field is visible by default.
   *
   * @var bool
   */
  public $visible = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
ExtraFieldDisplay::$bundles	public	property	The entity + bundle combination(s) the plugin supports.
ExtraFieldDisplay::$id	public	property	The plugin ID.
ExtraFieldDisplay::$label	public	property	The label of the plugin.
ExtraFieldDisplay::$visible	public	property	Whether the field is visible by default.
ExtraFieldDisplay::$weight	public	property	The default weight of the field.
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