class ExtraFieldForm in Extra Field 8.2

Defines a ExtraFieldForm item annotation object.

Hierarchy

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

See also

\Drupal\extra_field\Plugin\ExtraFieldFormManager

4 classes are annotated with ExtraFieldForm

CustomSubmit in modules/extra_field_example/src/Plugin/ExtraField/Form/CustomSubmit.php

Example Extra field form display.

ExampleCustomInput in modules/extra_field_example/src/Plugin/ExtraField/Form/ExampleCustomInput.php

Example Extra field form display.

ExampleMarkup in modules/extra_field_example/src/Plugin/ExtraField/Form/ExampleMarkup.php

Example Extra field form display.

SingleItemTest in tests/extra_field_test/src/Plugin/ExtraField/Form/SingleItemTest.php

Single item extra field form plugin.

File

src/Annotation/ExtraFieldForm.php, line 14

Namespace

Drupal\extra_field\Annotation

class ExtraFieldForm 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 description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * 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
ExtraFieldForm::$bundles	public	property	The entity + bundle combination(s) the plugin supports.
ExtraFieldForm::$description	public	property	The description of the plugin.
ExtraFieldForm::$id	public	property	The plugin ID.
ExtraFieldForm::$label	public	property	The label of the plugin.
ExtraFieldForm::$visible	public	property	Whether the field is visible by default.
ExtraFieldForm::$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