class HookHelpSection

Same name in other branches
  1. 8.9.x core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection
  2. 10 core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection
  3. 11.x core/modules/help/src/Plugin/HelpSection/HookHelpSection.php \Drupal\help\Plugin\HelpSection\HookHelpSection

Provides the module topics list section for the help page.

Plugin annotation


@HelpSection(
  id = "hook_help",
  title = @Translation("Module overviews"),
  description = @Translation("Module overviews are provided by modules. Overviews available for your installed modules:"),
)

Hierarchy

Expanded class hierarchy of HookHelpSection

File

core/modules/help/src/Plugin/HelpSection/HookHelpSection.php, line 19

Namespace

Drupal\help\Plugin\HelpSection
View 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.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler) {
        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'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function listTopics() {
        $topics = [];
        $this->moduleHandler
            ->invokeAllWith('help', function (callable $hook, string $module) use (&$topics) {
            $title = $this->moduleHandler
                ->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

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
HookHelpSection::$moduleHandler protected property The module handler.
HookHelpSection::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
HookHelpSection::listTopics public function Returns a list of topics to show in the help section. Overrides HelpSectionPluginInterface::listTopics
HookHelpSection::__construct public function Constructs a HookHelpSection object.
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.