class TestHelpTopicPlugin

Same name and namespace 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 on git.drupalcode.org
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
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 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
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
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 85
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
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.