EWPP-82: Allow to configure a text format for the video iframe source.

modules/oe_media_iframe/config/install/core.entity_form_display.media.video_iframe.default.yml

@@ -9,6 +9,7 @@ dependencies:
     - media.type.video_iframe
   module:
     - image
+    - oe_media_iframe
 id: media.video_iframe.default
 targetEntityType: media
 bundle: video_iframe
@@ -42,7 +43,7 @@ content:
       rows: 5
       placeholder: ''
     third_party_settings: {  }
-    type: string_textarea
+    type: oe_media_iframe_textarea
     region: content
   oe_media_iframe_ratio:
     weight: 3

modules/oe_media_iframe/config/install/filter.format.oe_media_iframe.yml

@@ -0,0 +1,16 @@
+langcode: en
+status: true
+dependencies: {  }
+name: 'Iframe media'
+format: oe_media_iframe
+weight: 0
+filters:
+  filter_html:
+    id: filter_html
+    provider: filter
+    status: true
+    weight: -10
+    settings:
+      allowed_html: '<iframe allowfullscreen height importance loading name referrerpolicy sandbox src width mozallowfullscreen webkitAllowFullScreen scrolling frameborder>'
+      filter_html_help: true
+      filter_html_nofollow: false

modules/oe_media_iframe/config/install/media.type.video_iframe.yml

@@ -11,4 +11,5 @@ queue_thumbnail_downloads: false
 new_revision: false
 source_configuration:
   source_field: oe_media_iframe
+  text_format: oe_media_iframe
 field_map: {  }

modules/oe_media_iframe/config/schema/oe_media_iframe.schema.yml

@@ -1,3 +1,11 @@
 media.source.oe_media_iframe:
   type: media.source.field_aware
   label: '"Video iframe" media source configuration'
+  mapping:
+    text_format:
+      type: string
+      label: 'Text format'
+
+field.widget.settings.oe_media_iframe_textarea:
+  type: field.widget.settings.string_textarea
+  label: 'Textarea display format settings'

modules/oe_media_iframe/oe_media_iframe.info.yml

@@ -6,6 +6,7 @@ type: module
 core: 8.x
 
 dependencies:
+  - drupal:filter
   - drupal:options
   - media:media
 
@@ -19,4 +20,5 @@ config_devel:
     - field.field.media.video_iframe.oe_media_iframe
     - field.field.media.video_iframe.oe_media_iframe_ratio
     - field.field.media.video_iframe.oe_media_iframe_thumbnail
+    - filter.format.oe_iframe_media
     - media.type.video_iframe

modules/oe_media_iframe/oe_media_iframe.post_update.php

@@ -52,3 +52,48 @@ function oe_media_iframe_post_update_00001(): void {
     ])->save();
   }
 }
+
+/**
+ * Incorporate text format setting into Iframe media source.
+ */
+function oe_media_iframe_post_update_00002(): void {
+  $format = \Drupal::entityTypeManager()->getStorage('filter_format')->load('oe_media_iframe');
+  if (!$format) {
+    $format = \Drupal::entityTypeManager()->getStorage('filter_format')->create([
+      'format' => 'oe_media_iframe',
+      'name' => 'Iframe Media',
+      'filters' => [
+        'filter_html' => [
+          'settings' => [
+            'allowed_html' => '<iframe allowfullscreen height importance loading name referrerpolicy sandbox src width mozallowfullscreen webkitAllowFullScreen scrolling frameborder>',
+          ],
+          'status' => TRUE,
+        ],
+      ],
+    ]);
+    $format->save();
+  }
+
+  $entity_form_storage = \Drupal::entityTypeManager()->getStorage('entity_form_display');
+  $form_display = $entity_form_storage->load('media.video_iframe.default');
+  $source_field = $form_display->getComponent('oe_media_iframe');
+  if ($source_field) {
+    $source_field['type'] = 'oe_media_iframe_textarea';
+    $form_display->setComponent('oe_media_iframe', $source_field);
+    $form_display->save();
+    // We have to remove cache record directly because we can't invalidate
+    // this cache record by tags ('cache_config' table have empty 'tags' field).
+    // \Drupal::cache('config')->invalidate() do not work either because core,
+    // for some reason, does not check the validity of the cache record.
+    \Drupal::cache('config')->delete('core.entity_form_display.media.video_iframe.default');
+  }
+  $media_type_storage = \Drupal::entityTypeManager()->getStorage('media_type');
+  $iframe_types = $media_type_storage->loadByProperties(['source' => 'oe_media_iframe']);
+  foreach ($iframe_types as $iframe_media_type) {
+    $settings = $iframe_media_type->getSource()->getConfiguration();
+    $settings['text_format'] = 'oe_media_iframe';
+    $iframe_media_type->set('source_configuration', $settings);
+    $iframe_media_type->save();
+  }
+
+}

modules/oe_media_iframe/src/Plugin/Field/FieldFormatter/MediaIframeFormatter.php

@@ -4,10 +4,14 @@
 
 namespace Drupal\oe_media_iframe\Plugin\Field\FieldFormatter;
 
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Field\FormatterBase;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\oe_media_iframe\Plugin\media\Source\Iframe;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Plugin implementation for the "oe_media_iframe" formatter plugin.
@@ -21,7 +25,55 @@
  *   }
  * )
  */
-class MediaIframeFormatter extends FormatterBase {
+class MediaIframeFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Constructs a MediaIframeFormatter instance.
+   *
+   * @param string $plugin_id
+   *   The plugin_id for the formatter.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
+   *   The definition of the field to which the formatter is associated.
+   * @param array $settings
+   *   The formatter settings.
+   * @param string $label
+   *   The formatter label display setting.
+   * @param string $view_mode
+   *   The view mode.
+   * @param array $third_party_settings
+   *   Any third party settings settings.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   */
+  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager) {
+    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
+    $this->entityTypeManager = $entity_type_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $plugin_id,
+      $plugin_definition,
+      $configuration['field_definition'],
+      $configuration['settings'],
+      $configuration['label'],
+      $configuration['view_mode'],
+      $configuration['third_party_settings'],
+      $container->get('entity_type.manager')
+    );
+  }
 
   /**
    * {@inheritdoc}
@@ -48,13 +100,34 @@ public static function isApplicable(FieldDefinitionInterface $field_definition)
   public function viewElements(FieldItemListInterface $items, $langcode) {
     $elements = [];
 
+    $media_type = $this->entityTypeManager->getStorage('media_type')->load($this->fieldDefinition->getTargetBundle());
+    // Add cacheable dependency from the media type.
+    $cacheable_metadata = CacheableMetadata::createFromRenderArray($elements)
+      ->addCacheableDependency($media_type);
+
+    $text_format = $media_type->getSource()->getConfiguration()['text_format'] ?? NULL;
+
     foreach ($items as $delta => $item) {
+      if ($text_format) {
+        $elements[$delta] = [
+          '#type' => 'processed_text',
+          '#text' => $item->value,
+          '#format' => $text_format,
+        ];
+
+        $cacheable_metadata->addCacheableDependency($this->entityTypeManager->getStorage('filter_format')->load($text_format));
+        continue;
+      }
+
+      // Fallback in case we don't have a selected text format.
       $elements[$delta] = [
         '#markup' => $item->value,
         '#allowed_tags' => ['iframe'],
       ];
     }
 
+    $cacheable_metadata->applyTo($elements);
+
     return $elements;
   }
 

modules/oe_media_iframe/src/Plugin/Field/FieldWidget/MediaIframeWidget.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_media_iframe\Plugin\Field\FieldWidget;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Field\FieldDefinitionInterface;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\oe_media_iframe\Plugin\media\Source\Iframe;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Plugin implementation for the "oe_media_iframe" widget plugin.
+ *
+ * @FieldWidget(
+ *   id = "oe_media_iframe_textarea",
+ *   label = @Translation("Media iframe text area"),
+ *   description = @Translation("Text area field widget with information about selected text format in the Iframe media source."),
+ *   field_types = {
+ *     "string_long"
+ *   }
+ * )
+ */
+class MediaIframeWidget extends StringTextareaWidget {
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Constructs a MediaIframeWidget object.
+   *
+   * @param string $plugin_id
+   *   The plugin_id for the widget.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
+   *   The definition of the field to which the widget is associated.
+   * @param array $settings
+   *   The widget settings.
+   * @param array $third_party_settings
+   *   Any third party settings.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   */
+  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager) {
+    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
+    $this->entityTypeManager = $entity_type_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $plugin_id,
+      $plugin_definition,
+      $configuration['field_definition'],
+      $configuration['settings'],
+      $configuration['third_party_settings'],
+      $container->get('entity_type.manager')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function isApplicable(FieldDefinitionInterface $field_definition) {
+    if ($field_definition->getTargetEntityTypeId() !== 'media') {
+      return FALSE;
+    }
+
+    $bundle_id = $field_definition->getTargetBundle();
+    if ($bundle_id === NULL) {
+      return FALSE;
+    }
+
+    /** @var \Drupal\media\MediaTypeInterface $media_type */
+    $media_type = \Drupal::entityTypeManager()->getStorage('media_type')->load($bundle_id);
+
+    return $media_type && $media_type->getSource() instanceof Iframe;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
+    $element = parent::formElement($items, $delta, $element, $form, $form_state);
+
+    $media_type = $this->entityTypeManager->getStorage('media_type')->load($this->fieldDefinition->getTargetBundle());
+    $format_id = $media_type->getSource()->getConfiguration()['text_format'] ?? NULL;
+
+    if ($format_id) {
+      $format = $this->entityTypeManager->getStorage('filter_format')->load($format_id);
+      $element['format']['guidelines'][$format->id()] = [
+        '#theme' => 'filter_tips',
+        '#tips' => _filter_tips($format->id(), FALSE),
+      ];
+    }
+
+    return $element;
+  }
+
+}