AmpIframe.php in Accelerated Mobile Pages (AMP) 8

Contains \Drupal\amp\Element\AmpIframe.

Namespace

Drupal\amp\Element

File

src/Element/AmpIframe.php

<?php

/**
 * @file
 * Contains \Drupal\amp\Element\AmpIframe.
 */
namespace Drupal\amp\Element;

use Drupal\filter\Element\ProcessedText;
use Lullabot\AMP\AMP;
use Drupal\amp\Service\AMPService;

/**
 * Provides a render element for an iframe rendered as an amp-iframe.
 *
 * By default, this element sets #theme so that the 'amp_iframe' theme hook is used
 * for rendering, and attaches the js needed for the amp-iframe component. See
 * template_preprocess_amp_iframe() for documentation on the  properties used in
 * theming.
 *
 * Properties:
 * - #iframe: An array with iframe details. See template_preprocess_amp_iframe()
 *   for documentation of the properties in this array.
 *
 * @RenderElement("amp_iframe")
 */
class AmpIframe extends ProcessedText {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#text' => '',
      '#format' => NULL,
      '#filter_types_to_skip' => array(),
      '#langcode' => '',
      '#pre_render' => array(
        array(
          $class,
          'preRenderText',
        ),
        array(
          $class,
          'preRenderAmpIframe',
        ),
      ),
      '#theme' => 'amp_iframe',
      '#cache' => [
        'contexts' => [
          'url.query_args:amp',
          'url.query_args:warnfix',
        ],
        'tags' => [
          'config:amp.settings',
        ],
      ],
    );
  }

  /**
   * Pre-render callback: Attaches the amp-iframe library and required markup.
   */
  public static function preRenderAmpIframe($element) {

    /** @var AMPService $amp_service */
    $amp_service = \Drupal::getContainer()
      ->get('amp.utilities');

    /** @var AMP $amp */
    $amp = $amp_service
      ->createAMPConverter();
    $amp
      ->loadHtml($element['#markup']);
    $element['#markup'] = $amp
      ->convertToAmpHtml();
    $element['#iframe'] = [
      '#markup' => t($element['#markup']),
    ];
    $element['#iframe']['#attached']['library'][] = 'amp/amp.iframe';
    return $element;
  }

}

Classes

Name	Description
AmpIframe	Provides a render element for an iframe rendered as an amp-iframe.