class HelpSectionPluginBase
Same name and namespace in other branches
- 8.9.x core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
- 10 core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
- 11.x core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
Provides a base class for help section plugins.
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\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 HelpSectionPluginBase
See also
\Drupal\help\HelpSectionPluginInterface
\Drupal\help\Annotation\HelpSection
\Drupal\help\HelpSectionManager
4 files declare their use of HelpSectionPluginBase
- EmptyHelpSection.php in core/
modules/ help/ tests/ modules/ help_page_test/ src/ Plugin/ HelpSection/ EmptyHelpSection.php - HelpTopicSection.php in core/
modules/ help_topics/ src/ Plugin/ HelpSection/ HelpTopicSection.php - TestHelpSection.php in core/
modules/ help_topics/ tests/ modules/ help_topics_test/ src/ Plugin/ HelpSection/ TestHelpSection.php - TourHelpSection.php in core/
modules/ tour/ src/ Plugin/ HelpSection/ TourHelpSection.php
File
-
core/
modules/ help/ src/ Plugin/ HelpSection/ HelpSectionPluginBase.php, line 16
Namespace
Drupal\help\Plugin\HelpSectionView source
abstract class HelpSectionPluginBase extends PluginBase implements HelpSectionPluginInterface {
use UnchangingCacheableDependencyTrait;
/**
* {@inheritdoc}
*/
public function getTitle() {
return $this->getPluginDefinition()['title'];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->getPluginDefinition()['description'];
}
}
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 | |
HelpSectionPluginInterface::listTopics | public | function | Returns a list of topics to show in the help section. | 5 | |
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. | ||
UnchangingCacheableDependencyTrait::getCacheContexts | public | function | 1 | ||
UnchangingCacheableDependencyTrait::getCacheMaxAge | public | function | 3 | ||
UnchangingCacheableDependencyTrait::getCacheTags | public | function | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.