class FilterUrlToVideo in URL to Video Filter 2.0.x
Same name and namespace in other branches
- 8 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
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\url_to_video_filter\Plugin\Filter\FilterUrlToVideo implements ContainerFactoryPluginInterface
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of FilterUrlToVideo
File
- src/
Plugin/ Filter/ FilterUrlToVideo.php, line 28
Namespace
Drupal\url_to_video_filter\Plugin\FilterView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FilterBase:: |
public | property | The name of the provider that owns this filter. | |
FilterBase:: |
public | property | An associative array containing the configured settings of this filter. | |
FilterBase:: |
public | property | A Boolean indicating whether this filter is enabled. | |
FilterBase:: |
public | property | The weight of this filter compared to others in a filter collection. | |
FilterBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
1 |
FilterBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
FilterBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
FilterBase:: |
public | function |
Returns the administrative description for this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Returns HTML allowed by this filter's configuration. Overrides FilterInterface:: |
4 |
FilterBase:: |
public | function |
Returns the administrative label for this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Returns the processing type of this filter plugin. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Prepares the text for processing. Overrides FilterInterface:: |
|
FilterBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
1 |
FilterBase:: |
public | function |
Generates a filter's tip. Overrides FilterInterface:: |
9 |
FilterInterface:: |
constant | HTML tag and attribute restricting filters to prevent XSS attacks. | ||
FilterInterface:: |
constant | Non-HTML markup language filters that generate HTML. | ||
FilterInterface:: |
constant | Irreversible transformation filters. | ||
FilterInterface:: |
constant | Reversible transformation filters. | ||
FilterUrlToVideo:: |
protected | property | The Url to Video Filter Service. | |
FilterUrlToVideo:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
FilterUrlToVideo:: |
public | function |
Performs the filter processing. Overrides FilterInterface:: |
|
FilterUrlToVideo:: |
public | function |
Generates a filter's settings form. Overrides FilterBase:: |
|
FilterUrlToVideo:: |
public | function |
Constructs a UrlToVideoFilter object. Overrides FilterBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |