You are here

class VideoEmbedIFrame in Video Embed Field 8

Same name and namespace in other branches
  1. 8.2 src/Element/VideoEmbedIFrame.php \Drupal\video_embed_field\Element\VideoEmbedIFrame

Providers an element design for embedding iframes.

Plugin annotation

@RenderElement("video_embed_iframe");

Hierarchy

Expanded class hierarchy of VideoEmbedIFrame

5 #type uses of VideoEmbedIFrame
FieldOutputTest::renderedFieldTestCases in tests/src/Kernel/FieldOutputTest.php
The test cases.
VideoEmbedIFrameTest::videoEmbedIframeTestCases in tests/src/Kernel/VideoEmbedIFrameTest.php
Test cases for the embed iframe.
Vimeo::renderEmbedCode in src/Plugin/video_embed_field/Provider/Vimeo.php
Render embed code.
YouTube::renderEmbedCode in src/Plugin/video_embed_field/Provider/YouTube.php
Render embed code.
YouTubePlaylist::renderEmbedCode in src/Plugin/video_embed_field/Provider/YouTubePlaylist.php
Render embed code.

File

src/Element/VideoEmbedIFrame.php, line 13

Namespace

Drupal\video_embed_field\Element
View source
class VideoEmbedIFrame extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#theme' => 'video_embed_iframe',
      '#provider' => '',
      '#url' => '',
      '#query' => [],
      '#attributes' => [],
      '#fragment' => [],
      '#pre_render' => [
        [
          static::class,
          'preRenderInlineFrameEmbed',
        ],
      ],
    ];
  }

  /**
   * Transform the render element structure into a renderable one.
   *
   * @param array $element
   *   An element array before being processed.
   *
   * @return array
   *   The processed and renderable element.
   */
  public static function preRenderInlineFrameEmbed($element) {
    $element['#theme'] .= !empty($element['#provider']) ? '__' . $element['#provider'] : '';
    if (is_array($element['#attributes'])) {
      $element['#attributes'] = new Attribute($element['#attributes']);
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
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.
VideoEmbedIFrame::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
VideoEmbedIFrame::preRenderInlineFrameEmbed public static function Transform the render element structure into a renderable one.