You are here

Home » API reference » Gutenberg 8 » MediaEntityBlockFilter.php

class MediaEntityBlockFilter in Gutenberg 8

Class MediaEntityBlockFilter.

Plugin annotation


@Filter(
  id = "filter_media_entity_block",
  title = @Translation("Gutenberg Media Entity Block filter"),
  description = @Translation("Embeds Drupal Media Entity blocks."),
  settings = {
  },
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
)

Hierarchy

Expanded class hierarchy of MediaEntityBlockFilter

File

src/Plugin/Filter/MediaEntityBlockFilter.php, line 23

Namespace

Drupal\gutenberg\Plugin\Filter
View source 
class MediaEntityBlockFilter extends FilterBase implements ContainerFactoryPluginInterface {

  /**
   * The media entity renderer.
   *
   * @var \Drupal\gutenberg\MediaEntityRendererInterface
   */
  protected $mediaEntityRenderer;

  /**
   * {@inheritDoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MediaEntityRendererInterface $media_entity_renderer_interface) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->mediaEntityRenderer = $media_entity_renderer_interface;
  }

  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('gutenberg.media_entity.renderer'));
  }

  /**
   * {@inheritDoc}
   */
  public function process($text, $langcode) {
    $content = preg_replace_callback('#(<!-- wp:drupalmedia\\/drupal-media-entity (\\{.*\\}) \\/-->)#', [
      $this,
      'render',
    ], $text);
    return new FilterProcessResult($content);
  }

  /**
   * The render function.
   *
   * Callbacks to preg replace from ::process method and returns rendered media
   * entity.
   *
   * @param array $match
   *   Array of preg matched items.
   *
   * @return string
   *   The rendered media entity.
   */
  protected function render(array $match) {
    if (!isset($match[2])) {
      return '';
    }
    $full_block_comment = str_replace('/-->', '-->', $match[1]);
    $block_config = json_decode($match[2], TRUE);
    if (json_last_error() !== JSON_ERROR_NONE || empty($block_config['mediaEntityIds'])) {
      return '';
    }
    $media_ouput = $this->mediaEntityRenderer
      ->render(reset($block_config['mediaEntityIds']), $block_config['viewMode'] ?? 'default');
    $output = $media_ouput;
    if (isset($block_config['caption'])) {
      $output = '<figure class="wp-block-drupalmedia-drupal-media-entity">' . $media_ouput . '<figcaption>' . $block_config['caption'] . '</figcaption></figure>';
    }
    return $full_block_comment . "\n" . $output . "\n<!-- /wp:drupalmedia/drupal-media-entity -->\n";
  }

}

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
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions 4
FilterBase::getLabel public function Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType public function Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare public function Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
FilterBase::settingsForm public function Generates a filter's settings form. Overrides FilterInterface::settingsForm 3
FilterBase::tips public function Generates a filter's tip. Overrides FilterInterface::tips 9
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
MediaEntityBlockFilter::$mediaEntityRenderer protected property The media entity renderer.
MediaEntityBlockFilter::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MediaEntityBlockFilter::process public function Performs the filter processing. Overrides FilterInterface::process
MediaEntityBlockFilter::render protected function The render function.
MediaEntityBlockFilter::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides FilterBase::__construct
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.
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.