class EmptyHelpSection in Drupal 8
Same name and namespace in other branches
- 9 core/modules/help/tests/modules/help_page_test/src/Plugin/HelpSection/EmptyHelpSection.php \Drupal\help_page_test\Plugin\HelpSection\EmptyHelpSection
Provides an empty section for the help page, for testing.
Plugin annotation
@HelpSection(
id = "empty_section",
title = @Translation("Empty section"),
description = @Translation("This description should appear."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase implements HelpSectionPluginInterface uses UnchangingCacheableDependencyTrait
- class \Drupal\help_page_test\Plugin\HelpSection\EmptyHelpSection
- class \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase implements HelpSectionPluginInterface uses UnchangingCacheableDependencyTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of EmptyHelpSection
File
- core/
modules/ help/ tests/ modules/ help_page_test/ src/ Plugin/ HelpSection/ EmptyHelpSection.php, line 16
Namespace
Drupal\help_page_test\Plugin\HelpSectionView source
class EmptyHelpSection extends HelpSectionPluginBase {
/**
* {@inheritdoc}
*/
public function listTopics() {
return [];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EmptyHelpSection:: |
public | function |
Returns a list of topics to show in the help section. Overrides HelpSectionPluginInterface:: |
|
HelpSectionPluginBase:: |
public | function |
Returns the description text for the help section. Overrides HelpSectionPluginInterface:: |
|
HelpSectionPluginBase:: |
public | function |
Returns the title of the help section. Overrides HelpSectionPluginInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UnchangingCacheableDependencyTrait:: |
public | function | 1 | |
UnchangingCacheableDependencyTrait:: |
public | function | 3 | |
UnchangingCacheableDependencyTrait:: |
public | function | 1 |