Same filename and directory in other branches
- 8.9.x core/modules/help/src/Controller/HelpController.php
- 9 core/modules/help/src/Controller/HelpController.php
Namespace
Drupal\help\Controller
File
core/modules/help/src/Controller/HelpController.php
View source
<?php
namespace Drupal\help\Controller;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Extension\ExtensionLifecycle;
use Drupal\Core\Extension\ModuleExtensionList;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\help\HelpSectionManager;
use Drupal\system\ModuleAdminLinksHelper;
use Drupal\user\ModulePermissionsLinkHelper;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
class HelpController extends ControllerBase {
protected $routeMatch;
protected $helpManager;
protected $moduleExtensionList;
protected $moduleAdminLinks;
protected $modulePermissionsLinks;
public function __construct(RouteMatchInterface $route_match, HelpSectionManager $help_manager, ModuleExtensionList $module_extension_list, ModuleAdminLinksHelper $module_admin_links = NULL, ModulePermissionsLinkHelper $module_permissions_link = NULL) {
$this->routeMatch = $route_match;
$this->helpManager = $help_manager;
$this->moduleExtensionList = $module_extension_list;
if (!isset($module_admin_links)) {
@trigger_error('Calling ' . __METHOD__ . ' without the $module_admin_tasks_helper argument is deprecated in drupal:10.2.0 and the $module_admin_tasks_helper argument will be required in drupal:11.0.0. See https://www.drupal.org/node/3038972', E_USER_DEPRECATED);
$module_admin_links = \Drupal::service('system.module_admin_links_helper');
}
$this->moduleAdminLinks = $module_admin_links;
if (!isset($module_permissions_link)) {
@trigger_error('Calling HelpController::__construct() without the $module_permissions_link argument is deprecated in drupal:9.3.0 and the $module_permissions_link argument will be required in drupal:10.0.0. See https://www.drupal.org/node/3038972', E_USER_DEPRECATED);
$module_permissions_link = \Drupal::service('user.module_permissions_link_helper');
}
$this->modulePermissionsLinks = $module_permissions_link;
}
public static function create(ContainerInterface $container) {
return new static($container
->get('current_route_match'), $container
->get('plugin.manager.help_section'), $container
->get('extension.list.module'), $container
->get('system.module_admin_links_helper'), $container
->get('user.module_permissions_link_helper'));
}
public function helpMain() {
$output = [];
$cacheability = new CacheableMetadata();
$cacheability
->addCacheContexts([
'user.permissions',
]);
$plugins = $this->helpManager
->getDefinitions();
$cacheability
->addCacheableDependency($this->helpManager);
foreach ($plugins as $plugin_id => $plugin_definition) {
if (!empty($plugin_definition['permission']) && !$this
->currentUser()
->hasPermission($plugin_definition['permission'])) {
continue;
}
$plugin = $this->helpManager
->createInstance($plugin_id);
$this_output = [
'#theme' => 'help_section',
'#title' => $plugin
->getTitle(),
'#description' => $plugin
->getDescription(),
'#empty' => $this
->t('There is currently nothing in this section.'),
'#links' => [],
'#weight' => $plugin_definition['weight'],
];
$links = $plugin
->listTopics();
if (is_array($links) && count($links)) {
$this_output['#links'] = $links;
}
$cacheability
->addCacheableDependency($plugin);
$output[$plugin_id] = $this_output;
}
$cacheability
->applyTo($output);
return $output;
}
public function helpPage($name) {
$build = [];
if ($this
->moduleHandler()
->hasImplementations('help', $name)) {
$module_name = $this->moduleExtensionList
->getName($name);
$build['#title'] = $module_name;
$info = $this->moduleExtensionList
->getExtensionInfo($name);
if ($info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::EXPERIMENTAL) {
$this
->messenger()
->addWarning($this
->t('This module is experimental. <a href=":url">Experimental modules</a> are provided for testing purposes only. Use at your own risk.', [
':url' => 'https://www.drupal.org/core/experimental',
]));
}
$temp = $this
->moduleHandler()
->invoke($name, 'help', [
"help.page.{$name}",
$this->routeMatch,
]);
if (empty($temp)) {
$build['top'] = [
'#markup' => $this
->t('No help is available for module %module.', [
'%module' => $module_name,
]),
];
}
else {
if (!is_array($temp)) {
$temp = [
'#markup' => $temp,
];
}
$build['top'] = $temp;
}
$admin_tasks = $this->moduleAdminLinks
->getModuleAdminLinks($name);
if ($module_permissions_link = $this->modulePermissionsLinks
->getModulePermissionsLink($name, $info['name'])) {
$admin_tasks["user.admin_permissions.{$name}"] = $module_permissions_link;
}
if (!empty($admin_tasks)) {
$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 {
throw new NotFoundHttpException();
}
}
}
Classes