ShortcutLazyBuilders.php

Same filename in other branches
  1. 9 core/modules/shortcut/src/ShortcutLazyBuilders.php
  2. 8.9.x core/modules/shortcut/src/ShortcutLazyBuilders.php
  3. 10 core/modules/shortcut/src/ShortcutLazyBuilders.php

Namespace

Drupal\shortcut

File

core/modules/shortcut/src/ShortcutLazyBuilders.php

View source
<?php

namespace Drupal\shortcut;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Security\TrustedCallbackInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Url;

/**
 * Lazy builders for the shortcut module.
 */
class ShortcutLazyBuilders implements TrustedCallbackInterface {
    
    /**
     * The renderer service.
     *
     * @var \Drupal\Core\Render\RendererInterface
     */
    protected $renderer;
    
    /**
     * Constructs a new ShortcutLazyBuilders object.
     *
     * @param \Drupal\Core\Render\RendererInterface $renderer
     *   The renderer service.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
     *   The entity type manager.
     * @param \Drupal\Core\Session\AccountInterface $currentUser
     *   The current user.
     */
    public function __construct(RendererInterface $renderer, EntityTypeManagerInterface $entityTypeManager, AccountInterface $currentUser) {
        $this->renderer = $renderer;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function trustedCallbacks() {
        return [
            'lazyLinks',
        ];
    }
    
    /**
     * #lazy_builder callback; builds shortcut toolbar links.
     *
     * @param bool $show_configure_link
     *   Boolean to indicate whether to include the configure link or not.
     *
     * @return array
     *   A renderable array of shortcut links.
     */
    public function lazyLinks(bool $show_configure_link = TRUE) {
        $shortcut_set = $this->entityTypeManager
            ->getStorage('shortcut_set')
            ->getDisplayedToUser($this->currentUser);
        $links = shortcut_renderable_links();
        $configure_link = NULL;
        if ($show_configure_link && shortcut_set_edit_access($shortcut_set)->isAllowed()) {
            $configure_link = [
                '#type' => 'link',
                '#title' => t('Edit shortcuts'),
                '#url' => Url::fromRoute('entity.shortcut_set.customize_form', [
                    'shortcut_set' => $shortcut_set->id(),
                ]),
                '#options' => [
                    'attributes' => [
                        'class' => [
                            'edit-shortcuts',
                        ],
                    ],
                ],
            ];
        }
        $build = [
            'shortcuts' => $links,
            'configure' => $configure_link,
        ];
        $this->renderer
            ->addCacheableDependency($build, $shortcut_set);
        return $build;
    }

}

Classes

Title Deprecated Summary
ShortcutLazyBuilders Lazy builders for the shortcut module.

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