abstract class MatcherBase in Linkit 8.4
Same name and namespace in other branches
- 8.5 src/MatcherBase.php \Drupal\linkit\MatcherBase
Provides a base class for matchers.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\linkit\MatcherBase implements ContainerFactoryPluginInterface, MatcherInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of MatcherBase
See also
1 file declares its use of MatcherBase
- DummyMatcher.php in tests/
linkit_test/ src/ Plugin/ Linkit/ Matcher/ DummyMatcher.php - Contains \Drupal\linkit_test\Plugin\Linkit\Matcher\DummyMatcher.
File
- src/
MatcherBase.php, line 18 - Contains \Drupal\linkit\MatcherBase.
Namespace
Drupal\linkitView source
abstract class MatcherBase extends PluginBase implements MatcherInterface, ContainerFactoryPluginInterface {
/**
* The matcher ID.
*
* @var string
*/
protected $uuid;
/**
* The weight of the matcher compared to others in a matcher collection.
*
* @var int
*/
protected $weight = 0;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this
->setConfiguration($configuration);
}
/**
* {@inheritdoc}
*/
public function getUuid() {
return $this->uuid;
}
/**
* {@inheritdoc}
*/
public function getLabel() {
return $this->pluginDefinition['label'];
}
/**
* {@inheritdoc}
*/
public function getSummary() {
return array();
}
/**
* {@inheritdoc}
*/
public function getWeight() {
return $this->weight;
}
/**
* {@inheritdoc}
*/
public function setWeight($weight) {
return $this->weight = $weight;
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return [
'uuid' => $this
->getUuid(),
'id' => $this
->getPluginId(),
'weight' => $this
->getWeight(),
'settings' => $this->configuration,
];
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
$configuration += [
'uuid' => '',
'weight' => '0',
'settings' => [],
];
$this->configuration = $configuration['settings'] + $this
->defaultConfiguration();
$this->uuid = $configuration['uuid'];
$this->weight = $configuration['weight'];
return $this;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [];
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContainerFactoryPluginInterface:: |
public static | function | Creates an instance of the plugin. | 112 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MatcherBase:: |
protected | property | The matcher ID. | |
MatcherBase:: |
protected | property | The weight of the matcher compared to others in a matcher collection. | |
MatcherBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
4 |
MatcherBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurablePluginInterface:: |
2 |
MatcherBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
|
MatcherBase:: |
public | function |
Returns the matcher label. Overrides MatcherInterface:: |
|
MatcherBase:: |
public | function |
Returns the summarized configuration of the matcher. Overrides MatcherInterface:: |
1 |
MatcherBase:: |
public | function |
Returns the unique ID representing the matcher. Overrides MatcherInterface:: |
|
MatcherBase:: |
public | function |
Returns the weight of the matcher. Overrides MatcherInterface:: |
|
MatcherBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
|
MatcherBase:: |
public | function |
Sets the weight for the matcher. Overrides MatcherInterface:: |
|
MatcherBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
MatcherInterface:: |
public | function | Gets an array with search matches that will be presented in the autocomplete widget. | 3 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |