class ContextualLinksPlaceholder

Same name and namespace in other branches
  1. 9 core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder
  2. 8.9.x core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder
  3. 11.x core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder

Provides a contextual_links_placeholder element.

Hierarchy

Expanded class hierarchy of ContextualLinksPlaceholder

File

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

Namespace

Drupal\contextual\Element
View source
class ContextualLinksPlaceholder extends RenderElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#pre_render' => [
        [
          $class,
          'preRenderPlaceholder',
        ],
      ],
      '#id' => NULL,
    ];
  }
  
  /**
   * Pre-render callback: Renders a contextual links placeholder into #markup.
   *
   * Renders an empty (hence invisible) placeholder div with a data-attribute
   * that contains an identifier ("contextual id"), which allows the JavaScript
   * of the drupal.contextual-links library to dynamically render contextual
   * links.
   *
   * @param array $element
   *   A structured array with #id containing a "contextual id".
   *
   * @return array
   *   The passed-in element with a contextual link placeholder in '#markup'.
   *
   * @see _contextual_links_to_id()
   */
  public static function preRenderPlaceholder(array $element) {
    $token = Crypt::hmacBase64($element['#id'], Settings::getHashSalt() . \Drupal::service('private_key')->get());
    $attribute = new Attribute([
      'data-contextual-id' => $element['#id'],
      'data-contextual-token' => $token,
      'data-drupal-ajax-container' => '',
    ]);
    $element['#markup'] = new FormattableMarkup('<div@attributes></div>', [
      '@attributes' => $attribute,
    ]);
    return $element;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContextualLinksPlaceholder::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
ContextualLinksPlaceholder::preRenderPlaceholder public static function Pre-render callback: Renders a contextual links placeholder into #markup.
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
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2

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