class HelpController in Drupal 9

Same name and namespace in other branches

8 core/modules/help/src/Controller/HelpController.php \Drupal\help\Controller\HelpController

Controller routines for help routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\help\Controller\HelpController

Expanded class hierarchy of HelpController

File

core/modules/help/src/Controller/HelpController.php, line 17

Namespace

Drupal\help\Controller

View source

class HelpController extends ControllerBase {

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

  /**
   * The help section plugin manager.
   *
   * @var \Drupal\help\HelpSectionManager
   */
  protected $helpManager;

  /**
   * The module extension list.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList
   */
  protected $moduleExtensionList;

  /**
   * Creates a new HelpController.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   * @param \Drupal\help\HelpSectionManager $help_manager
   *   The help section manager.
   * @param \Drupal\Core\Extension\ModuleExtensionList|null $module_extension_list
   *   The module extension list.
   */
  public function __construct(RouteMatchInterface $route_match, HelpSectionManager $help_manager, ModuleExtensionList $module_extension_list) {
    $this->routeMatch = $route_match;
    $this->helpManager = $help_manager;
    $this->moduleExtensionList = $module_extension_list;
  }

  /**
   * {@inheritdoc}
   */
  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'));
  }

  /**
   * Prints a page listing various types of help.
   *
   * The page has sections defined by \Drupal\help\HelpSectionPluginInterface
   * plugins.
   *
   * @return array
   *   A render array for the help page.
   */
  public function helpMain() {
    $output = [];

    // We are checking permissions, so add the user.permissions cache context.
    $cacheability = new CacheableMetadata();
    $cacheability
      ->addCacheContexts([
      'user.permissions',
    ]);
    $plugins = $this->helpManager
      ->getDefinitions();
    $cacheability
      ->addCacheableDependency($this->helpManager);
    foreach ($plugins as $plugin_id => $plugin_definition) {

      // Check the provided permission.
      if (!empty($plugin_definition['permission']) && !$this
        ->currentuser()
        ->hasPermission($plugin_definition['permission'])) {
        continue;
      }

      // Add the section to the page.

      /** @var \Drupal\help\HelpSectionPluginInterface $plugin */
      $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;
  }

  /**
   * 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\Core\Render\RendererInterface::render().
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   */
  public function helpPage($name) {
    $build = [];
    if ($this
      ->moduleHandler()
      ->implementsHook($name, 'help')) {
      $module_name = $this
        ->moduleHandler()
        ->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;
      }

      // 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, $info);
      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();
    }
  }

}

Members

Name	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::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
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::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
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::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
HelpController::$helpManager	protected	property	The help section plugin manager.
HelpController::$moduleExtensionList	protected	property	The module extension list.
HelpController::$routeMatch	protected	property	The current route match.
HelpController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
HelpController::helpMain	public	function	Prints a page listing various types of help.
HelpController::helpPage	public	function	Prints a page listing general help for a module.
HelpController::__construct	public	function	Creates a new HelpController.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	4
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.

You are here

class HelpController in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation