You are here

public function EntityAutocompleteMatcher::getMatches in Select 2 8

Gets matched labels based on a given search string.

Parameters

string $target_type: The ID of the target entity type.

string $selection_handler: The plugin ID of the entity reference selection handler.

array $selection_settings: An array of settings that will be passed to the selection handler.

string $string: (optional) The label of the entity to query by.

array $selected: (optional) An array of already selected items.

Return value

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.

See also

\Drupal\system\Controller\EntityAutocompleteController

File

src/EntityAutocompleteMatcher.php, line 64

Class

EntityAutocompleteMatcher
Matcher class to get autocompletion results for entity reference.

Namespace

Drupal\select2

Code

public function getMatches($target_type, $selection_handler, array $selection_settings, $string = '', array $selected = []) {
  $matches = [];
  $options = $selection_settings + [
    'target_type' => $target_type,
    'handler' => $selection_handler,
  ];
  $handler = $this->selectionManager
    ->getInstance($options);
  if (isset($string)) {

    // Get an array of matching entities.
    $match_operator = !empty($selection_settings['match_operator']) ? $selection_settings['match_operator'] : 'CONTAINS';
    $match_limit = isset($selection_settings['match_limit']) ? (int) $selection_settings['match_limit'] : 10;
    $entity_labels = $handler
      ->getReferenceableEntities($string, $match_operator, $match_limit + count($selected));

    // Loop through the entities and convert them into autocomplete output.
    foreach ($entity_labels as $values) {
      foreach ($values as $entity_id => $label) {

        // Filter out already selected items.
        if (in_array($entity_id, $selected)) {
          continue;
        }
        $matches[$entity_id] = [
          'id' => $entity_id,
          'text' => Html::decodeEntities($label),
        ];
      }
    }
    $matches = array_slice($matches, 0, $match_limit, TRUE);
    $this->moduleHandler
      ->alter('select2_autocomplete_matches', $matches, $options);
  }
  return array_values($matches);
}