Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\help\Plugin\HelpSection;
Chris@0: 
Chris@0: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@0: use Drupal\Core\Link;
Chris@0: use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
Chris@0: use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides the module topics list section for the help page.
Chris@0:  *
Chris@0:  * @HelpSection(
Chris@0:  *   id = "hook_help",
Chris@0:  *   title = @Translation("Module overviews"),
Chris@0:  *   description = @Translation("Module overviews are provided by modules. Overviews available for your installed modules:"),
Chris@0:  * )
Chris@0:  */
Chris@0: class HookHelpSection extends HelpSectionPluginBase implements ContainerFactoryPluginInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The module handler.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Extension\ModuleHandlerInterface
Chris@0:    */
Chris@0:   protected $moduleHandler;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a HookHelpSection object.
Chris@0:    *
Chris@0:    * @param array $configuration
Chris@0:    *   A configuration array containing information about the plugin instance.
Chris@0:    * @param string $plugin_id
Chris@0:    *   The plugin_id for the plugin instance.
Chris@0:    * @param mixed $plugin_definition
Chris@0:    *   The plugin implementation definition.
Chris@0:    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
Chris@0:    *   The module handler service.
Chris@0:    */
Chris@0:   public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler) {
Chris@0:     parent::__construct($configuration, $plugin_id, $plugin_definition);
Chris@0:     $this->moduleHandler = $module_handler;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
Chris@0:     return new static(
Chris@0:       $configuration,
Chris@0:       $plugin_id,
Chris@0:       $plugin_definition,
Chris@0:       $container->get('module_handler')
Chris@0:     );
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function listTopics() {
Chris@0:     $topics = [];
Chris@0:     foreach ($this->moduleHandler->getImplementations('help') as $module) {
Chris@0:       $title = $this->moduleHandler->getName($module);
Chris@0:       $topics[$title] = Link::createFromRoute($title, 'help.page', ['name' => $module]);
Chris@0:     }
Chris@0: 
Chris@0:     // Sort topics by title, which is the array key above.
Chris@0:     ksort($topics);
Chris@0:     return $topics;
Chris@0:   }
Chris@0: 
Chris@0: }