class WebformSourceEntity in Webform 8.5

Defines a webform source entity annotation object.

Plugin Namespace: Plugin\WebformSourceEntity.

For a working example, see \Drupal\webform\Plugin\WebformSourceEntity\QueryStringWebformSourceEntity

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\webform\Annotation\WebformSourceEntity

See also

hook_webform_source_entity_info()

\Drupal\webform\Plugin\WebformSourceEntityInterface

\Drupal\webform\Plugin\WebformSourceEntityManager

\Drupal\webform\Plugin\WebformSourceEntityManagerInterface

Plugin API

2 classes are annotated with WebformSourceEntity

QueryStringWebformSourceEntity in src/Plugin/WebformSourceEntity/QueryStringWebformSourceEntity.php

Detect source entity by examining query string.

RouteParametersWebformSourceEntity in src/Plugin/WebformSourceEntity/RouteParametersWebformSourceEntity.php

Detect source entity by examining route parameters.

File

src/Annotation/WebformSourceEntity.php, line 23

Namespace

Drupal\webform\Annotation

class WebformSourceEntity extends Plugin {

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

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

  /**
   * A brief description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * Weight (priority) of the plugin.
   *
   * @var int
   */
  public $weight = 0;

  /**
   * The element's module dependencies.
   *
   * @var array
   *
   * @see webform_webform_element_info_alter()
   */
  public $dependencies = [];

}

Members

Name	Modifiers	Type	Description	Overrides
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
WebformSourceEntity::$dependencies	public	property	The element's module dependencies.
WebformSourceEntity::$description	public	property	A brief description of the plugin.
WebformSourceEntity::$id	public	property	The plugin ID.
WebformSourceEntity::$label	public	property	The human-readable name of the plugin.
WebformSourceEntity::$weight	public	property	Weight (priority) of the plugin.