class HelpTopicPluginBase
Same name in this branch
- 10 core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
Same name in other branches
- 9 core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
- 8.9.x core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
- 11.x core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
- 11.x core/modules/help/src/HelpTopicPluginBase.php \Drupal\help\HelpTopicPluginBase
Base class for help topic plugins.
@internal Plugin classes are internal.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\help\HelpTopicPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help\HelpTopicPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
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\helpView 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 Sort descending | 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 | Overrides HelpTopicPluginInterface::getLabel | ||
HelpTopicPluginBase::getProvider | public | function | The name of the module or theme providing the help topic. | ||
HelpTopicPluginBase::getRelated | public | function | Overrides HelpTopicPluginInterface::getRelated | ||
HelpTopicPluginBase::isTopLevel | public | function | Overrides HelpTopicPluginInterface::isTopLevel | ||
HelpTopicPluginBase::toLink | public | function | Overrides HelpTopicPluginInterface::toLink | ||
HelpTopicPluginBase::toUrl | public | function | 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.