class EntityAutocompleteMatcher in Zircon Profile 8

Matcher class to get autocompletion results for entity reference.

Hierarchy

• class \Drupal\Core\Entity\EntityAutocompleteMatcher

1 file declares its use of EntityAutocompleteMatcher

EntityAutocompleteController.php in core/modules/system/src/Controller/EntityAutocompleteController.php

Contains \Drupal\system\Controller\EntityAutocompleteController.

1 string reference to 'EntityAutocompleteMatcher'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses EntityAutocompleteMatcher

entity.autocomplete_matcher in core/core.services.yml

Drupal\Core\Entity\EntityAutocompleteMatcher

File

core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php, line 17

Contains \Drupal\Core\Entity\EntityAutocompleteMatcher.

Namespace

Drupal\Core\Entity

class EntityAutocompleteMatcher {

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

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

  /**
   * 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.
   *
   * @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, $selection_settings, $string = '') {
    $matches = array();
    $options = array(
      'target_type' => $target_type,
      'handler' => $selection_handler,
      'handler_settings' => $selection_settings,
    );
    $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';
      $entity_labels = $handler
        ->getReferenceableEntities($string, $match_operator, 10);

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

          // Strip things like starting/trailing white spaces, line breaks and
          // tags.
          $key = preg_replace('/\\s\\s+/', ' ', str_replace("\n", '', trim(Html::decodeEntities(strip_tags($key)))));

          // Names containing commas or quotes must be wrapped in quotes.
          $key = Tags::encode($key);
          $matches[] = array(
            'value' => $key,
            'label' => $label,
          );
        }
      }
    }
    return $matches;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.