You are here

CommandWithAttachedAssetsTrait.php in Zircon Profile 8

Same filename and directory in other branches
  1. 8.0 core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php

Namespace

Drupal\Core\Ajax

File

core/lib/Drupal/Core/Ajax/CommandWithAttachedAssetsTrait.php
View source
<?php

/**
 * @file
 * Contains \Drupal\Core\Ajax\CommandWithAttachedAssetsTrait.
 */
namespace Drupal\Core\Ajax;

use Drupal\Core\Asset\AttachedAssets;

/**
 * Trait for Ajax commands that render content and attach assets.
 *
 * @ingroup ajax
 */
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)) {
      $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;
  }

}

Traits

Namesort descending Description
CommandWithAttachedAssetsTrait Trait for Ajax commands that render content and attach assets.