class NavigationRenderer

Handle rendering for different pieces of the navigation.

@internal

Hierarchy

Expanded class hierarchy of NavigationRenderer

3 files declare their use of NavigationRenderer
NavigationHooks.php in core/modules/navigation/src/Hook/NavigationHooks.php
PageActions.php in core/modules/navigation/src/Plugin/TopBarItem/PageActions.php
SettingsForm.php in core/modules/navigation/src/Form/SettingsForm.php
1 string reference to 'NavigationRenderer'
navigation.services.yml in core/modules/navigation/navigation.services.yml
core/modules/navigation/navigation.services.yml
1 service uses NavigationRenderer
navigation.renderer in core/modules/navigation/navigation.services.yml
Drupal\navigation\NavigationRenderer

File

core/modules/navigation/src/NavigationRenderer.php, line 30

Namespace

Drupal\navigation
View source
final class NavigationRenderer {
  
  /**
   * Use the default Drupal logo in the navigation.
   */
  const LOGO_PROVIDER_DEFAULT = 'default';
  
  /**
   * Hide the logo in the navigation.
   */
  const LOGO_PROVIDER_HIDE = 'hide';
  
  /**
   * Use the custom provided logo in the navigation.
   */
  const LOGO_PROVIDER_CUSTOM = 'custom';
  
  /**
   * The navigation local tasks render array.
   *
   * @var array
   */
  protected array $localTasks;
  
  /**
   * Construct a new NavigationRenderer object.
   */
  public function __construct(private ConfigFactoryInterface $configFactory, private ModuleHandlerInterface $moduleHandler, private RouteMatchInterface $routeMatch, private LocalTaskManagerInterface $localTaskManager, private ImageFactory $imageFactory, private FileUrlGeneratorInterface $fileUrlGenerator, private SectionStorageManagerInterface $sectionStorageManager, private RequestStack $requestStack, private ModuleExtensionList $moduleExtensionList, private AccountInterface $currentUser, private EntityRouteHelper $entityRouteHelper) {
  }
  
  /**
   * Remove the toolbar provided by Toolbar module.
   *
   * @param array $page_top
   *   A renderable array representing the top of the page.
   *
   * @see toolbar_page_top()
   * @see hook_page_top()
   */
  public function removeToolbar(array &$page_top) : void {
    if (isset($page_top['toolbar'])) {
      unset($page_top['toolbar']);
    }
  }
  
  /**
   * Build out the navigation bar.
   *
   * @param array $page_top
   *   A renderable array representing the top of the page.
   *
   * @see toolbar_page_top()
   * @see hook_page_top()
   */
  public function buildNavigation(array &$page_top) : void {
    $page_top['navigation'] = [
      '#cache' => [
        'keys' => [
          'navigation',
          'navigation',
        ],
        'max-age' => CacheBackendInterface::CACHE_PERMANENT,
      ],
      '#lazy_builder' => [
        'navigation.renderer:doBuildNavigation',
        [],
      ],
      '#create_placeholder' => TRUE,
    ];
  }
  
  /**
   * Pre-render callback for ::buildNavigation.
   */
  public function doBuildNavigation() : array {
    $build = [];
    $logo_settings = $this->configFactory
      ->get('navigation.settings');
    $logo_provider = $logo_settings->get('logo.provider');
    $cacheability = new CacheableMetadata();
    $contexts = [
      'navigation' => new Context(ContextDefinition::create('string'), 'navigation'),
    ];
    $storage = $this->sectionStorageManager
      ->findByContext($contexts, $cacheability);
    if ($storage) {
      foreach ($storage->getSections() as $delta => $section) {
        $build[$delta] = $section->toRenderArray([]);
      }
    }
    // The render array is built based on decisions made by SectionStorage
    // plugins and therefore it needs to depend on the accumulated
    // cacheability of those decisions.
    $cacheability->addCacheableDependency($logo_settings)
      ->addCacheableDependency($this->configFactory
      ->get('navigation.block_layout'));
    $cacheability->applyTo($build);
    $module_path = $this->requestStack
      ->getCurrentRequest()
      ->getBasePath() . '/' . $this->moduleExtensionList
      ->getPath('navigation');
    $asset_url = $module_path . '/assets/fonts/inter-var.woff2';
    $defaults = [
      '#settings' => [
        'hide_logo' => $logo_provider === self::LOGO_PROVIDER_HIDE,
      ],
      '#attached' => [
        'html_head_link' => [
          [
            [
              'rel' => 'preload',
              'href' => $asset_url,
              'as' => 'font',
              'crossorigin' => 'anonymous',
            ],
          ],
        ],
      ],
    ];
    $build[0] = NestedArray::mergeDeepArray([
      $build[0],
      $defaults,
    ]);
    $build[0]['content_top'] = $this->getContentTop();
    if ($logo_provider === self::LOGO_PROVIDER_CUSTOM) {
      $logo_path = $logo_settings->get('logo.path');
      if (!empty($logo_path) && is_file($logo_path)) {
        $logo_managed_url = $this->fileUrlGenerator
          ->generateAbsoluteString($logo_path);
        $image = $this->imageFactory
          ->get($logo_path);
        $build[0]['#settings']['logo_path'] = $logo_managed_url;
        if ($image->isValid()) {
          $build[0]['#settings']['logo_width'] = $image->getWidth();
          $build[0]['#settings']['logo_height'] = $image->getHeight();
        }
      }
    }
    return $build;
  }
  
  /**
   * Gets the content for content_top section.
   *
   * @return array
   *   The content_top section content.
   */
  protected function getContentTop() : array {
    $content_top = [
      '#theme' => 'navigation_content_top',
    ];
    $content_top_items = $this->moduleHandler
      ->invokeAll('navigation_content_top');
    $this->moduleHandler
      ->alter('navigation_content_top', $content_top_items);
    uasort($content_top_items, [
      SortArray::class,
      'sortByWeightElement',
    ]);
    // Filter out empty items, taking care to merge any cacheability metadata.
    $cacheability = new CacheableMetadata();
    $content_top_items = array_filter($content_top_items, function ($item) use (&$cacheability) {
      if (Element::isEmpty($item)) {
        $cacheability = $cacheability->merge(CacheableMetadata::createFromRenderArray($item));
        return FALSE;
      }
      return TRUE;
    });
    $cacheability->applyTo($content_top);
    $content_top['#items'] = $content_top_items;
    return $content_top;
  }
  
  /**
   * Build the top bar for content entity pages.
   *
   * @param array $page_top
   *   A renderable array representing the top of the page.
   *
   * @see navigation_page_top()
   * @see hook_page_top()
   */
  public function buildTopBar(array &$page_top) : void {
    $page_top['top_bar']['#cache']['contexts'][] = 'user.permissions';
    if ($this->currentUser
      ->hasPermission('access navigation')) {
      $page_top['top_bar'] = [
        '#cache' => [
          'keys' => [
            'navigation',
            'top_bar',
          ],
          'max-age' => CacheBackendInterface::CACHE_PERMANENT,
        ],
        '#lazy_builder' => [
          'navigation.renderer:doBuildTopBar',
          [],
        ],
        '#create_placeholder' => TRUE,
      ];
    }
  }
  
  /**
   * Lazy builder to generate the top bar render array.
   */
  public function doBuildTopBar() : array {
    return [
      '#type' => 'top_bar',
    ];
  }
  
  /**
   * Alter the build of any local_tasks_block plugin block.
   *
   * If we are showing the local tasks in the top bar, hide the local tasks
   * from display to avoid duplicating the links.
   *
   * @param array $build
   *   A renderable array representing the local_tasks_block plugin block to be
   *   rendered.
   * @param \Drupal\Core\Block\BlockPluginInterface $block
   *   Block plugin object representing a local_tasks_block.
   *
   * @see navigation_block_build_local_tasks_block_alter()
   */
  public function removeLocalTasks(array &$build, BlockPluginInterface $block) : void {
    if ($block->getPluginId() !== 'local_tasks_block') {
      return;
    }
    if ($this->hasLocalTasks()) {
      $build['#access'] = FALSE;
    }
  }
  
  /**
   * Local tasks list based on user access.
   *
   * @return array
   *   Local tasks keyed by route name.
   */
  public function getLocalTasks() : array {
    if (isset($this->localTasks)) {
      return $this->localTasks;
    }
    $cacheability = new CacheableMetadata();
    $cacheability->addCacheableDependency($this->localTaskManager);
    $this->localTasks = [
      'page_actions' => [],
      'cacheability' => $cacheability,
    ];
    // For now, we're only interested in local tasks corresponding to a content
    // entity.
    if (!$this->entityRouteHelper
      ->isContentEntityRoute()) {
      return $this->localTasks;
    }
    $entity_local_tasks = $this->localTaskManager
      ->getLocalTasks($this->routeMatch
      ->getRouteName());
    uasort($entity_local_tasks['tabs'], [
      SortArray::class,
      'sortByWeightProperty',
    ]);
    foreach ($entity_local_tasks['tabs'] as $local_task_name => $local_task) {
      // Exclude current route local task, since it is not going to be included
      // in the page actions link list.
      $url = $local_task['#link']['url'] ?? NULL;
      if ($url?->getRouteName() === $entity_local_tasks['route_name']) {
        continue;
      }
      // The $local_task array that we get here is tailor-made for use
      // with the menu-local-tasks.html.twig, eg. the menu_local_task
      // theme hook. It has all the information we need, but we're not
      // rendering local tasks, or tabs, we're rendering a simple list of
      // links. Here we're taking advantage of all the good stuff found in
      // the render array, namely the #link, and #access properties, using
      // them to render a simple link.
      // @see \Drupal\Core\Menu\LocalTaskManager::getTasksBuild()
      $link = $local_task['#link'];
      $link['localized_options'] += [
        'set_active_class' => TRUE,
      ];
      $this->localTasks['page_actions'][$local_task_name] = [
        '#theme' => 'top_bar_page_action',
        '#link' => [
          '#type' => 'link',
          '#title' => $link['title'],
          '#url' => $link['url'],
          '#options' => $link['localized_options'],
        ],
        '#access' => $local_task['#access'],
      ];
    }
    $this->localTasks['cacheability'] = $cacheability->merge($entity_local_tasks['cacheability']);
    return $this->localTasks;
  }
  
  /**
   * Do we have local tasks that we want to show in the top bar?
   *
   * @return bool
   *   TRUE if there are local tasks available for the top bar, FALSE otherwise.
   */
  public function hasLocalTasks() : bool {
    $local_tasks = $this->getLocalTasks();
    return !empty($local_tasks['page_actions']);
  }

}

Members

Title Sort descending Modifiers Object type Summary
NavigationRenderer::$localTasks protected property The navigation local tasks render array.
NavigationRenderer::buildNavigation public function Build out the navigation bar.
NavigationRenderer::buildTopBar public function Build the top bar for content entity pages.
NavigationRenderer::doBuildNavigation public function Pre-render callback for ::buildNavigation.
NavigationRenderer::doBuildTopBar public function Lazy builder to generate the top bar render array.
NavigationRenderer::getContentTop protected function Gets the content for content_top section.
NavigationRenderer::getLocalTasks public function Local tasks list based on user access.
NavigationRenderer::hasLocalTasks public function Do we have local tasks that we want to show in the top bar?
NavigationRenderer::LOGO_PROVIDER_CUSTOM constant Use the custom provided logo in the navigation.
NavigationRenderer::LOGO_PROVIDER_DEFAULT constant Use the default Drupal logo in the navigation.
NavigationRenderer::LOGO_PROVIDER_HIDE constant Hide the logo in the navigation.
NavigationRenderer::removeLocalTasks public function Alter the build of any local_tasks_block plugin block.
NavigationRenderer::removeToolbar public function Remove the toolbar provided by Toolbar module.
NavigationRenderer::__construct public function Construct a new NavigationRenderer object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.