You are here

Home » API reference » Fast Autocomplete 8 » FacController.php

class FacController in Fast Autocomplete 8

Fast Autocomplete controller class.

@package Drupal\fac\Controller

Hierarchy

Expanded class hierarchy of FacController

File

src/Controller/FacController.php, line 24

Namespace

Drupal\fac\Controller
View source 
class FacController extends ControllerBase {

  /**
   * The search service.
   *
   * @var \Drupal\fac\SearchService
   */
  protected $searchService;

  /**
   * The hash service.
   *
   * @var \Drupal\fac\HashServiceInterface
   */
  protected $hashService;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $storage;

  /**
   * The language manager service.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The account switcher service.
   *
   * @var \Drupal\Core\Session\AccountSwitcherInterface
   */
  protected $accountSwitcher;

  /**
   * The logger service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $logger;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * {@inheritdoc}
   */
  public function __construct(SearchService $search_service, HashServiceInterface $hash_service, EntityTypeManagerInterface $storage, LanguageManagerInterface $language_manager, AccountSwitcherInterface $account_switcher, LoggerChannelFactoryInterface $logger_factory, FileSystemInterface $file_system) {
    $this->searchService = $search_service;
    $this->hashService = $hash_service;
    $this->storage = $storage;
    $this->languageManager = $language_manager;
    $this->accountSwitcher = $account_switcher;
    $this->logger = $logger_factory
      ->get('fac');
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('fac.search_service'), $container
      ->get('fac.hash_service'), $container
      ->get('entity_type.manager'), $container
      ->get('language_manager'), $container
      ->get('account_switcher'), $container
      ->get('logger.factory'), $container
      ->get('file_system'));
  }

  /**
   * Generates the Fast Autocomplete JSON for a search query.
   *
   * @param string $fac_config_id
   *   The Fast Autocomplete configuration entity id.
   * @param string $langcode
   *   The language code to generate the Json for.
   * @param string $hash
   *   The hash to check.
   * @param string $key
   *   The key to search with.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   */
  public function generateJson($fac_config_id, $langcode, $hash, $key) {
    try {

      // Check if the provided fac_config_id exists.

      /** @var \Drupal\fac\Entity\FacConfig $fac_config */
      if ($fac_config = $this->storage
        ->getStorage('fac_config')
        ->load($fac_config_id)) {

        // Check if the specific Fast Autocomplete configuration is enabled.
        if ($fac_config
          ->status()) {
          $languages = $this->languageManager
            ->getLanguages();

          // Check if the language code is valid.
          if (in_array($langcode, array_keys($languages))) {
            $response = NULL;

            // Switch to the anonymous user if configured.
            if ($fac_config
              ->anonymousSearch()) {

              /** @var \Drupal\user\UserInterface $anonymous_user */
              $anonymous_user = $this->storage
                ->getStorage('user')
                ->load(0);
              $this->accountSwitcher
                ->switchTo($anonymous_user);
            }

            // Check if the hash is valid.
            if ($this->hashService
              ->isValidHash($hash)) {

              // Remove the .json part from the key.
              $key = preg_replace('/\\.json$/', '', $key);

              // Check the key length.
              if (strlen($key) <= $fac_config
                ->getKeyMaxLength()) {

                // Replace all underscores by spaces for the search key.
                $search_key = preg_replace('/_/', ' ', $key);

                // Get the search results.
                $results['items'] = $this->searchService
                  ->getResults($fac_config, $langcode, $search_key);

                // Put the results in a json file in the public files folder.
                $directory = PublicStream::basePath() . '/fac-json/' . $fac_config_id . '/' . $langcode . '/' . $this->hashService
                  ->getHash();
                if ($this->fileSystem
                  ->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY)) {
                  $destination = $directory . '/' . $key . '.json';
                  $this->fileSystem
                    ->saveData(json_encode($results), $destination, FileSystemInterface::EXISTS_REPLACE);
                }

                // Set the response.
                $response = new JsonResponse($results);
              }
            }

            // Switch back to the original user if switched to user 0.
            if ($fac_config
              ->anonymousSearch()) {
              $this->accountSwitcher
                ->switchBack();
            }
            if (!is_null($response)) {
              return $response;
            }
          }
        }
      }
    } catch (InvalidPluginDefinitionException $e) {
      $this->logger
        ->error('An error occurred: ' . $e
        ->getMessage());
    }

    // If no response was returned, throw a NotFoundHttpException.
    throw new NotFoundHttpException();
  }

}

Members

Namesort descending 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::$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.
FacController::$accountSwitcher protected property The account switcher service.
FacController::$fileSystem protected property The file system service.
FacController::$hashService protected property The hash service.
FacController::$languageManager protected property The language manager service. Overrides ControllerBase::$languageManager
FacController::$logger protected property The logger service.
FacController::$searchService protected property The search service.
FacController::$storage protected property The entity type manager service.
FacController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
FacController::generateJson public function Generates the Fast Autocomplete JSON for a search query.
FacController::__construct public function
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.