class EntityAutocompleteMatcher in Drupal 8
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php \Drupal\Core\Entity\EntityAutocompleteMatcher
- 10 core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php \Drupal\Core\Entity\EntityAutocompleteMatcher
Matcher class to get autocompletion results for entity reference.
Hierarchy
- class \Drupal\Core\Entity\EntityAutocompleteMatcher implements EntityAutocompleteMatcherInterface
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
File
- core/
lib/ Drupal/ Core/ Entity/ EntityAutocompleteMatcher.php, line 12
Namespace
Drupal\Core\EntityView source
class EntityAutocompleteMatcher implements EntityAutocompleteMatcherInterface {
/**
* 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;
}
/**
* {@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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityAutocompleteMatcher:: |
protected | property | The entity reference selection handler plugin manager. | |
EntityAutocompleteMatcher:: |
public | function |
Gets matched labels based on a given search string. Overrides EntityAutocompleteMatcherInterface:: |
|
EntityAutocompleteMatcher:: |
public | function | Constructs a EntityAutocompleteMatcher object. |