class EntityAutocompleteController

Same name in other branches
  1. 8.9.x core/modules/system/src/Controller/EntityAutocompleteController.php \Drupal\system\Controller\EntityAutocompleteController
  2. 10 core/modules/system/src/Controller/EntityAutocompleteController.php \Drupal\system\Controller\EntityAutocompleteController
  3. 11.x core/modules/system/src/Controller/EntityAutocompleteController.php \Drupal\system\Controller\EntityAutocompleteController

Defines a route controller for entity autocomplete form elements.

Hierarchy

Expanded class hierarchy of EntityAutocompleteController

1 file declares its use of EntityAutocompleteController
EntityAutocompleteTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityAutocompleteTest.php

File

core/modules/system/src/Controller/EntityAutocompleteController.php, line 19

Namespace

Drupal\system\Controller
View source
class EntityAutocompleteController extends ControllerBase {
    
    /**
     * The autocomplete matcher for entity references.
     *
     * @var \Drupal\Core\Entity\EntityAutocompleteMatcherInterface
     */
    protected $matcher;
    
    /**
     * The key value store.
     *
     * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface
     */
    protected $keyValue;
    
    /**
     * Constructs an EntityAutocompleteController object.
     *
     * @param \Drupal\Core\Entity\EntityAutocompleteMatcherInterface $matcher
     *   The autocomplete matcher for entity references.
     * @param \Drupal\Core\KeyValueStore\KeyValueStoreInterface $key_value
     *   The key value factory.
     */
    public function __construct(EntityAutocompleteMatcherInterface $matcher, KeyValueStoreInterface $key_value) {
        $this->matcher = $matcher;
        $this->keyValue = $key_value;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity.autocomplete_matcher'), $container->get('keyvalue')
            ->get('entity_autocomplete'));
    }
    
    /**
     * Autocomplete the label of an entity.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request object that contains the typed tags.
     * @param string $target_type
     *   The ID of the target entity type.
     * @param string $selection_handler
     *   The plugin ID of the entity reference selection handler.
     * @param string $selection_settings_key
     *   The hashed key of the key/value entry that holds the selection handler
     *   settings.
     *
     * @return \Symfony\Component\HttpFoundation\JsonResponse
     *   The matched entity labels as a JSON response.
     *
     * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
     *   Thrown if the selection settings key is not found in the key/value store
     *   or if it does not match the stored data.
     */
    public function handleAutocomplete(Request $request, $target_type, $selection_handler, $selection_settings_key) {
        $matches = [];
        // Get the typed string from the URL, if it exists.
        if ($input = $request->query
            ->get('q')) {
            $tag_list = Tags::explode($input);
            $typed_string = !empty($tag_list) ? mb_strtolower(array_pop($tag_list)) : '';
            // Selection settings are passed in as a hashed key of a serialized array
            // stored in the key/value store.
            $selection_settings = $this->keyValue
                ->get($selection_settings_key, FALSE);
            if ($selection_settings !== FALSE) {
                $selection_settings_hash = Crypt::hmacBase64(serialize($selection_settings) . $target_type . $selection_handler, Settings::getHashSalt());
                if (!hash_equals($selection_settings_hash, $selection_settings_key)) {
                    // Disallow access when the selection settings hash does not match the
                    // passed-in key.
                    throw new AccessDeniedHttpException('Invalid selection settings key.');
                }
            }
            else {
                // Disallow access when the selection settings key is not found in the
                // key/value store.
                throw new AccessDeniedHttpException();
            }
            $matches = $this->matcher
                ->getMatches($target_type, $selection_handler, $selection_settings, $typed_string);
        }
        return new JsonResponse($matches);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
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. 3
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. 1
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. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
EntityAutocompleteController::$keyValue protected property The key value store. Overrides ControllerBase::$keyValue
EntityAutocompleteController::$matcher protected property The autocomplete matcher for entity references.
EntityAutocompleteController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
EntityAutocompleteController::handleAutocomplete public function Autocomplete the label of an entity.
EntityAutocompleteController::__construct public function Constructs an EntityAutocompleteController object.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
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. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.