class HelpTopicPluginBase

Same name in this branch
  1. 11.x core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
Same name and namespace in other branches
  1. 9 core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
  2. 8.9.x core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
  3. 10 core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
  4. 10 core/modules/help/src/HelpTopicPluginBase.php \Drupal\help\HelpTopicPluginBase

Base class for help topic plugins.

@internal Plugin classes are internal.

Hierarchy

Expanded class hierarchy of HelpTopicPluginBase

2 files declare their use of HelpTopicPluginBase
HelpTopicPluginBase.php in core/modules/help_topics/src/HelpTopicPluginBase.php
TestHelpTopicPlugin.php in core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php

File

core/modules/help/src/HelpTopicPluginBase.php, line 15

Namespace

Drupal\help
View source 
abstract class HelpTopicPluginBase extends PluginBase implements HelpTopicPluginInterface {
    
    /**
     * The name of the module or theme providing the help topic.
     */
    public function getProvider() {
        return $this->pluginDefinition['provider'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getLabel() {
        return $this->pluginDefinition['label'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function isTopLevel() {
        return $this->pluginDefinition['top_level'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRelated() {
        return $this->pluginDefinition['related'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function toUrl(array $options = []) {
        return Url::fromRoute('help.help_topic', [
            'id' => $this->getPluginId(),
        ], $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function toLink($text = NULL, array $options = []) {
        if (!$text) {
            $text = $this->getLabel();
        }
        return Link::createFromRoute($text, 'help.help_topic', [
            'id' => $this->getPluginId(),
        ], $options);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
HelpTopicPluginBase::getLabel public function Returns the label of the topic. Overrides HelpTopicPluginInterface::getLabel
HelpTopicPluginBase::getProvider public function The name of the module or theme providing the help topic.
HelpTopicPluginBase::getRelated public function Returns the IDs of related topics. Overrides HelpTopicPluginInterface::getRelated
HelpTopicPluginBase::isTopLevel public function Returns whether this is a top-level topic or not. Overrides HelpTopicPluginInterface::isTopLevel
HelpTopicPluginBase::toLink public function Returns a link for viewing the help topic. Overrides HelpTopicPluginInterface::toLink
HelpTopicPluginBase::toUrl public function Returns the URL for viewing the help topic. Overrides HelpTopicPluginInterface::toUrl
HelpTopicPluginInterface::getBody public function Returns the body of the topic. 2
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.