ReadmeHelpController.php in README Help 8

Namespace

Drupal\readmehelp\Controller

File

src/Controller/ReadmeHelpController.php

<?php

namespace Drupal\readmehelp\Controller;

use Drupal\help\Controller\HelpController;

/**
 * Overrides HelpController class.
 */
class ReadmeHelpController extends HelpController {

  /**
   * {@inheritdoc}
   */
  public function helpPage($name) {
    $build = [];
    $self = $name == 'readmehelp';
    $info = \Drupal::service('extension.list.module')
      ->getExtensionInfo($name);
    $dependencies = isset($info['dependencies']) ? $info['dependencies'] : [];
    $depender = $self || in_array('readmehelp', $dependencies) || in_array('drupal:readmehelp', $dependencies);

    // Allow dependers to override default behaviour not displaying README
    // markdown file automatically and instead calling a regular hook_help() in
    // their .module files. For this to happen an empty hook_readmehelp() should
    // be implemented which is actually never will be called. Example:
    // @code
    // function MY_MODULE_readmehelp() {}
    // @endcode
    if ($depender && !$this
      ->moduleHandler()
      ->implementsHook($name, 'readmehelp')) {
      $converter = \Drupal::service('readmehelp.markdown_converter');
      $build['top'] = [
        '#attached' => [
          'library' => [
            'readmehelp/page',
          ],
        ],
        '#markup' => $converter
          ->convertMarkdownFile($name),
      ];

      // Only print list of administration pages if the module in question has
      // any such pages associated with it.
      $admin_tasks = system_get_module_admin_tasks($name, $info);
      if (!empty($admin_tasks)) {
        $module_name = $this
          ->moduleHandler()
          ->getName($name);
        $links = [];
        foreach ($admin_tasks as $task) {
          $link['url'] = $task['url'];
          $link['title'] = $task['title'];
          $links[] = $link;
        }
        $build['links'] = [
          '#theme' => 'links__help',
          '#heading' => [
            'level' => 'h3',
            'text' => $this
              ->t('@module administration pages', [
              '@module' => $module_name,
            ]),
          ],
          '#links' => $links,
        ];
      }
      return $build;
    }
    else {
      return parent::helpPage($name);
    }
  }

}

Classes

Name	Description
ReadmeHelpController	Overrides HelpController class.