public function Select2EntityAutocompleteMatcher::getMatches in Open Social 8.9

Same name and namespace in other branches

1. 10.3.x modules/social_features/social_core/src/Entity/Select2EntityAutocompleteMatcher.php \Drupal\social_core\Entity\Select2EntityAutocompleteMatcher::getMatches()
2. 10.0.x modules/social_features/social_core/src/Entity/Select2EntityAutocompleteMatcher.php \Drupal\social_core\Entity\Select2EntityAutocompleteMatcher::getMatches()
3. 10.1.x modules/social_features/social_core/src/Entity/Select2EntityAutocompleteMatcher.php \Drupal\social_core\Entity\Select2EntityAutocompleteMatcher::getMatches()
4. 10.2.x modules/social_features/social_core/src/Entity/Select2EntityAutocompleteMatcher.php \Drupal\social_core\Entity\Select2EntityAutocompleteMatcher::getMatches()

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.

Overrides EntityAutocompleteMatcher::getMatches

See also

\Drupal\system\Controller\EntityAutocompleteController

File

modules/social_features/social_core/src/Entity/Select2EntityAutocompleteMatcher.php, line 18

Class

Select2EntityAutocompleteMatcher

Class Select2EntityAutocompleteMatcher.

Namespace

Drupal\social_core\Entity

Code

public function getMatches($target_type, $selection_handler, array $selection_settings, $string = '') {
  $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);

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

        // Skip certain entity_id's that are already a member or a enrollee.
        // We can just add this to our render arrays from now on.
        // '#selection_settings' => [ 'skip_entity' => ['7', '8', '9'] ].
        if (!empty($selection_settings['skip_entity']) && in_array($entity_id, $selection_settings['skip_entity'], FALSE)) {
          continue;
        }
        $label = !empty($selection_settings['hide_id']) ? $label : "{$label} ({$entity_id})";
        $matches[$entity_id] = [
          'id' => $entity_id,
          'text' => Html::decodeEntities($label),
        ];
      }
    }
    $this->moduleHandler
      ->alter('select2_autocomplete_matches', $matches, $options);
  }
  return array_values($matches);
}