class ContextualLinks

Same name in this branch
  1. 9 core/modules/contextual/src/Plugin/views/field/ContextualLinks.php \Drupal\contextual\Plugin\views\field\ContextualLinks
Same name in other branches
  1. 8.9.x core/modules/contextual/src/Element/ContextualLinks.php \Drupal\contextual\Element\ContextualLinks
  2. 8.9.x core/modules/contextual/src/Plugin/views/field/ContextualLinks.php \Drupal\contextual\Plugin\views\field\ContextualLinks
  3. 10 core/modules/contextual/src/Element/ContextualLinks.php \Drupal\contextual\Element\ContextualLinks
  4. 10 core/modules/contextual/src/Plugin/views/field/ContextualLinks.php \Drupal\contextual\Plugin\views\field\ContextualLinks
  5. 11.x core/modules/contextual/src/Element/ContextualLinks.php \Drupal\contextual\Element\ContextualLinks
  6. 11.x core/modules/contextual/src/Plugin/views/field/ContextualLinks.php \Drupal\contextual\Plugin\views\field\ContextualLinks

Provides a contextual_links element.

Plugin annotation

@RenderElement("contextual_links");

Hierarchy

Expanded class hierarchy of ContextualLinks

2 #type uses of ContextualLinks
ContextualController::render in core/modules/contextual/src/ContextualController.php
Returns the requested rendered contextual links.
TestControllers::testContextual in core/modules/system/tests/modules/menu_test/src/TestControllers.php
Prints out test data with contextual links.

File

core/modules/contextual/src/Element/ContextualLinks.php, line 15

Namespace

Drupal\contextual\Element
View source
class ContextualLinks extends RenderElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#pre_render' => [
                [
                    $class,
                    'preRenderLinks',
                ],
            ],
            '#theme' => 'links__contextual',
            '#links' => [],
            '#attributes' => [
                'class' => [
                    'contextual-links',
                ],
            ],
            '#attached' => [
                'library' => [
                    'contextual/drupal.contextual-links',
                ],
            ],
        ];
    }
    
    /**
     * Pre-render callback: Builds a renderable array for contextual links.
     *
     * @param array $element
     *   A renderable array containing a #contextual_links property, which is a
     *   keyed array. Each key is the name of the group of contextual links to
     *   render (based on the 'group' key in the *.links.contextual.yml files for
     *   all enabled modules). The value contains an associative array containing
     *   the following keys:
     *   - route_parameters: The route parameters passed to the URL generator.
     *   - metadata: Any additional data needed in order to alter the link.
     *   @code
     *     array('#contextual_links' => array(
     *       'block' => array(
     *         'route_parameters' => array('block' => 'system.menu-tools'),
     *       ),
     *       'menu' => array(
     *         'route_parameters' => array('menu' => 'tools'),
     *       ),
     *     ))
     *   @endcode
     *
     * @return array
     *   A renderable array representing contextual links.
     */
    public static function preRenderLinks(array $element) {
        // Retrieve contextual menu links.
        $items = [];
        $contextual_links_manager = static::contextualLinkManager();
        foreach ($element['#contextual_links'] as $group => $args) {
            $args += [
                'route_parameters' => [],
                'metadata' => [],
            ];
            $items += $contextual_links_manager->getContextualLinksArrayByGroup($group, $args['route_parameters'], $args['metadata']);
        }
        uasort($items, [
            SortArray::class,
            'sortByWeightElement',
        ]);
        // Transform contextual links into parameters suitable for links.html.twig.
        $links = [];
        foreach ($items as $class => $item) {
            $class = Html::getClass($class);
            $links[$class] = [
                'title' => $item['title'],
                'url' => Url::fromRoute($item['route_name'] ?? '', $item['route_parameters'] ?? [], $item['localized_options']),
            ];
        }
        $element['#links'] = $links;
        // Allow modules to alter the renderable contextual links element.
        static::moduleHandler()->alter('contextual_links_view', $element, $items);
        // If there are no links, tell \Drupal::service('renderer')->render() to
        // abort rendering.
        if (empty($element['#links'])) {
            $element['#printed'] = TRUE;
        }
        return $element;
    }
    
    /**
     * Wraps the contextual link manager.
     *
     * @return \Drupal\Core\Menu\ContextualLinkManager
     */
    protected static function contextualLinkManager() {
        return \Drupal::service('plugin.manager.menu.contextual_link');
    }
    
    /**
     * Wraps the module handler.
     *
     * @return \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected static function moduleHandler() {
        return \Drupal::moduleHandler();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContextualLinks::contextualLinkManager protected static function Wraps the contextual link manager.
ContextualLinks::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
ContextualLinks::moduleHandler protected static function Wraps the module handler.
ContextualLinks::preRenderLinks public static function Pre-render callback: Builds a renderable array for contextual links.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

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