class VideoFormatter in Facebook Instant Articles 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldFormatter/VideoFormatter.php \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\VideoFormatter
Plugin implementation of the 'fbia_video' formatter.
Plugin annotation
@FieldFormatter(
id = "fbia_video",
label = @Translation("FBIA Video"),
field_types = {
"file",
}
)
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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\DescriptionAwareFileFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\GenericFileFormatter
- class \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\VideoFormatter implements ContainerFactoryPluginInterface, InstantArticleFormatterInterface
- class \Drupal\file\Plugin\Field\FieldFormatter\GenericFileFormatter
- class \Drupal\file\Plugin\Field\FieldFormatter\DescriptionAwareFileFormatterBase
- class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
- 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 VideoFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ VideoFormatter.php, line 30
Namespace
Drupal\fb_instant_articles\Plugin\Field\FieldFormatterView source
class VideoFormatter extends GenericFileFormatter implements InstantArticleFormatterInterface, ContainerFactoryPluginInterface {
/**
* Base settings.
*
* @var \Drupal\Core\Config\ImmutableConfig
*/
protected $config;
/**
* {@inheritdoc}
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ConfigFactoryInterface $config_factory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->config = $config_factory
->get('fb_instant_articles.settings');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'presentation' => '',
'controls' => FALSE,
'autoplay' => TRUE,
'feed_cover' => FALSE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element['presentation'] = [
'#type' => 'select',
'#title' => $this
->t('Presentation'),
'#default_value' => $this
->getSetting('presentation'),
'#options' => [
Video::ASPECT_FIT => $this
->presentationLabel(Video::ASPECT_FIT),
Video::ASPECT_FIT_ONLY => $this
->presentationLabel(Video::ASPECT_FIT_ONLY),
Video::FULLSCREEN => $this
->presentationLabel(Video::FULLSCREEN),
Video::NON_INTERACTIVE => $this
->presentationLabel(Video::NON_INTERACTIVE),
],
'#empty_option' => $this
->t('None'),
];
$element['controls'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable player controls'),
'#default_value' => $this
->getSetting('controls'),
];
$element['autoplay'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable autoplay'),
'#default_value' => $this
->getSetting('autoplay'),
];
$element['feed_cover'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Newsfeed cover'),
'#description' => $this
->t('Enable this setting to use this video as the cover when the article is shown in the newsfeed. If set, the first video in a multivalue field is used as the cover.'),
'#default_value' => $this
->getSetting('feed_cover'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
if ($presentation = $this
->getSetting('presentation')) {
$summary[] = $this
->t('Presentation: @presentation', [
'@presentation' => $this
->presentationLabel($presentation),
]);
}
if ($this
->getSetting('controls')) {
$summary[] = $this
->t('Show controls');
}
if ($this
->getSetting('autoplay')) {
$summary[] = $this
->t('Autoplay');
}
if ($this
->getSetting('feed_cover')) {
$summary[] = $this
->t('Newsfeed cover');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
// Do nothing. Our field formatters are unique in that they are not meant
// to generate HTML on their own, but only signal to the Serialization API
// the fate of this field in the FBIA document.
return [];
}
/**
* {@inheritdoc}
*/
public function viewInstantArticle(FieldItemListInterface $items, InstantArticle $article, $region, NormalizerInterface $normalizer, $langcode = NULL) {
// Need to call parent::prepareView() to populate the entities since it's
// not otherwise getting called.
$this
->prepareView([
$items
->getEntity()
->id() => $items,
]);
/** @var \Drupal\Core\Field\EntityReferenceFieldItemListInterface $items */
if (empty($videos = $this
->getEntitiesToView($items, $langcode))) {
// Early opt-out if the field is empty.
return;
}
// Prepare the header region if we're adding to the header.
if ($region === Regions::REGION_HEADER) {
$header = $article
->getHeader();
if (!$header) {
$header = Header::create();
$article
->withHeader($header);
}
}
/** @var \Drupal\file\FileInterface[] $videos */
foreach ($videos as $delta => $video) {
// Build the Video Element using configured settings.
$video_uri = file_create_url($video
->getFileUri());
// Use the canonical URL override if set.
if ($canonical_url = $this->config
->get('canonical_url_override')) {
$video_uri = preg_replace('~^https?://.*?(?=/)~', rtrim($canonical_url, '/'), $video_uri);
}
$video = Video::create();
$video
->withURL($video_uri);
if ($presentation = $this
->getSetting('presentation')) {
$video
->withPresentation($presentation);
}
if ($this
->getSetting('controls')) {
$video
->enableControls();
}
else {
$video
->disableControls();
}
if ($this
->getSetting('autoplay')) {
$video
->enableAutoplay();
}
else {
$video
->disableAutoplay();
}
// If this field is marked as the Newsfeed cover, use only the first video
// in a multivalue field as the Newsfeed cover.
if ($this
->getSetting('feed_cover') && $delta === 0) {
$video
->enableFeedCover();
}
else {
$video
->disableFeedCover();
}
// Finally add the video to the article, either as the cover, or in the
// content of the article per the $region param.
if ($region === Regions::REGION_HEADER) {
$header
->withCover($video);
}
else {
$article
->addChild($video);
}
}
}
/**
* Given a presentation machine name, return the label.
*
* @param string $presentation
* Presentation type name.
*
* @return \Drupal\Core\StringTranslation\TranslatableMarkup
* String label.
*/
protected function presentationLabel($presentation) {
switch ($presentation) {
case Video::ASPECT_FIT:
$label = $this
->t('Fit');
break;
case Video::ASPECT_FIT_ONLY:
$label = $this
->t('Fit only');
break;
case Video::FULLSCREEN:
$label = $this
->t('Fullscreen');
break;
case Video::NON_INTERACTIVE:
$label = $this
->t('Non-interactive');
break;
default:
$label = $this
->t('None');
break;
}
return $label;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityReferenceFormatterBase:: |
protected | function | Returns the referenced entities for display. | 1 |
EntityReferenceFormatterBase:: |
public | function |
Loads the entities referenced in that field across all the entities being
viewed. Overrides FormatterBase:: |
|
EntityReferenceFormatterBase:: |
public | function |
Overrides FormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Checks access to the given entity. Overrides EntityReferenceFormatterBase:: |
|
FileFormatterBase:: |
protected | function |
Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase:: |
1 |
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 static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
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. | |
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. | 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. | |
VideoFormatter:: |
protected | property | Base settings. | |
VideoFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
VideoFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides DescriptionAwareFileFormatterBase:: |
|
VideoFormatter:: |
protected | function | Given a presentation machine name, return the label. | |
VideoFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides DescriptionAwareFileFormatterBase:: |
|
VideoFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides DescriptionAwareFileFormatterBase:: |
|
VideoFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides GenericFileFormatter:: |
|
VideoFormatter:: |
public | function |
Modifies the given instant article with the contents of this field. Overrides InstantArticleFormatterInterface:: |
|
VideoFormatter:: |
public | function |
Constructs a FormatterBase object. Overrides FormatterBase:: |