class EmptyHelpSection in Drupal 10

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

File

core/modules/help/tests/modules/help_page_test/src/Plugin/HelpSection/EmptyHelpSection.php, line 16

Namespace

Drupal\help_page_test\Plugin\HelpSection

class EmptyHelpSection extends HelpSectionPluginBase {

  /**
   * {@inheritdoc}
   */
  public function listTopics() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EmptyHelpSection::listTopics	public	function	Returns a list of topics to show in the help section. Overrides HelpSectionPluginInterface::listTopics
HelpSectionPluginBase::getDescription	public	function
HelpSectionPluginBase::getTitle	public	function
MessengerTrait::$messenger	protected	property	The messenger.	16
MessengerTrait::messenger	public	function	Gets the messenger.	16
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.
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
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		1
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	44
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.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UnchangingCacheableDependencyTrait::getCacheContexts	public	function
UnchangingCacheableDependencyTrait::getCacheMaxAge	public	function
UnchangingCacheableDependencyTrait::getCacheTags	public	function