interface WebformSourceEntityInterface in Webform 8.5

Interface of a webform source entity plugin.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\webform\Plugin\WebformSourceEntityInterface

2 files declare their use of WebformSourceEntityInterface

QueryStringWebformSourceEntity.php in src/Plugin/WebformSourceEntity/QueryStringWebformSourceEntity.php

RouteParametersWebformSourceEntity.php in src/Plugin/WebformSourceEntity/RouteParametersWebformSourceEntity.php

File

src/Plugin/WebformSourceEntityInterface.php, line 10

Namespace

Drupal\webform\Plugin

interface WebformSourceEntityInterface extends PluginInspectionInterface {

  /**
   * Detect and return a source entity from current context.
   *
   * @param string[] $ignored_types
   *   Entity types that may not be used as a source entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   Source entity or NULL when no source entity is found.
   */
  public function getSourceEntity(array $ignored_types);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
WebformSourceEntityInterface::getSourceEntity	public	function	Detect and return a source entity from current context.	2