class RouteParametersWebformSourceEntity in Webform 8.5
Same name and namespace in other branches
- 6.x src/Plugin/WebformSourceEntity/RouteParametersWebformSourceEntity.php \Drupal\webform\Plugin\WebformSourceEntity\RouteParametersWebformSourceEntity
Detect source entity by examining route parameters.
Plugin annotation
@WebformSourceEntity(
id = "route_parameters",
label = @Translation("Route parameters"),
weight = 100
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\webform\Plugin\WebformSourceEntity\RouteParametersWebformSourceEntity implements ContainerFactoryPluginInterface, WebformSourceEntityInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of RouteParametersWebformSourceEntity
1 file declares its use of RouteParametersWebformSourceEntity
- RouteParametersWebformSourceEntityTest.php in tests/
src/ Unit/ Plugin/ WebformSourceEntity/ RouteParametersWebformSourceEntityTest.php
File
- src/
Plugin/ WebformSourceEntity/ RouteParametersWebformSourceEntity.php, line 21
Namespace
Drupal\webform\Plugin\WebformSourceEntityView source
class RouteParametersWebformSourceEntity extends PluginBase implements WebformSourceEntityInterface, ContainerFactoryPluginInterface {
/**
* Current route match service.
*
* @var \Drupal\Core\Routing\RouteMatchInterface
*/
protected $routeMatch;
/**
* RouteParametersWebformSourceEntity constructor.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The "current_route_match" service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->routeMatch = $route_match;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('current_route_match'));
}
/**
* {@inheritdoc}
*/
public function getSourceEntity(array $ignored_types) {
// Use current account when viewing a user's submissions.
// @see \Drupal\webform\WebformSubmissionListBuilder
if ($this->routeMatch
->getRouteName() === 'entity.webform_submission.user') {
return NULL;
}
// Get the most specific source entity available in the current route's
// parameters.
$parameters = $this->routeMatch
->getParameters()
->all();
$parameters = array_reverse($parameters);
if (!empty($ignored_types)) {
$parameters = array_diff_key($parameters, array_flip($ignored_types));
}
foreach ($parameters as $value) {
if ($value instanceof EntityInterface) {
return $value;
}
}
return NULL;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
RouteParametersWebformSourceEntity:: |
protected | property | Current route match service. | |
RouteParametersWebformSourceEntity:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
RouteParametersWebformSourceEntity:: |
public | function |
Detect and return a source entity from current context. Overrides WebformSourceEntityInterface:: |
|
RouteParametersWebformSourceEntity:: |
public | function |
RouteParametersWebformSourceEntity constructor. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |