class FormElement in Flexiform 8

Defines a flexiform form entity plugin annotation object.

Plugin Namespace: Plugin\FormElement.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\flexiform\Annotation\FormElement

See also

\Drupal\flexiform\FormElementInterface

\Drupal\flexiform\FormElementBase

1 class is annotated with FormElement

AccountInfo in src/Plugin/FormElement/AccountInfo.php

Form element class for user accounts.

File

src/Annotation/FormElement.php, line 19

Namespace

Drupal\flexiform\Annotation

class FormElement extends Plugin {

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

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

  /**
   * The name of the module providing the element.
   *
   * @var string
   */
  public $module;

  /**
   * An array of context definitions describing the context used by the plugin.
   *
   * The array is keyed by context names.
   *
   * @var \Drupal\Core\Annotation\ContextDefinition[]
   */
  public $context = [];

}

Members

Name	Modifiers	Type	Description	Overrides
FormElement::$context	public	property	An array of context definitions describing the context used by the plugin.
FormElement::$id	public	property	The form element plugin id.
FormElement::$label	public	property	The human-readable name of the form element.
FormElement::$module	public	property	The name of the module providing the element.
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