You are here

class RouteParametersWebformSourceEntity in Webform 8.5

Same name and namespace in other branches
  1. 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

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\WebformSourceEntity
View 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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
RouteParametersWebformSourceEntity::$routeMatch protected property Current route match service.
RouteParametersWebformSourceEntity::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RouteParametersWebformSourceEntity::getSourceEntity public function Detect and return a source entity from current context. Overrides WebformSourceEntityInterface::getSourceEntity
RouteParametersWebformSourceEntity::__construct public function RouteParametersWebformSourceEntity constructor. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.