Controller routines for help routes.
Expanded class hierarchy of HelpController
class HelpController implements ControllerInterface {
/**
* Stores the module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* Constructs a \Drupal\help\Controller\HelpController object.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*/
public function __construct(ModuleHandlerInterface $module_handler) {
$this->moduleHandler = $module_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('module_handler'));
}
/**
* 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(
'#attached' => array(
'css' => array(
drupal_get_path('module', 'help') . '/css/help.module.css',
),
),
'#markup' => '<h2>' . t('Help topics') . '</h2><p>' . t('Help is available on the following items:') . '</p>' . $this
->helpLinksAsList(),
);
return $output;
}
/**
* Provides a formatted list of available help topics.
*
* @return string
* A string containing the formatted list.
*/
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;
}
/**
* 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().
*/
public function helpPage($name) {
$build = array();
if ($this->moduleHandler
->implementsHook($name, 'help')) {
$info = system_get_info('module');
drupal_set_title($info[$name]['name']);
$temp = $this->moduleHandler
->invoke($name, 'help', array(
"admin/help#{$name}",
drupal_help_arg(),
));
if (empty($temp)) {
$build['top']['#markup'] = t('No help is available for module %module.', array(
'%module' => $info[$name]['name'],
));
}
else {
$build['top']['#markup'] = $temp;
}
// Only print list of administration pages if the module in question has
// any such pages associated to it.
$admin_tasks = system_get_module_admin_tasks($name, $info[$name]);
if (!empty($admin_tasks)) {
$links = array();
foreach ($admin_tasks as $task) {
$link = $task['localized_options'];
$link['href'] = $task['link_path'];
$link['title'] = $task['title'];
$links[] = $link;
}
$build['links']['#links'] = array(
'#heading' => array(
'level' => 'h3',
'text' => t('@module administration pages', array(
'@module' => $info[$name]['name'],
)),
),
'#links' => $links,
);
}
}
return $build;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
HelpController:: |
protected | property | Stores the module handler. | |
HelpController:: |
public static | function |
Instantiates a new instance of this controller. Overrides ControllerInterface:: |
|
HelpController:: |
protected | function | Provides a formatted list of available help topics. | |
HelpController:: |
public | function | Prints a page listing a glossary of Drupal terminology. | |
HelpController:: |
public | function | Prints a page listing general help for a module. | |
HelpController:: |
public | function | Constructs a \Drupal\help\Controller\HelpController object. |