interface HelpTopicPluginInterface
Same name in this branch
- 10 core/modules/help/src/HelpTopicPluginInterface.php \Drupal\help\HelpTopicPluginInterface
Same name and namespace in other branches
- 11.x core/modules/help/src/HelpTopicPluginInterface.php \Drupal\help\HelpTopicPluginInterface
- 9 core/modules/help_topics/src/HelpTopicPluginInterface.php \Drupal\help_topics\HelpTopicPluginInterface
- 8.9.x core/modules/help_topics/src/HelpTopicPluginInterface.php \Drupal\help_topics\HelpTopicPluginInterface
Defines an interface for help topic plugin classes.
@internal Help Topics is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.
Hierarchy
- interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface
- interface \Drupal\help\HelpTopicPluginInterface extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface, \Drupal\Core\Cache\CacheableDependencyInterface
- interface \Drupal\help_topics\HelpTopicPluginInterface extends \Drupal\help\HelpTopicPluginInterface
- interface \Drupal\help\HelpTopicPluginInterface extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface, \Drupal\Core\Cache\CacheableDependencyInterface
Expanded class hierarchy of HelpTopicPluginInterface
All classes that implement HelpTopicPluginInterface
See also
\Drupal\help_topics\HelpTopicPluginManager
File
-
core/
modules/ help_topics/ src/ HelpTopicPluginInterface.php, line 17
Namespace
Drupal\help_topicsView source
interface HelpTopicPluginInterface extends CoreHelpTopicPluginInterface {
}Members
| Title Sort descending | Modifiers | Object type | Summary | 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 |
| HelpTopicPluginInterface::getBody | public | function | Returns the body of the topic. | 2 |
| HelpTopicPluginInterface::getLabel | public | function | Returns the label of the topic. | 1 |
| HelpTopicPluginInterface::getRelated | public | function | Returns the IDs of related topics. | 1 |
| HelpTopicPluginInterface::isTopLevel | public | function | Returns whether this is a top-level topic or not. | 1 |
| HelpTopicPluginInterface::toLink | public | function | Returns a link for viewing the help topic. | 1 |
| HelpTopicPluginInterface::toUrl | public | function | Returns the URL for viewing the help topic. | 1 |
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 4 |
| 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.