class EntityAutocompleteMatcher in Select 2 8

Matcher class to get autocompletion results for entity reference.

Hierarchy

• class \Drupal\select2\EntityAutocompleteMatcher

1 file declares its use of EntityAutocompleteMatcher

EntityAutocompleteController.php in src/Controller/EntityAutocompleteController.php

1 string reference to 'EntityAutocompleteMatcher'

select2.services.yml in ./select2.services.yml

select2.services.yml

1 service uses EntityAutocompleteMatcher

select2.autocomplete_matcher in ./select2.services.yml

Drupal\select2\EntityAutocompleteMatcher

File

src/EntityAutocompleteMatcher.php, line 12

Namespace

Drupal\select2

class EntityAutocompleteMatcher {

  /**
   * The entity reference selection handler plugin manager.
   *
   * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface
   */
  protected $selectionManager;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a EntityAutocompleteMatcher object.
   *
   * @param \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface $selection_manager
   *   The entity reference selection handler plugin manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct(SelectionPluginManagerInterface $selection_manager, ModuleHandlerInterface $module_handler) {
    $this->selectionManager = $selection_manager;
    $this->moduleHandler = $module_handler;
  }

  /**
   * Gets matched labels based on a given search string.
   *
   * @param string $target_type
   *   The ID of the target entity type.
   * @param string $selection_handler
   *   The plugin ID of the entity reference selection handler.
   * @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.
   * @param array $selected
   *   (optional) An array of already selected items.
   *
   * @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.
   *
   * @see \Drupal\system\Controller\EntityAutocompleteController
   */
  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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityAutocompleteMatcher::$moduleHandler	protected	property	The module handler service.
EntityAutocompleteMatcher::$selectionManager	protected	property	The entity reference selection handler plugin manager.
EntityAutocompleteMatcher::getMatches	public	function	Gets matched labels based on a given search string.
EntityAutocompleteMatcher::__construct	public	function	Constructs a EntityAutocompleteMatcher object.