class ContactFormMatcher in Linkit 8.5
Provides specific linkit matchers for contact forms.
Plugin annotation
@Matcher(
id = "entity:contact_form",
label = @Translation("Contact form"),
target_entity = "contact_form",
provider = "contact"
)
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\linkit\ConfigurableMatcherBase implements ConfigurableMatcherInterface
- class \Drupal\linkit\Plugin\Linkit\Matcher\EntityMatcher uses MatcherTokensTrait
- class \Drupal\linkit\Plugin\Linkit\Matcher\ContactFormMatcher
- class \Drupal\linkit\Plugin\Linkit\Matcher\EntityMatcher uses MatcherTokensTrait
- class \Drupal\linkit\ConfigurableMatcherBase implements ConfigurableMatcherInterface
- class \Drupal\linkit\MatcherBase implements ContainerFactoryPluginInterface, MatcherInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ContactFormMatcher
File
- src/
Plugin/ Linkit/ Matcher/ ContactFormMatcher.php, line 15
Namespace
Drupal\linkit\Plugin\Linkit\MatcherView source
class ContactFormMatcher extends EntityMatcher {
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
return parent::calculateDependencies() + [
'module' => [
'contact',
],
];
}
/**
* {@inheritdoc}
*/
protected function buildEntityQuery($search_string) {
$query = parent::buildEntityQuery($search_string);
// Remove the personal contact form from the suggestion list.
$query
->condition('id', 'personal', '<>');
return $query;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContactFormMatcher:: |
protected | function |
Builds an EntityQuery to get entities. Overrides EntityMatcher:: |
|
ContactFormMatcher:: |
public | function |
Calculates dependencies for the configured plugin. Overrides MatcherBase:: |
|
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 | |
EntityMatcher:: |
protected | property | The current user. | |
EntityMatcher:: |
protected | property | The database connection. | |
EntityMatcher:: |
protected | property | The entity repository. | |
EntityMatcher:: |
protected | property | The entity type bundle info. | |
EntityMatcher:: |
protected | property | The entity type manager. | |
EntityMatcher:: |
protected | property | The module handler service. | |
EntityMatcher:: |
protected | property | The substitution manager. | |
EntityMatcher:: |
protected | property | The target entity type ID. | |
EntityMatcher:: |
protected | function | Adds query tags to the query. | |
EntityMatcher:: |
public | function |
Form constructor. Overrides PluginFormInterface:: |
4 |
EntityMatcher:: |
protected | function | Builds the metadata string used in the suggestion. | 2 |
EntityMatcher:: |
protected | function | Builds the group string used in the suggestion. | |
EntityMatcher:: |
protected | function | Builds the label string used in the suggestion. | |
EntityMatcher:: |
protected | function | Builds the path string used in the suggestion. | 1 |
EntityMatcher:: |
public static | function |
Creates an instance of the plugin. Overrides MatcherBase:: |
|
EntityMatcher:: |
protected | function | Creates a suggestion. | |
EntityMatcher:: |
public | function |
Gets default configuration for this plugin. Overrides MatcherBase:: |
3 |
EntityMatcher:: |
constant | The default limit for matches. | ||
EntityMatcher:: |
public static | function | Form element validation handler; Filters the #value property of an element. | |
EntityMatcher:: |
public | function |
Executes the matcher. Overrides MatcherInterface:: |
|
EntityMatcher:: |
protected | function | Finds entity id from the given input. | |
EntityMatcher:: |
public | function |
Returns the summarized configuration of the matcher. Overrides MatcherBase:: |
3 |
EntityMatcher:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
3 |
EntityMatcher:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
EntityMatcher:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides MatcherBase:: |
|
MatcherBase:: |
protected | property | The matcher ID. | |
MatcherBase:: |
protected | property | The weight of the matcher compared to others in a matcher collection. | |
MatcherBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
MatcherBase:: |
public | function |
Returns the matcher label. Overrides MatcherInterface:: |
|
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 ConfigurableInterface:: |
|
MatcherBase:: |
public | function |
Sets the weight for the matcher. Overrides MatcherInterface:: |
|
MatcherTokensTrait:: |
public | function | Gets all available tokens. | |
MatcherTokensTrait:: |
public | function | Inserts a form element with a list of available tokens. | |
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. |