class FilterSettingsEmbedMedia in Media Migration 8

Adds media_plugin or entity_embed tokens to filter_html's allowed html.

process:
  destination_property:
    plugin: filter_settings_embed_media
    source: source_property

Plugin annotation

@MigrateProcessPlugin(
  id = "filter_settings_embed_media",
  handle_multiples = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\media_migration\Plugin\migrate\process\FilterSettingsEmbedMedia

File

src/Plugin/migrate/process/FilterSettingsEmbedMedia.php, line 26

Namespace

Drupal\media_migration\Plugin\migrate\process

class FilterSettingsEmbedMedia extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $destination_filter_plugin_id = MediaMigration::getEmbedTokenDestinationFilterPlugin();
    if (!MediaMigration::embedTokenDestinationFilterPluginIsValid($destination_filter_plugin_id)) {
      throw new MigrateException("The embed token's destination filter plugin ID is invalid.");
    }
    if ($row
      ->getDestinationProperty('id') === 'filter_html') {
      switch ($destination_filter_plugin_id) {
        case MediaMigration::MEDIA_TOKEN_DESTINATION_FILTER_ENTITY_EMBED:
          $tag_to_add = '<drupal-entity data-*>';
          break;
        case MediaMigration::MEDIA_TOKEN_DESTINATION_FILTER_MEDIA_EMBED:
          $tag_to_add = '<drupal-media data-* alt title>';
          break;
      }
      if (empty($tag_to_add)) {
        return $value;
      }
      $value['allowed_html'] = ltrim("{$value['allowed_html']} {$tag_to_add}");
    }

    // The Drupal 7 "media_filter" filter (Media WYSIWYG module) did not have
    // any settings, but the Drupal 8|9 "media_embed" filter does have (and it
    // also specifies defaults). The D8|9 "media_embed" filter implements
    // calculateDependencies() to ensure any text format that uses it also has
    // the appropriate configuration dependencies. In this logic, it inspects
    // the "media_embed" filter settings. When those settings are not specified
    // (which they should be given they're in the default settings in the filter
    // plugin annotation), then the dependency calculation triggers a fatal
    // error.
    // To prevent that, we apply the defaults manually here.
    // @todo Remove this when https://drupal.org/i/3166930 gets fixed.
    // @see https://drupal.org/i/3167525
    if ($row
      ->getDestinationProperty('id') === 'media_embed') {

      // @see \Drupal\media\Plugin\Filter\MediaEmbed
      $value += [
        'default_view_mode' => 'default',
        'allowed_view_modes' => [],
        'allowed_media_types' => [],
      ];
    }
    return $value;
  }

}

Members

Name	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
FilterSettingsEmbedMedia::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
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
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
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.