You are here

Home » API reference » URL to Video Filter 8 » FilterUrlToVideo.php

class FilterUrlToVideo in URL to Video Filter 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Filter/FilterUrlToVideo.php \Drupal\url_to_video_filter\Plugin\Filter\FilterUrlToVideo

Provides a filter to convert various video sharing website URLs to links.

Plugin annotation


@Filter(
  id = "filter_url_to_video",
  title = @Translation("Convert URLs to embedded videos"),
  description = @Translation("Converts URLs for various video sites and converts them to embedded videos"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE,
  settings = {
     "youtube" = true,
     "youtube_webp_preview" = false,
     "autoload" = false,
     "vimeo" = true,
  }
)

Hierarchy

Expanded class hierarchy of FilterUrlToVideo

File

src/Plugin/Filter/FilterUrlToVideo.php, line 28

Namespace

Drupal\url_to_video_filter\Plugin\Filter
View source 
class FilterUrlToVideo extends FilterBase implements ContainerFactoryPluginInterface {

  /**
   * The Url to Video Filter Service.
   *
   * @var \Drupal\url_to_video_filter\Service\UrlToVideoFilterServiceInterface
   */
  protected $urlToVideoFilterService;

  /**
   * Constructs a UrlToVideoFilter object.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\url_to_video_filter\Service\UrlToVideoFilterServiceInterface $urlToVideoFilterService
   *   The Url to Video Filter Service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, UrlToVideoFilterServiceInterface $urlToVideoFilterService) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->urlToVideoFilterService = $urlToVideoFilterService;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('url_to_video_filter.service'));
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $youtube_found = FALSE;
    $vimeo_found = FALSE;

    // Process YouTube URLs.
    if ($this->settings['youtube']) {
      $filter = $this->urlToVideoFilterService
        ->convertYouTubeUrls($text);
      $text = $filter['text'];
      $youtube_found = $filter['url_found'];
    }

    // Process Vimeo Urls.
    if ($this->settings['vimeo']) {
      $filter = $this->urlToVideoFilterService
        ->convertVimeoUrls($text);
      $text = $filter['text'];
      $vimeo_found = $filter['url_found'];
    }
    $libraries = [];
    $result = new FilterProcessResult($text);
    if ($youtube_found) {
      $libraries[] = 'url_to_video_filter/youtube_embed';
    }
    if ($vimeo_found) {
      $libraries[] = 'url_to_video_filter/vimeo_embed';
    }
    $js_settings['urlToVideoFilter'] = [];
    if ($this->settings['youtube'] && $this->settings['youtube_webp_preview']) {
      $js_settings['urlToVideoFilter']['youtubeWebp'] = TRUE;
    }
    if ($this->settings['autoload']) {
      $js_settings['urlToVideoFilter']['autoload'] = TRUE;
    }
    $result
      ->setAttachments([
      'drupalSettings' => $js_settings,
      'library' => $libraries,
    ]);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {

    // Enable filtering for YouTube URLs.
    $form['youtube'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Filter for YouTube URLs'),
      '#default_value' => $this->settings['youtube'],
    ];
    $form['youtube_webp_preview'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use webp image for YouTube preview'),
      '#description' => $this
        ->t('Warning - not compatible with some browsers'),
      '#default_value' => $this->settings['youtube_webp_preview'],
      '#states' => [
        'visible' => [
          '#edit-filters-filter-url-to-video-settings-youtube' => [
            'checked' => TRUE,
          ],
          '#edit-filters-filter-url-to-video-settings-autoload' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];

    // Enable filtering for Vimeo URLs.
    $form['vimeo'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Filter for Vimeo URLs'),
      '#default_value' => $this->settings['vimeo'],
    ];
    $form['autoload'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Autoload players when page has loaded.'),
      '#default_value' => $this->settings['autoload'],
    ];
    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.
FilterUrlToVideo::$urlToVideoFilterService protected property The Url to Video Filter Service.
FilterUrlToVideo::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FilterUrlToVideo::process public function Performs the filter processing. Overrides FilterInterface::process
FilterUrlToVideo::settingsForm public function Generates a filter's settings form. Overrides FilterBase::settingsForm
FilterUrlToVideo::__construct public function Constructs a UrlToVideoFilter 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.