class BlazyVideoFormatter in Blazy 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldFormatter/BlazyVideoFormatter.php \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyVideoFormatter
Plugin implementation of the 'Blazy Video' to get VEF videos.
@todo remove prior to full release. This means Slick Video which depends on VEF is deprecated for main Slick at Blazy 8.2.x with core Media only. @todo make is useful for local video instead? @todo remove ContainerFactoryPluginInterface since D8.8 has it by default.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\blazy\Dejavu\BlazyVideoBase
- class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyVideoFormatter implements ContainerFactoryPluginInterface uses BlazyFormatterTrait, BlazyFormatterViewTrait
- class \Drupal\blazy\Dejavu\BlazyVideoBase
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BlazyVideoFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ BlazyVideoFormatter.php, line 21
Namespace
Drupal\blazy\Plugin\Field\FieldFormatterView source
class BlazyVideoFormatter extends BlazyVideoBase implements ContainerFactoryPluginInterface {
use BlazyFormatterTrait;
use BlazyFormatterViewTrait;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
return self::injectServices($instance, $container, 'entity');
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
return $this
->commonViewElements($items, $langcode);
}
/**
* Build the blazy elements.
*/
public function buildElements(array &$build, $items) {
$settings = $build['settings'];
$settings['bundle'] = 'remote_video';
$settings['media_source'] = 'video_embed_field';
$vef = $this
->vefProviderManager();
if (!$vef) {
return;
}
foreach ($items as $delta => $item) {
$settings['input_url'] = strip_tags($item->value);
$settings['delta'] = $delta;
if (empty($settings['input_url']) || !($provider = $vef
->loadProviderFromInput($settings['input_url']))) {
continue;
}
// Ensures thumbnail is available.
$provider
->downloadThumbnail();
$settings['uri'] = $provider
->getLocalThumbnailUri();
$this->blazyOembed
->build($settings);
$box = [
'item' => $item,
'settings' => $settings,
];
// Image with responsive image, lazyLoad, and lightbox supports.
$build[$delta] = $this->formatter
->getBlazy($box);
unset($box);
}
}
/**
* {@inheritdoc}
*/
public function getScopedFormElements() {
return [
'fieldable_form' => TRUE,
'multimedia' => TRUE,
'view_mode' => $this->viewMode,
] + parent::getScopedFormElements();
}
/**
* {@inheritdoc}
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
return $field_definition
->getFieldStorageDefinition()
->getType() === 'video_embed_field';
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlazyFormatterTrait:: |
protected | property | The blazy manager service. | |
BlazyFormatterTrait:: |
protected | property | The blazy manager service. | |
BlazyFormatterTrait:: |
public | function | Returns the blazy admin service. | 1 |
BlazyFormatterTrait:: |
public | function | Returns the blazy manager. | |
BlazyFormatterTrait:: |
public | function | Builds the settings. | 1 |
BlazyFormatterTrait:: |
public | function | Returns the blazy formatter manager. | |
BlazyFormatterTrait:: |
public | function | Defines the common scope for both front and admin. | |
BlazyFormatterTrait:: |
public | function | Defines the common scope for the form elements. | |
BlazyFormatterTrait:: |
protected static | function | Injects DI services. | |
BlazyFormatterTrait:: |
public | function | ||
BlazyFormatterViewTrait:: |
public | function | Returns similar view elements. | |
BlazyVideoBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
BlazyVideoBase:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
BlazyVideoBase:: |
protected | function | Returns the optional VEF service to avoid dependency for optional plugins. | |
BlazyVideoFormatter:: |
public | function | Build the blazy elements. | |
BlazyVideoFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
BlazyVideoFormatter:: |
public | function |
Defines the scope for the form elements. Overrides BlazyVideoBase:: |
|
BlazyVideoFormatter:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterBase:: |
|
BlazyVideoFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
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 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
11 |
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. |