class RealnameAutocompleteController in Real Name 2.x

Defines a route controller for entity autocomplete form elements.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\system\Controller\EntityAutocompleteController
    • class \Drupal\realname\Controller\RealnameAutocompleteController

File

src/Controller/RealnameAutocompleteController.php, line 18

Namespace

Drupal\realname\Controller

class RealnameAutocompleteController extends EntityAutocompleteController {

  /**
   * {@inheritdoc}
   */
  public function handleAutocomplete(Request $request, $target_type, $selection_handler, $selection_settings_key) {
    if ($target_type != 'user') {
      return parent::handleAutocomplete($request, $target_type, $selection_handler, $selection_settings_key);
    }
    $matches = [];
    if ($input = $request->query
      ->get('q')) {
      $typed_string = Tags::explode($input);
      $typed_string = mb_strtolower(array_pop($typed_string));
      $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 ($selection_settings_hash !== $selection_settings_key) {
          throw new AccessDeniedHttpException('Invalid selection settings key.');
        }
      }
      else {
        throw new AccessDeniedHttpException();
      }
      $matches = $this
        ->getMatches($selection_settings, $typed_string);
    }
    return new JsonResponse($matches);
  }

  /**
   * Gets matched labels based on a given search string.
   *
   * @param array $selection_settings
   *   An array of settings that will be passed to the selection handler.
   * @param string $string
   *   (optional) The label of the entity to query by.
   *
   * @return array
   *   An array of matched entity labels, in the format required by the AJAX
   *   autocomplete API (e.g. array('value' => $value, 'label' => $label)).
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   Thrown when the current user doesn't have access to the specified entity.
   */
  protected function getMatches(array $selection_settings, $string = '') {
    $matches = [];
    if (isset($string)) {

      // Get an array of matching entities.
      $match_operator = !empty($selection_settings['match_operator']) ? $selection_settings['match_operator'] : 'CONTAINS';
      $include_anonymous = isset($selection_settings['include_anonymous']) ? $selection_settings['include_anonymous'] : TRUE;
      $connection = \Drupal::database();
      $query = $connection
        ->select('users_field_data', 'u');
      $query
        ->fields('u', [
        'uid',
      ]);
      $query
        ->leftJoin('realname', 'rn', 'u.uid = rn.uid');
      if ($match_operator == 'CONTAINS') {
        $query
          ->condition((new Condition('OR'))
          ->condition('rn.realname', '%' . $connection
          ->escapeLike($string) . '%', 'LIKE')
          ->condition('u.name', '%' . $connection
          ->escapeLike($string) . '%', 'LIKE'));
      }
      else {
        $query
          ->condition((new Condition('OR'))
          ->condition('rn.realname', $connection
          ->escapeLike($string) . '%', 'LIKE')
          ->condition('u.name', $connection
          ->escapeLike($string) . '%', 'LIKE'));
      }
      if ($include_anonymous == FALSE) {
        $query
          ->condition('u.uid', 0, '>');
      }
      $query
        ->range(0, 10);
      $uids = $query
        ->execute()
        ->fetchCol();
      $accounts = User::loadMultiple($uids);

      /** @var \Drupal\user\Entity\User $account */
      foreach ($accounts as $account) {
        $matches[] = [
          'value' => $this
            ->t('@realname (@id)', [
            '@realname' => $account
              ->getDisplayName(),
            '@id' => $account
              ->id(),
          ]),
          'label' => $this
            ->t('@realname (@username)', [
            '@realname' => $account
              ->getDisplayName(),
            '@username' => $account
              ->getAccountName(),
          ]),
        ];
      }
    }
    return $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::$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.
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::__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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RealnameAutocompleteController::getMatches	protected	function	Gets matched labels based on a given search string.
RealnameAutocompleteController::handleAutocomplete	public	function	Autocomplete the label of an entity. Overrides EntityAutocompleteController::handleAutocomplete
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.