You are here

Home » API reference » Zircon Profile 8 » HelpController.php

class HelpController in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/help/src/Controller/HelpController.php \Drupal\help\Controller\HelpController

Controller routines for help routes.

Hierarchy

Expanded class hierarchy of HelpController

File

core/modules/help/src/Controller/HelpController.php, line 19
Contains \Drupal\help\Controller\HelpController.

Namespace

Drupal\help\Controller
View source 
class HelpController extends ControllerBase {

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Creates a new HelpController.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct(RouteMatchInterface $route_match) {
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_route_match'));
  }

  /**
   * Prints a page listing a glossary of Drupal terminology.
   *
   * @return string
   *   An HTML string representing the contents of help page.
   */
  public function helpMain() {
    $output = array(
      '#markup' => '<h2>' . $this
        ->t('Help topics') . '</h2><p>' . $this
        ->t('Help is available on the following items:') . '</p>',
      'links' => $this
        ->helpLinksAsList(),
    );
    return $output;
  }

  /**
   * Provides a formatted list of available help topics.
   *
   * @return string
   *   A string containing the formatted list.
   */
  protected function helpLinksAsList() {
    $modules = array();
    foreach ($this
      ->moduleHandler()
      ->getImplementations('help') as $module) {
      $modules[$module] = $this->moduleHandler
        ->getName($module);
    }
    asort($modules);

    // Output pretty four-column list.
    $count = count($modules);
    $break = ceil($count / 4);
    $column = array(
      '#type' => 'container',
      'links' => array(
        '#theme' => 'item_list',
      ),
      '#attributes' => array(
        'class' => array(
          'layout-column',
          'layout-column--quarter',
        ),
      ),
    );
    $output = array(
      '#prefix' => '<div class="clearfix">',
      '#suffix' => '</div>',
      0 => $column,
    );
    $i = 0;
    $current_column = 0;
    foreach ($modules as $module => $name) {
      $output[$current_column]['links']['#items'][] = $this
        ->l($name, new Url('help.page', array(
        'name' => $module,
      )));
      if (($i + 1) % $break == 0 && $i + 1 != $count) {
        $current_column++;
        $output[$current_column] = $column;
      }
      $i++;
    }
    return $output;
  }

  /**
   * Prints a page listing general help for a module.
   *
   * @param string $name
   *   A module name to display a help page for.
   *
   * @return array
   *   A render array as expected by drupal_render().
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   */
  public function helpPage($name) {
    $build = array();
    if ($this
      ->moduleHandler()
      ->implementsHook($name, 'help')) {
      $module_name = $this
        ->moduleHandler()
        ->getName($name);
      $build['#title'] = $module_name;
      $temp = $this
        ->moduleHandler()
        ->invoke($name, 'help', array(
        "help.page.{$name}",
        $this->routeMatch,
      ));
      if (empty($temp)) {
        $build['top']['#markup'] = $this
          ->t('No help is available for module %module.', array(
          '%module' => $module_name,
        ));
      }
      else {
        $build['top']['#markup'] = $temp;
      }

      // 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, system_get_info('module', $name));
      if (!empty($admin_tasks)) {
        $links = array();
        foreach ($admin_tasks as $task) {
          $link['url'] = $task['url'];
          $link['title'] = $task['title'];
          $links[] = $link;
        }
        $build['links'] = array(
          '#theme' => 'links__help',
          '#heading' => array(
            'level' => 'h3',
            'text' => $this
              ->t('@module administration pages', array(
              '@module' => $module_name,
            )),
          ),
          '#links' => $links,
        );
      }
      return $build;
    }
    else {
      throw new NotFoundHttpException();
    }
  }

}

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. 1
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 3
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. 1
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 3
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::state protected function Returns the state storage service.
HelpController::$routeMatch protected property The current route match.
HelpController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
HelpController::helpLinksAsList protected function Provides a formatted list of available help topics.
HelpController::helpMain public function Prints a page listing a glossary of Drupal terminology.
HelpController::helpPage public function Prints a page listing general help for a module.
HelpController::__construct public function Creates a new HelpController.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
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 protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.