protected function HelpController::helpLinksAsList

Provides a formatted list of available help topics.

Return value

string A string containing the formatted list.

File

drupal/core/modules/help/lib/Drupal/help/Controller/HelpController.php, line 64

Contains \Drupal\help\Controller\HelpController.

Class

HelpController

Controller routines for help routes.

Namespace

Code

protected function helpLinksAsList() {
  $empty_arg = drupal_help_arg();
  $module_info = system_rebuild_module_data();
  $modules = array();
  foreach ($this->moduleHandler
    ->getImplementations('help') as $module) {
    if ($this->moduleHandler
      ->invoke($module, 'help', array(
      "admin/help#{$module}",
      $empty_arg,
    ))) {
      $modules[$module] = $module_info[$module]->info['name'];
    }
  }
  asort($modules);

  // Output pretty four-column list.
  $count = count($modules);
  $break = ceil($count / 4);
  $output = '<div class="clearfix"><div class="help-items"><ul>';
  $i = 0;
  foreach ($modules as $module => $name) {
    $output .= '<li>' . l($name, 'admin/help/' . $module) . '</li>';
    if (($i + 1) % $break == 0 && $i + 1 != $count) {
      $output .= '</ul></div><div class="help-items' . ($i + 1 == $break * 3 ? ' help-items-last' : '') . '"><ul>';
    }
    $i++;
  }
  $output .= '</ul></div></div>';
  return $output;
}