class HelpTopicPluginBase
Same name in this branch
- 11.x core/modules/help/src/HelpTopicPluginBase.php \Drupal\help\HelpTopicPluginBase
Same name and namespace 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
- 10 core/modules/help_topics/src/HelpTopicPluginBase.php \Drupal\help_topics\HelpTopicPluginBase
- 10 core/modules/help/src/HelpTopicPluginBase.php \Drupal\help\HelpTopicPluginBase
Base class for help topic plugins.
@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
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\help\HelpTopicPluginBase extends \Drupal\help\HelpTopicPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\help_topics\HelpTopicPluginBase implements \Drupal\help\HelpTopicPluginBase
- class \Drupal\help\HelpTopicPluginBase extends \Drupal\help\HelpTopicPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of HelpTopicPluginBase
File
-
core/
modules/ help_topics/ src/ HelpTopicPluginBase.php, line 15
Namespace
Drupal\help_topicsView source
abstract class HelpTopicPluginBase extends CoreHelpTopicPluginBase {
}Members
| Title Sort descending | Deprecated | 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 | ||
| 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 | 3 | |||
| DependencySerializationTrait::__wakeup | public | function | 3 | |||
| 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 | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| 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 | Deprecated | public | function | Determines if the plugin is configurable. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 82 | ||
| 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. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.