MatcherInterface.php in Linkit 8.4
Same filename and directory in other branches
Contains \Drupal\linkit\MatcherInterface.
Namespace
Drupal\linkitFile
src/MatcherInterface.phpView source
<?php
/**
* @file
* Contains \Drupal\linkit\MatcherInterface.
*/
namespace Drupal\linkit;
use Drupal\Component\Plugin\ConfigurablePluginInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\Core\Plugin\PluginFormInterface;
/**
* Defines the interface for matchers.
*
* @see \Drupal\linkit\Annotation\Matcher
* @see \Drupal\linkit\MatcherBase
* @see \Drupal\linkit\MatcherManager
* @see plugin_api
*/
interface MatcherInterface extends PluginInspectionInterface, ConfigurablePluginInterface {
/**
* Returns the unique ID representing the matcher.
*
* @return string
* The matcher ID.
*/
public function getUuid();
/**
* Returns the matcher label.
*
* @return string
* The matcher label.
*/
public function getLabel();
/**
* Returns the summarized configuration of the matcher.
*
* @return array
* An array of summarized configuration of the matcher.
*/
public function getSummary();
/**
* Returns the weight of the matcher.
*
* @return int|string
* Either the integer weight of the matcher, or an empty string.
*/
public function getWeight();
/**
* Sets the weight for the matcher.
*
* @param int $weight
* The weight for this matcher.
*
* @return $this
*/
public function setWeight($weight);
/**
* Gets an array with search matches that will be presented in the autocomplete
* widget.
*
* @param $string
* The string that contains the text to search for.
*
* @return array
* An array whose values are an associative array containing:
* - title: A string to use as the search result label.
* - description: (optional) A string with additional information about the
* result item.
* - path: The URL to the item.
* - group: (optional) A string with the group name for the result item.
* Best practice is to use the plugin name as group name.
*/
public function getMatches($string);
}
Interfaces
Name | Description |
---|---|
MatcherInterface | Defines the interface for matchers. |