public EntityAutocompleteMatcher::getMatches($target_type, $selection_handler, $selection_settings, $string = '')
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.
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.
See also
\Drupal\system\Controller\EntityAutocompleteController
File
- core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php, line 52
Class
- EntityAutocompleteMatcher
- Matcher class to get autocompletion results for entity reference.
Namespace
Drupal\Core\Entity
Code
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; }
Please login to continue.