You are here

Home » API reference » Simple oEmbed 8.2 » SoEmbedFilter.php

class SoEmbedFilter in Simple oEmbed 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/Filter/SoEmbedFilter.php \Drupal\soembed\Plugin\Filter\SoEmbedFilter

Provides a filter to embed media via oEmbed.

Plugin annotation


@Filter(
  id = "filter_soembed",
  title = @Translation("Simple oEmbed filter"),
  description = @Translation("Embeds media for URL that supports oEmbed standard."),
  settings = {
    "soembed_maxwidth" = 0,
    "soembed_replace_inline" = FALSE
  },
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
)

Hierarchy

Expanded class hierarchy of SoEmbedFilter

File

src/Plugin/Filter/SoEmbedFilter.php, line 35

Namespace

Drupal\soembed\Plugin\Filter
View source 
class SoEmbedFilter extends FilterBase implements ContainerFactoryPluginInterface {

  /**
   * The media settings config.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * The logger service.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The oEmbed resource fetcher.
   *
   * @var \Drupal\media\OEmbed\ResourceFetcherInterface
   */
  protected $resourceFetcher;

  /**
   * The oEmbed URL resolver service.
   *
   * @var \Drupal\media\OEmbed\UrlResolverInterface
   */
  protected $urlResolver;

  /**
   * The iFrame URL helper service.
   *
   * @var \Drupal\media\IFrameUrlHelper
   */
  protected $iFrameUrlHelper;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a new OEmbed instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger factory service.
   * @param \Drupal\media\OEmbed\ResourceFetcherInterface $resource_fetcher
   *   The oEmbed resource fetcher service.
   * @param \Drupal\media\OEmbed\UrlResolverInterface $url_resolver
   *   The oEmbed URL resolver service.
   * @param \Drupal\media\IFrameUrlHelper $iframe_url_helper
   *   The iFrame URL helper service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, LoggerChannelFactoryInterface $logger_factory, ResourceFetcherInterface $resource_fetcher, UrlResolverInterface $url_resolver, IFrameUrlHelper $iframe_url_helper, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->config = $config_factory
      ->get('media.settings');
    $this->logger = $logger_factory
      ->get('media');
    $this->resourceFetcher = $resource_fetcher;
    $this->urlResolver = $url_resolver;
    $this->iFrameUrlHelper = $iframe_url_helper;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('logger.factory'), $container
      ->get('media.oembed.resource_fetcher'), $container
      ->get('media.oembed.url_resolver'), $container
      ->get('media.oembed.iframe_url_helper'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $lines = explode("\n", $text);
    if (!empty($this->settings['soembed_replace_inline'])) {
      $lines = preg_replace_callback('#([^"])(https?://[^\\s<]+)([^"])#', [
        $this,
        'embed',
      ], $lines);
    }
    else {
      $lines = preg_replace_callback('#^(<p>)?(https?://\\S+?)(</p>)?$#', [
        $this,
        'embed',
      ], $lines);
    }
    $text = implode("\n", $lines);
    return new FilterProcessResult($text);
  }

  /**
   * Turn URL into iframe via oEmbed.
   *
   * Most code copied from Drupal\media\Plugin\Field\FieldFormatter::viewElements().
   */
  private function embed($match) {
    $value = $match[2];
    $max_width = $this->settings['soembed_maxwidth'];
    $max_height = 0;
    try {
      $resource_url = $this->urlResolver
        ->getResourceUrl($value, $max_width, $max_height);
      $resource = $this->resourceFetcher
        ->fetchResource($resource_url);
    } catch (ResourceException $exception) {
      $this->logger
        ->error("Could not retrieve the remote URL (@url).", [
        '@url' => $value,
      ]);
      return $match[0];
    }
    if ($resource
      ->getType() === Resource::TYPE_LINK) {
      $build = [
        '#title' => $resource
          ->getTitle(),
        '#type' => 'link',
        '#url' => Url::fromUri($value),
      ];
    }
    elseif ($resource
      ->getType() === Resource::TYPE_PHOTO) {
      $build = [
        '#theme' => 'image',
        '#uri' => $resource
          ->getUrl()
          ->toString(),
        '#width' => $max_width ?: $resource
          ->getWidth(),
        '#height' => $max_height ?: $resource
          ->getHeight(),
      ];
    }
    else {
      $url = Url::fromRoute('media.oembed_iframe', [], [
        'query' => [
          'url' => $value,
          'max_width' => $max_width,
          'max_height' => $max_height,
          'hash' => $this->iFrameUrlHelper
            ->getHash($value, $max_width, $max_height),
        ],
      ]);
      $domain = $this->config
        ->get('iframe_domain');
      if ($domain) {
        $url
          ->setOption('base_url', $domain);
      }

      // Render videos and rich content in an iframe for security reasons.
      // @see: https://oembed.com/#section3
      $build = [
        '#type' => 'html_tag',
        '#tag' => 'iframe',
        '#attributes' => [
          'src' => $url
            ->toString(),
          'frameborder' => 0,
          'scrolling' => FALSE,
          'allowtransparency' => TRUE,
          'width' => $max_width ?: $resource
            ->getWidth(),
          'height' => $max_height ?: $resource
            ->getHeight(),
          'class' => [
            'media-oembed-content',
          ],
        ],
        '#attached' => [
          'library' => [
            'media/oembed.formatter',
          ],
        ],
      ];

      // An empty title attribute will disable title inheritance, so only
      // add it if the resource has a title.
      $title = $resource
        ->getTitle();
      if ($title) {
        $build['#attributes']['title'] = $title;
      }
      CacheableMetadata::createFromObject($resource)
        ->addCacheTags($this->config
        ->getCacheTags())
        ->applyTo($build);
    }
    return $match[1] . $this->renderer
      ->render($build) . $match[3];
  }

  /**
   * Define settings for text filter.
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['soembed_maxwidth'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum width of media embed'),
      '#default_value' => $this->settings['soembed_maxwidth'],
      '#description' => $this
        ->t('Leave to zero to use original values.'),
    ];
    $form['soembed_replace_inline'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Replace in-line URLs'),
      '#default_value' => $this->settings['soembed_replace_inline'],
      '#description' => $this
        ->t('If this option is checked, the filter will recognize URLs even when they are not on their own line.'),
    ];
    return $form;
  }

}

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::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.
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.
SoEmbedFilter::$config protected property The media settings config.
SoEmbedFilter::$iFrameUrlHelper protected property The iFrame URL helper service.
SoEmbedFilter::$logger protected property The logger service.
SoEmbedFilter::$renderer protected property The renderer.
SoEmbedFilter::$resourceFetcher protected property The oEmbed resource fetcher.
SoEmbedFilter::$urlResolver protected property The oEmbed URL resolver service.
SoEmbedFilter::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SoEmbedFilter::embed private function Turn URL into iframe via oEmbed.
SoEmbedFilter::process public function Performs the filter processing. Overrides FilterInterface::process
SoEmbedFilter::settingsForm public function Define settings for text filter. Overrides FilterBase::settingsForm
SoEmbedFilter::__construct public function Constructs a new OEmbed instance. Overrides FilterBase::__construct
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.