class AmpIframe in Accelerated Mobile Pages (AMP) 8

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.

Plugin annotation

@RenderElement("amp_iframe");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\filter\Element\ProcessedText
        • class \Drupal\amp\Element\AmpIframe

1 #type use of AmpIframe

AmpIframeFormatter::viewElements in src/Plugin/Field/FieldFormatter/AmpIframeFormatter.php

Builds a renderable array for a field value.

File

src/Element/AmpIframe.php, line 29

Contains \Drupal\amp\Element\AmpIframe.

Namespace

Drupal\amp\Element

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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AmpIframe::getInfo	public	function	Returns the element properties for this element. Overrides ProcessedText::getInfo
AmpIframe::preRenderAmpIframe	public static	function	Pre-render callback: Attaches the amp-iframe library and required markup.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessedText::configFactory	protected static	function	Wraps the config factory.
ProcessedText::logger	protected static	function	Wraps a logger channel.
ProcessedText::preRenderText	public static	function	Pre-render callback: Renders a processed text element into #markup.
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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.