class FacetApiAutocompleteController in Select 2 8

Defines a route controller for facets autocomplete form elements.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\select2_facets\Controller\FacetApiAutocompleteController

Expanded class hierarchy of FacetApiAutocompleteController

File

modules/select2_facets/src/Controller/FacetApiAutocompleteController.php, line 21

Namespace

Drupal\select2_facets\Controller

View source

class FacetApiAutocompleteController extends ControllerBase {

  /**
   * The facet manager service.
   *
   * @var \Drupal\facets\FacetManager\DefaultFacetManager
   */
  protected $facetManager;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The current path stack.
   *
   * @var \Drupal\Core\Path\CurrentPathStack
   */
  protected $currentPathStack;

  /**
   * The current router.
   *
   * @var \Drupal\Core\Routing\AccessAwareRouterInterface
   */
  protected $router;

  /**
   * The processor manager.
   *
   * @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
   */
  protected $pathProcessor;

  /**
   * Array of request.
   *
   * @var array
   */
  protected $storedRequests = [];

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $controller = parent::create($container);
    $controller
      ->setFacetManager($container
      ->get('facets.manager'));
    $controller
      ->setRequestStack($container
      ->get('request_stack'));
    $controller
      ->setCurrentPathStack($container
      ->get('path.current'));
    $controller
      ->setRouter($container
      ->get('router'));
    $controller
      ->setPathProcessor($container
      ->get('path_processor_manager'));
    return $controller;
  }

  /**
   * Set the facet manager service.
   *
   * @param \Drupal\facets\FacetManager\DefaultFacetManager $facetManager
   *   The facet manager.
   */
  protected function setFacetManager(DefaultFacetManager $facetManager) {
    $this->facetManager = $facetManager;
  }

  /**
   * Set the request stack.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack object.
   */
  protected function setRequestStack(RequestStack $requestStack) {
    $this->requestStack = $requestStack;
  }

  /**
   * Set the current path stack.
   *
   * @param \Drupal\Core\Path\CurrentPathStack $currentPathStack
   *   Current path stack object.
   */
  protected function setCurrentPathStack(CurrentPathStack $currentPathStack) {
    $this->currentPathStack = $currentPathStack;
  }

  /**
   * Set the router.
   *
   * @param \Drupal\Core\Routing\AccessAwareRouterInterface $router
   *   The router object.
   */
  protected function setRouter(AccessAwareRouterInterface $router) {
    $this->router = $router;
  }

  /**
   * Set the path processor service.
   *
   * @param \Drupal\Core\PathProcessor\InboundPathProcessorInterface $pathProcessor
   *   The path processor service object.
   */
  protected function setPathProcessor(InboundPathProcessorInterface $pathProcessor) {
    $this->pathProcessor = $pathProcessor;
  }

  /**
   * Autocomplete the label of an entity.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object that contains the typed tags.
   * @param string $facetsource_id
   *   The ID of the facet source.
   * @param string $facet_id
   *   The ID of the facet.
   * @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.
   *
   * @throws \Drupal\facets\Exception\InvalidProcessorException
   */
  public function handleAutocomplete(Request $request, $facetsource_id, $facet_id, $selection_settings_key) {
    $matches['results'] = [];

    // Get the typed string from the URL, if it exists.
    if ($input = $request->query
      ->get('q')) {
      $typed_string = mb_strtolower($input);

      // Selection settings are passed in as a hashed key of a serialized array
      // stored in the key/value store.
      $selection_settings = $this
        ->keyValue('entity_autocomplete')
        ->get($selection_settings_key, FALSE);
      if ($selection_settings !== FALSE) {
        $selection_settings_hash = Crypt::hmacBase64(serialize($selection_settings) . $facetsource_id . $facet_id, 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();
      }
      $new_request = $this
        ->createRequestFromPath($selection_settings['path']);
      $request->attributes
        ->add($this->router
        ->matchRequest($new_request));
      $this
        ->overwriteRequestStack($new_request);
      $facets = $this->facetManager
        ->getFacetsByFacetSourceId($facetsource_id);
      foreach ($facets as $facet) {
        if ($facet
          ->id() != $facet_id) {
          continue;
        }
        $this->facetManager
          ->build($facet);
        foreach ($facet
          ->getResults() as $result) {
          $display_value = mb_strtolower($result
            ->getDisplayValue());
          if ($selection_settings['match_operator'] == 'CONTAINS' && strpos($display_value, $typed_string) === FALSE || $selection_settings['match_operator'] == 'STARTS_WITH' && strpos($display_value, $typed_string) !== 0) {
            continue;
          }
          $matches['results'][] = [
            'id' => $result
              ->getUrl()
              ->toString(),
            'text' => $selection_settings['show_numbers'] ? sprintf('%s (%d)', $result
              ->getDisplayValue(), $result
              ->getCount()) : $result
              ->getDisplayValue(),
          ];
        }
      }
      $this
        ->restoreRequestStack();
    }
    return new JsonResponse($matches);
  }

  /**
   * Creates a new request object from a path.
   *
   * @param string $path
   *   A path with facet arguments.
   *
   * @return \Symfony\Component\HttpFoundation\Request
   *   A new request object.
   */
  protected function createRequestFromPath($path) {
    $new_request = Request::create($path);
    $processed = $this->pathProcessor
      ->processInbound($path, $new_request);
    $this->currentPathStack
      ->setPath($processed);
    return $new_request;
  }

  /**
   * Resets the request stack and adds one request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The one and only request.
   */
  protected function overwriteRequestStack(Request $request) {
    while ($this->requestStack
      ->getCurrentRequest()) {
      $this->storedRequests[] = $this->requestStack
        ->pop();
    }
    $this->requestStack
      ->push($request);
  }

  /**
   * Restore all saved requests on the stack.
   */
  protected function restoreRequestStack() {
    $this->requestStack
      ->pop();
    foreach ($this->storedRequests as $request) {
      $this->requestStack
        ->push($request);
    }
  }

}

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::$entityManager	protected	property	The entity manager.
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::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
FacetApiAutocompleteController::$currentPathStack	protected	property	The current path stack.
FacetApiAutocompleteController::$facetManager	protected	property	The facet manager service.
FacetApiAutocompleteController::$pathProcessor	protected	property	The processor manager.
FacetApiAutocompleteController::$requestStack	protected	property	The request stack.
FacetApiAutocompleteController::$router	protected	property	The current router.
FacetApiAutocompleteController::$storedRequests	protected	property	Array of request.
FacetApiAutocompleteController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
FacetApiAutocompleteController::createRequestFromPath	protected	function	Creates a new request object from a path.
FacetApiAutocompleteController::handleAutocomplete	public	function	Autocomplete the label of an entity.
FacetApiAutocompleteController::overwriteRequestStack	protected	function	Resets the request stack and adds one request.
FacetApiAutocompleteController::restoreRequestStack	protected	function	Restore all saved requests on the stack.
FacetApiAutocompleteController::setCurrentPathStack	protected	function	Set the current path stack.
FacetApiAutocompleteController::setFacetManager	protected	function	Set the facet manager service.
FacetApiAutocompleteController::setPathProcessor	protected	function	Set the path processor service.
FacetApiAutocompleteController::setRequestStack	protected	function	Set the request stack.
FacetApiAutocompleteController::setRouter	protected	function	Set the router.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator 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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class FacetApiAutocompleteController in Select 2 8

Hierarchy

File

Namespace

Members

API Navigation