class EntityAutocompleteMatcher

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php \Drupal\Core\Entity\EntityAutocompleteMatcher
  2. 10 core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php \Drupal\Core\Entity\EntityAutocompleteMatcher
  3. 11.x core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php \Drupal\Core\Entity\EntityAutocompleteMatcher

Matcher class to get autocompletion results for entity reference.

Hierarchy

Expanded class hierarchy of EntityAutocompleteMatcher

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 12

Namespace

Drupal\Core\Entity
View source
class EntityAutocompleteMatcher implements EntityAutocompleteMatcherInterface {
    
    /**
     * The entity reference selection handler plugin manager.
     *
     * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface
     */
    protected $selectionManager;
    
    /**
     * Constructs an 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;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMatches($target_type, $selection_handler, $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) {
                    $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[] = [
                        'value' => $key,
                        'label' => $label,
                    ];
                }
            }
        }
        return $matches;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
EntityAutocompleteMatcher::$selectionManager protected property The entity reference selection handler plugin manager.
EntityAutocompleteMatcher::getMatches public function Gets matched labels based on a given search string. Overrides EntityAutocompleteMatcherInterface::getMatches
EntityAutocompleteMatcher::__construct public function Constructs an EntityAutocompleteMatcher object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.