You are here

Home » API reference » README Help 8 » ReadmeHelpController.php

class ReadmeHelpController in README Help 8

Overrides HelpController class.

Hierarchy

Expanded class hierarchy of ReadmeHelpController

File

src/Controller/ReadmeHelpController.php, line 10

Namespace

Drupal\readmehelp\Controller
View source 
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);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
HelpController::$helpManager protected property The help section plugin manager.
HelpController::$moduleExtensionList protected property The module extension list.
HelpController::$routeMatch protected property The current route match.
HelpController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
HelpController::helpMain public function Prints a page listing various types of help.
HelpController::__construct public function Creates a new HelpController.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ReadmeHelpController::helpPage public function Prints a page listing general help for a module. Overrides HelpController::helpPage
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.