class HookHelpSection
Same name in other branches
- 9 core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection
- 8.9.x core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection
- 10 core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection
Provides the module topics list section for the help page.
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\help\Plugin\HelpSection\HookHelpSection extends \Drupal\help\Plugin\HelpSection\HelpSectionPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- 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 HookHelpSection
File
-
core/
modules/ help/ src/ Plugin/ HelpSection/ HookHelpSection.php, line 16
Namespace
Drupal\help\Plugin\HelpSectionView source
class HookHelpSection extends HelpSectionPluginBase implements ContainerFactoryPluginInterface {
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Constructs a HookHelpSection object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler service.
* @param \Drupal\Core\Extension\ModuleExtensionList $moduleExtensionList
* The module extension list.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, ModuleExtensionList $moduleExtensionList) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('module_handler'), $container->get('extension.list.module'));
}
/**
* {@inheritdoc}
*/
public function listTopics() {
$topics = [];
$this->moduleHandler
->invokeAllWith('help', function (callable $hook, string $module) use (&$topics) {
$title = $this->moduleExtensionList
->getName($module);
$topics[$title] = Link::createFromRoute($title, 'help.page', [
'name' => $module,
]);
});
// Sort topics by title, which is the array key above.
ksort($topics);
return $topics;
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.