trait CommandWithAttachedAssetsTrait

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait
  2. 8.9.x core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait
  3. 11.x core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait

Trait for Ajax commands that render content and attach assets.

Hierarchy

Related topics

File

core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php, line 12

Namespace

Drupal\Core\Ajax
View source
trait CommandWithAttachedAssetsTrait {
  
  /**
   * The attached assets for this Ajax command.
   *
   * @var \Drupal\Core\Asset\AttachedAssets
   */
  protected $attachedAssets;
  
  /**
   * Processes the content for output.
   *
   * If content is a render array, it may contain attached assets to be
   * processed.
   *
   * @return string|\Drupal\Component\Render\MarkupInterface
   *   HTML rendered content.
   */
  protected function getRenderedContent() {
    $this->attachedAssets = new AttachedAssets();
    if (is_array($this->content)) {
      if (!$this->content) {
        return '';
      }
      $html = \Drupal::service('renderer')->renderRoot($this->content);
      $this->attachedAssets = AttachedAssets::createFromRenderArray($this->content);
      return $html;
    }
    else {
      return $this->content;
    }
  }
  
  /**
   * Gets the attached assets.
   *
   * @return \Drupal\Core\Asset\AttachedAssets|null
   *   The attached assets for this command.
   */
  public function getAttachedAssets() {
    return $this->attachedAssets;
  }

}

Members

Title Sort descending Modifiers Object type Summary
CommandWithAttachedAssetsTrait::$attachedAssets protected property The attached assets for this Ajax command.
CommandWithAttachedAssetsTrait::getAttachedAssets public function Gets the attached assets.
CommandWithAttachedAssetsTrait::getRenderedContent protected function Processes the content for output.

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