class TestHelpTopicPlugin

Same name in other branches
  1. 8.9.x core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php \Drupal\help_topics_test\Plugin\HelpTopic\TestHelpTopicPlugin
  2. 10 core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php \Drupal\help_topics_test\Plugin\HelpTopic\TestHelpTopicPlugin
  3. 11.x core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php \Drupal\help_topics_test\Plugin\HelpTopic\TestHelpTopicPlugin

A fake help topic plugin for testing.

Hierarchy

Expanded class hierarchy of TestHelpTopicPlugin

1 string reference to 'TestHelpTopicPlugin'
help_topics_test.help_topics.yml in core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.help_topics.yml
core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.help_topics.yml

File

core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpTopic/TestHelpTopicPlugin.php, line 11

Namespace

Drupal\help_topics_test\Plugin\HelpTopic
View source 
class TestHelpTopicPlugin extends HelpTopicPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function getBody() {
        return [
            '#type' => 'markup',
            '#markup' => $this->pluginDefinition['body'],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        return [
            'foobar',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        return Cache::PERMANENT;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
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
TestHelpTopicPlugin::getBody public function Returns the body of the topic. Overrides HelpTopicPluginInterface::getBody
TestHelpTopicPlugin::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
TestHelpTopicPlugin::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
TestHelpTopicPlugin::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags

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