class WebformSubmissionsController in Webform 6.x

Provides route responses for Webform submissions.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\webform\Controller\WebformSubmissionsController

File

src/Controller/WebformSubmissionsController.php, line 15

Namespace

Drupal\webform\Controller

class WebformSubmissionsController extends ControllerBase {

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->entityRepository = $container
      ->get('entity.repository');
    return $instance;
  }

  /**
   * Returns response for the source entity autocompletion.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request object containing the search string.
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   A JSON response containing the autocomplete suggestions.
   */
  public function sourceEntityAutocomplete(Request $request, WebformInterface $webform) {
    $match = $request->query
      ->get('q');
    $webform_submission_storage = $this
      ->entityTypeManager()
      ->getStorage('webform_submission');
    $source_entities = $webform_submission_storage
      ->getSourceEntities($webform);
    $matches = [];

    // @see \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection::buildEntityQuery
    foreach ($source_entities as $source_entity_type => $source_entity_ids) {
      $definition = $this
        ->entityTypeManager()
        ->getDefinition($source_entity_type);
      $storage = $this
        ->entityTypeManager()
        ->getStorage($source_entity_type);
      if (empty($definition
        ->getKey('id')) || empty($definition
        ->getKey('label'))) {
        continue;
      }
      $query = $storage
        ->getQuery();
      $query
        ->range(0, 10);
      $query
        ->condition($definition
        ->getKey('id'), $source_entity_ids, 'IN');
      $query
        ->condition($query
        ->orConditionGroup()
        ->condition($definition
        ->getKey('label'), $match, 'CONTAINS')
        ->condition($definition
        ->getKey('id'), $match, 'CONTAINS'));
      $query
        ->addTag($source_entity_type . '_access');
      $entity_ids = $query
        ->execute();
      $entities = $storage
        ->loadMultiple($entity_ids);
      foreach ($entities as $source_entity_id => $source_entity) {
        $label = Html::escape($this->entityRepository
          ->getTranslationFromContext($source_entity)
          ->label());
        $value = "{$label} ({$source_entity_type}:{$source_entity_id})";
        $matches[] = [
          'value' => $value,
          'label' => $label,
        ];
        if (count($matches) === 10) {
          new JsonResponse($matches);
        }
      }
    }
    return new JsonResponse($matches);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
WebformSubmissionsController::$entityRepository	protected	property	The entity repository.
WebformSubmissionsController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
WebformSubmissionsController::sourceEntityAutocomplete	public	function	Returns response for the source entity autocompletion.