class HelpSectionPluginBase
Same name and namespace in other branches
- 9 core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase
- 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
Provides a base class for help section plugins.
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\Plugin\HelpSection\HelpSectionPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\help\HelpSectionPluginInterface uses \Drupal\Core\Cache\UnchangingCacheableDependencyTrait
- 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 HelpSectionPluginBase
See also
\Drupal\help\HelpSectionPluginInterface
\Drupal\help\Annotation\HelpSection
\Drupal\help\HelpSectionManager
3 files declare their use of HelpSectionPluginBase
- EmptyHelpSection.php in core/
modules/ help/ tests/ modules/ help_page_test/ src/ Plugin/ HelpSection/ EmptyHelpSection.php - TestHelpSection.php in core/
modules/ help/ 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 |
|---|---|---|---|---|---|
| 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 | |
| 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 | |
| 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.