class HelpTopicPluginController in Drupal 9

Controller for help topic plugins.

@internal Help Topic is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\help_topics\Controller\HelpTopicPluginController

File

core/modules/help_topics/src/Controller/HelpTopicPluginController.php, line 21

Namespace

Drupal\help_topics\Controller

class HelpTopicPluginController extends ControllerBase {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The Help Topic plugin manager.
   *
   * @var \Drupal\help_topics\HelpTopicPluginManagerInterface
   */
  protected $helpTopicPluginManager;

  /**
   * Constructs a HelpTopicPluginController object.
   *
   * @param \Drupal\help_topics\HelpTopicPluginManagerInterface $help_topic_plugin_manager
   *   The help topic plugin manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(HelpTopicPluginManagerInterface $help_topic_plugin_manager, RendererInterface $renderer) {
    $this->helpTopicPluginManager = $help_topic_plugin_manager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.help_topic'), $container
      ->get('renderer'));
  }

  /**
   * Displays a help topic page.
   *
   * @param string $id
   *   The plugin ID. Maps to the {id} placeholder in the
   *   help.help_topic route.
   *
   * @return array
   *   A render array with the contents of a help topic page.
   */
  public function viewHelpTopic($id) {
    $build = [];
    if (!$this->helpTopicPluginManager
      ->hasDefinition($id)) {
      throw new NotFoundHttpException();
    }

    /** @var \Drupal\help_topics\HelpTopicPluginInterface $help_topic */
    $help_topic = $this->helpTopicPluginManager
      ->createInstance($id);
    $build['#body'] = $help_topic
      ->getBody();
    $this->renderer
      ->addCacheableDependency($build, $help_topic);

    // Build the related topics section, starting with the list this topic
    // says are related.
    $links = [];
    $related = $help_topic
      ->getRelated();
    foreach ($related as $other_id) {
      if ($other_id !== $id) {

        /** @var \Drupal\help_topics\HelpTopicPluginInterface $topic */
        $topic = $this->helpTopicPluginManager
          ->createInstance($other_id);
        $links[$other_id] = [
          'title' => $topic
            ->getLabel(),
          'url' => Url::fromRoute('help.help_topic', [
            'id' => $other_id,
          ]),
        ];
        $this->renderer
          ->addCacheableDependency($build, $topic);
      }
    }
    if (count($links)) {
      uasort($links, [
        SortArray::class,
        'sortByTitleElement',
      ]);
      $build['#related'] = [
        '#theme' => 'links__related',
        '#heading' => [
          'text' => $this
            ->t('Related topics'),
          'level' => 'h2',
        ],
        '#links' => $links,
      ];
    }
    $build['#theme'] = 'help_topic';
    $build['#title'] = $help_topic
      ->getLabel();
    return $build;
  }

}

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.
HelpTopicPluginController::$helpTopicPluginManager	protected	property	The Help Topic plugin manager.
HelpTopicPluginController::$renderer	protected	property	The renderer service.
HelpTopicPluginController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
HelpTopicPluginController::viewHelpTopic	public	function	Displays a help topic page.
HelpTopicPluginController::__construct	public	function	Constructs a HelpTopicPluginController object.
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.