class ShortcutLazyBuilders

Same name in other branches
  1. 9 core/modules/shortcut/src/ShortcutLazyBuilders.php \Drupal\shortcut\ShortcutLazyBuilders
  2. 8.9.x core/modules/shortcut/src/ShortcutLazyBuilders.php \Drupal\shortcut\ShortcutLazyBuilders
  3. 11.x core/modules/shortcut/src/ShortcutLazyBuilders.php \Drupal\shortcut\ShortcutLazyBuilders

Lazy builders for the shortcut module.

Hierarchy

Expanded class hierarchy of ShortcutLazyBuilders

1 file declares its use of ShortcutLazyBuilders
ShortcutLazyBuilder.php in core/modules/navigation/src/ShortcutLazyBuilder.php
1 string reference to 'ShortcutLazyBuilders'
shortcut.services.yml in core/modules/shortcut/shortcut.services.yml
core/modules/shortcut/shortcut.services.yml
1 service uses ShortcutLazyBuilders
shortcut.lazy_builders in core/modules/shortcut/shortcut.services.yml
Drupal\shortcut\ShortcutLazyBuilders

File

core/modules/shortcut/src/ShortcutLazyBuilders.php, line 14

Namespace

Drupal\shortcut
View source
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|null $entityTypeManager
     *   The entity type manager.
     * @param \Drupal\Core\Session\AccountInterface|null $currentUser
     *   The current user.
     */
    public function __construct(RendererInterface $renderer, ?EntityTypeManagerInterface $entityTypeManager, ?AccountInterface $currentUser) {
        $this->renderer = $renderer;
        if (!isset($this->entityTypeManager)) {
            @trigger_error('Calling ' . __METHOD__ . '() without the $entityTypeManager argument is deprecated in drupal:10.3.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3427050', E_USER_DEPRECATED);
            $this->entityTypeManager = \Drupal::entityTypeManager();
        }
        if (!isset($this->currentUser)) {
            @trigger_error('Calling ' . __METHOD__ . '() without the $currentUser argument is deprecated in drupal:10.3.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3427050', E_USER_DEPRECATED);
            $this->currentUser = \Drupal::currentUser();
        }
    }
    
    /**
     * {@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;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title
ShortcutLazyBuilders::$renderer protected property The renderer service.
ShortcutLazyBuilders::lazyLinks public function #lazy_builder callback; builds shortcut toolbar links.
ShortcutLazyBuilders::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
ShortcutLazyBuilders::__construct public function Constructs a new ShortcutLazyBuilders object.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING Deprecated constant Untrusted callbacks trigger E_USER_WARNING errors.

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