class FrontPageMatcher in Linkit 8.5

Provides specific linkit matchers for the front page.

Plugin annotation

@Matcher(
  id = "front_page",
  label = @Translation("Front page"),
)

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\Plugin\Linkit\Matcher\FrontPageMatcher

File

src/Plugin/Linkit/Matcher/FrontPageMatcher.php, line 18

Namespace

Drupal\linkit\Plugin\Linkit\Matcher

class FrontPageMatcher extends MatcherBase {

  /**
   * {@inheritdoc}
   */
  public function execute($string) {
    $suggestions = new SuggestionCollection();

    // Special for link to front page.
    if (strpos($string, 'front') !== FALSE) {
      $suggestion = new DescriptionSuggestion();
      $suggestion
        ->setLabel($this
        ->t('Front page'))
        ->setPath(Url::fromRoute('<front>')
        ->toString())
        ->setGroup($this
        ->t('System'))
        ->setDescription($this
        ->t('The front page for this site.'));
      $suggestions
        ->addSuggestion($suggestion);
    }
    return $suggestions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FrontPageMatcher::execute	public	function	Executes the matcher. Overrides MatcherInterface::execute
MatcherBase::$uuid	protected	property	The matcher ID.
MatcherBase::$weight	protected	property	The weight of the matcher compared to others in a matcher collection.
MatcherBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	5
MatcherBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
MatcherBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
MatcherBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
MatcherBase::getLabel	public	function	Returns the matcher label. Overrides MatcherInterface::getLabel
MatcherBase::getSummary	public	function	Returns the summarized configuration of the matcher. Overrides MatcherInterface::getSummary	1
MatcherBase::getUuid	public	function	Returns the unique ID representing the matcher. Overrides MatcherInterface::getUuid
MatcherBase::getWeight	public	function	Returns the weight of the matcher. Overrides MatcherInterface::getWeight
MatcherBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MatcherBase::setWeight	public	function	Sets the weight for the matcher. Overrides MatcherInterface::setWeight
MatcherBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.