class VideoEmbedWysiwyg in Video Embed Field 8.2
Same name in this branch
- 8.2 modules/video_embed_wysiwyg/src/Plugin/Filter/VideoEmbedWysiwyg.php \Drupal\video_embed_wysiwyg\Plugin\Filter\VideoEmbedWysiwyg
- 8.2 modules/video_embed_wysiwyg/src/Plugin/CKEditorPlugin/VideoEmbedWysiwyg.php \Drupal\video_embed_wysiwyg\Plugin\CKEditorPlugin\VideoEmbedWysiwyg
Same name and namespace in other branches
- 8 modules/video_embed_wysiwyg/src/Plugin/Filter/VideoEmbedWysiwyg.php \Drupal\video_embed_wysiwyg\Plugin\Filter\VideoEmbedWysiwyg
The filter to turn tokens inserted into the WYSIWYG into videos.
Plugin annotation
@Filter(
title = @Translation("Video Embed WYSIWYG"),
id = "video_embed_wysiwyg",
description = @Translation("Enables the use of video_embed_wysiwyg."),
type = Drupal\filter\Plugin\FilterInterface::TYPE_MARKUP_LANGUAGE
)
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\video_embed_wysiwyg\Plugin\Filter\VideoEmbedWysiwyg implements ContainerFactoryPluginInterface
- class \Drupal\filter\Plugin\FilterBase implements FilterInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of VideoEmbedWysiwyg
File
- modules/
video_embed_wysiwyg/ src/ Plugin/ Filter/ VideoEmbedWysiwyg.php, line 25
Namespace
Drupal\video_embed_wysiwyg\Plugin\FilterView source
class VideoEmbedWysiwyg extends FilterBase implements ContainerFactoryPluginInterface {
/**
* The video provider manager.
*
* @var \Drupal\video_embed_field\ProviderManagerInterface
*/
protected $providerManager;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* VideoEmbedWysiwyg constructor.
*
* @param array $configuration
* Plugin configuration.
* @param string $plugin_id
* Plugin ID.
* @param mixed $plugin_definition
* Plugin definition.
* @param \Drupal\video_embed_field\ProviderManagerInterface $provider_manager
* The video provider manager.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
* @param \Drupal\Core\Session\AccountProxyInterface $current_user
* The current user.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ProviderManagerInterface $provider_manager, RendererInterface $renderer, AccountProxyInterface $current_user) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->providerManager = $provider_manager;
$this->renderer = $renderer;
$this->currentUser = $current_user;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('video_embed_field.provider_manager'), $container
->get('renderer'), $container
->get('current_user'));
}
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
$response = new FilterProcessResult($text);
foreach ($this
->getValidMatches($text) as $source_text => $embed_data) {
if (!($provider = $this->providerManager
->loadProviderFromInput($embed_data['video_url']))) {
continue;
}
$autoplay = $this->currentUser
->hasPermission('never autoplay videos') ? FALSE : $embed_data['settings']['autoplay'];
$embed_code = $provider
->renderEmbedCode($embed_data['settings']['width'], $embed_data['settings']['height'], $autoplay);
$embed_code = [
'#type' => 'container',
'#attributes' => [
'class' => [
Html::cleanCssIdentifier(sprintf('video-embed-field-provider-%s', $provider
->getPluginId())),
],
],
'children' => $embed_code,
];
// Add the container to make the video responsive if it's been
// configured as such. This usually is attached to field output in the
// case of a formatter, but a custom container must be used where one is
// not present.
if ($embed_data['settings']['responsive']) {
$embed_code['#attributes']['class'][] = 'video-embed-field-responsive-video';
}
// Replace the JSON settings with a video.
$text = str_replace($source_text, $this->renderer
->render($embed_code), $text);
// Add the required responsive video library only when at least one match
// is present.
$response
->setAttachments([
'library' => [
'video_embed_field/responsive-video',
],
]);
$response
->setCacheContexts([
'user.permissions',
]);
}
$response
->setProcessedText($text);
return $response;
}
/**
* Get all valid matches in the WYSIWYG.
*
* @param string $text
* The text to check for WYSIWYG matches.
*
* @return array
* An array of data from the text keyed by the text content.
*/
protected function getValidMatches($text) {
// Use a look ahead to match the capture groups in any order.
if (!preg_match_all('/(<p>)?(?<json>{(?=.*preview_thumbnail\\b)(?=.*settings\\b)(?=.*video_url\\b)(?=.*settings_summary)(.*)})(<\\/p>)?/', $text, $matches)) {
return [];
}
$valid_matches = [];
foreach ($matches['json'] as $delta => $match) {
// Ensure the JSON string is valid.
$embed_data = json_decode($match, TRUE);
if (!$embed_data || !is_array($embed_data)) {
continue;
}
if ($this
->isValidSettings($embed_data['settings'])) {
$valid_matches[$matches[0][$delta]] = $embed_data;
}
}
return $valid_matches;
}
/**
* Check if the given settings are valid.
*
* @param array $settings
* Settings to validate.
*
* @return bool
* If the required settings are present.
*/
protected function isValidSettings($settings) {
foreach (Video::defaultSettings() as $setting => $default) {
if (!isset($settings[$setting])) {
return FALSE;
}
}
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
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 settings form. Overrides FilterInterface:: |
3 |
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. | ||
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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:: |
3 |
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. | 1 |
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. | |
VideoEmbedWysiwyg:: |
protected | property | The current user. | |
VideoEmbedWysiwyg:: |
protected | property | The video provider manager. | |
VideoEmbedWysiwyg:: |
protected | property | The renderer. | |
VideoEmbedWysiwyg:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
VideoEmbedWysiwyg:: |
protected | function | Get all valid matches in the WYSIWYG. | |
VideoEmbedWysiwyg:: |
protected | function | Check if the given settings are valid. | |
VideoEmbedWysiwyg:: |
public | function |
Performs the filter processing. Overrides FilterInterface:: |
|
VideoEmbedWysiwyg:: |
public | function |
VideoEmbedWysiwyg constructor. Overrides FilterBase:: |