class HelpTopicSection
Same name in this branch
- 10 core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php \Drupal\help\Plugin\HelpSection\HelpTopicSection
Same name and namespace in other branches
- 9 core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php \Drupal\help_topics\Plugin\HelpSection\HelpTopicSection
- 8.9.x core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php \Drupal\help_topics\Plugin\HelpSection\HelpTopicSection
- 11.x core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php \Drupal\help_topics\Plugin\HelpSection\HelpTopicSection
- 11.x core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php \Drupal\help\Plugin\HelpSection\HelpTopicSection
Provides the help topics list section for the help page.
@internal Help Topic 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\Plugin\HelpSection\HelpSectionPluginBase extends \Drupal\help\HelpSectionPluginInterface uses \Drupal\Core\Cache\UnchangingCacheableDependencyTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\help\Plugin\HelpSection\HelpTopicSection extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\help\SearchableHelpInterface implements \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
- class \Drupal\help_topics\Plugin\HelpSection\HelpTopicSection implements \Drupal\help\Plugin\HelpSection\HelpTopicSection
- class \Drupal\help\Plugin\HelpSection\HelpTopicSection extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\help\SearchableHelpInterface implements \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
- class \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase extends \Drupal\help\HelpSectionPluginInterface uses \Drupal\Core\Cache\UnchangingCacheableDependencyTrait 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 HelpTopicSection
File
-
core/
modules/ help_topics/ src/ Plugin/ HelpSection/ HelpTopicSection.php, line 15
Namespace
Drupal\help_topics\Plugin\HelpSectionView source
class HelpTopicSection extends CoreHelpTopicSection {
}Members
| Title Sort descending | 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 | |
| HelpSectionPluginBase::getDescription | public | function | Returns the description text for the help section. | Overrides HelpSectionPluginInterface::getDescription | |
| HelpSectionPluginBase::getTitle | public | function | Returns the title of the help section. | Overrides HelpSectionPluginInterface::getTitle | |
| HelpTopicSection::$cacheableMetadata | protected | property | The merged top level help topic plugins cache metadata. | ||
| HelpTopicSection::$topLevelPlugins | protected | property | The top level help topic plugins. | ||
| HelpTopicSection::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
| HelpTopicSection::getCacheContexts | public | function | Overrides UnchangingCacheableDependencyTrait::getCacheContexts | ||
| HelpTopicSection::getCacheMaxAge | public | function | Overrides UnchangingCacheableDependencyTrait::getCacheMaxAge | ||
| HelpTopicSection::getCacheMetadata | protected | function | Gets the merged CacheableMetadata for all the top level help topic plugins. | ||
| HelpTopicSection::getCacheTags | public | function | Overrides UnchangingCacheableDependencyTrait::getCacheTags | ||
| HelpTopicSection::getPlugins | protected | function | Gets the top level help topic plugins. | ||
| HelpTopicSection::listSearchableTopics | public | function | Returns the IDs of topics that should be indexed for searching. | Overrides SearchableHelpInterface::listSearchableTopics | |
| HelpTopicSection::listTopics | public | function | Returns a list of topics to show in the help section. | Overrides HelpSectionPluginInterface::listTopics | |
| HelpTopicSection::renderTopicForSearch | public | function | Renders one topic for search indexing or search results. | Overrides SearchableHelpInterface::renderTopicForSearch | |
| HelpTopicSection::__construct | public | function | Constructs a HelpTopicSection object. | Overrides PluginBase::__construct | |
| 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 | public | function | Determines if the plugin is configurable. | ||
| 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.