class ReadmeHookHelpSection in README Help 8

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

• 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\Plugin\HelpSection\HookHelpSection implements ContainerFactoryPluginInterface
        • class \Drupal\readmehelp\Plugin\HelpSection\ReadmeHookHelpSection implements ReadmeHelpInterface

File

src/Plugin/HelpSection/ReadmeHookHelpSection.php, line 18

Namespace

Drupal\readmehelp\Plugin\HelpSection

class ReadmeHookHelpSection extends HookHelpSection implements ReadmeHelpInterface {

  /**
   * {@inheritdoc}
   */
  public function listTopics() {
    $dirs = $this->moduleHandler
      ->getModuleDirectories();
    $hook_help = $this->moduleHandler
      ->getImplementations('help');
    $topics = [];
    foreach ($this->moduleHandler
      ->getModuleList() as $name => $module) {
      $file = FALSE;
      $self = $name == 'readmehelp';
      $extension_info = \Drupal::service('extension.list.module')
        ->getExtensionInfo($name);
      $dependencies = $extension_info['dependencies'];
      if (in_array('readmehelp', $dependencies) || in_array('drupal:readmehelp', $dependencies) || $self) {
        foreach (explode(', ', static::READMEHELP_FILES) as $readme) {
          if ($file = file_exists("{$dirs[$name]}/{$readme}")) {
            break;
          }
        }
      }
      if ($file || in_array($name, $hook_help)) {
        $title = $this->moduleHandler
          ->getName($name);
        $topics[$title] = Link::createFromRoute($title, 'help.page', [
          'name' => $name,
        ]);
      }
    }

    // Sort topics by title, which is the array key above.
    ksort($topics);
    return $topics;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
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::__construct	public	function	Constructs a HookHelpSection object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ReadmeHelpInterface::READMEHELP_FILES		constant	The versions of a README file by default converted by the filter.
ReadmeHookHelpSection::listTopics	public	function	Returns a list of topics to show in the help section. Overrides HookHelpSection::listTopics
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UnchangingCacheableDependencyTrait::getCacheContexts	public	function		1
UnchangingCacheableDependencyTrait::getCacheMaxAge	public	function		3
UnchangingCacheableDependencyTrait::getCacheTags	public	function		1