Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 5 |
CRAP | |
0.00% |
0 / 75 |
| HelpController | |
0.00% |
0 / 1 |
|
0.00% |
0 / 5 |
182 | |
0.00% |
0 / 75 |
| __construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| create | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 4 |
|||
| helpMain | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 6 |
|||
| helpLinksAsList | |
0.00% |
0 / 1 |
30 | |
0.00% |
0 / 29 |
|||
| helpPage | |
0.00% |
0 / 1 |
30 | |
0.00% |
0 / 34 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\help\Controller\HelpController. | |
| */ | |
| namespace Drupal\help\Controller; | |
| use Drupal\Core\Controller\ControllerBase; | |
| use Drupal\Core\Routing\RouteMatchInterface; | |
| use Drupal\Core\Url; | |
| use Symfony\Component\DependencyInjection\ContainerInterface; | |
| use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; | |
| /** | |
| * Controller routines for help routes. | |
| */ | |
| 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(); | |
| } | |
| } | |
| } |