You are here

Home » API reference » Bynder 4.0.x » BynderVideoFormatter.php

class BynderVideoFormatter in Bynder 4.0.x

Plugin implementation of the 'Bynder Video' formatter.

Plugin annotation


@FieldFormatter(
  id = "bynder_video",
  label = @Translation("Bynder (Video)"),
  field_types = {"string", "string_long"}
)

Hierarchy

Expanded class hierarchy of BynderVideoFormatter

File

src/Plugin/Field/FieldFormatter/BynderVideoFormatter.php, line 22

Namespace

Drupal\bynder\Plugin\Field\FieldFormatter
View source 
class BynderVideoFormatter extends BynderFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'controls' => TRUE,
      'autoplay' => FALSE,
      'loop' => FALSE,
      'muted' => FALSE,
      'width' => 640,
      'height' => 480,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['controls'] = [
      '#title' => $this
        ->t('Show playback controls'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('controls'),
    ];
    $elements['autoplay'] = [
      '#title' => $this
        ->t('Autoplay'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('autoplay'),
    ];
    $elements['loop'] = [
      '#title' => $this
        ->t('Loop'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('loop'),
    ];
    $elements['muted'] = [
      '#title' => $this
        ->t('Muted'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('muted'),
    ];
    $elements['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#size' => 5,
      '#maxlength' => 5,
      '#field_suffix' => $this
        ->t('pixels'),
      '#min' => 0,
      '#required' => TRUE,
    ];
    $elements['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#size' => 5,
      '#maxlength' => 5,
      '#field_suffix' => $this
        ->t('pixels'),
      '#min' => 0,
      '#required' => TRUE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Controls: %controls', [
      '%controls' => $this
        ->getSetting('controls') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Autoplay: %autoplay', [
      '%autoplay' => $this
        ->getSetting('autoplay') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Loop: %loop', [
      '%loop' => $this
        ->getSetting('loop') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Muted: %muted', [
      '%muted' => $this
        ->getSetting('muted') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Size: %width x %height pixels', [
      '%width' => $this
        ->getSetting('width'),
      '%height' => $this
        ->getSetting('height'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $is_entityreference = $this->fieldDefinition
      ->getType() == 'entity_reference';
    foreach ($items as $delta => $item) {

      /** @var \Drupal\media\MediaInterface $media */
      $media = $is_entityreference ? $item->entity : $items
        ->getEntity();
      if (!$media) {
        continue;
      }
      $source_plugin = $media
        ->getSource();
      if ($source_plugin instanceof Bynder && ($video_preview_urls = $source_plugin
        ->getMetadata($media, 'videoPreviewURLs'))) {
        $attributes = new Attribute();
        $attributes
          ->setAttribute('controls', $this
          ->getSetting('controls'))
          ->setAttribute('autoplay', $this
          ->getSetting('autoplay'))
          ->setAttribute('loop', $this
          ->getSetting('loop'))
          ->setAttribute('mute', $this
          ->getSetting('mute'))
          ->setAttribute('width', $this
          ->getSetting('width'))
          ->setAttribute('height', $this
          ->getSetting('height'));
        $source_attributes = [];
        foreach ($video_preview_urls as $video_url) {
          $source_attribute = new Attribute();

          // If the url is relative, make it external using the account domain.
          if (!preg_match('/^https?:/', $video_url)) {
            $bynderSettings = $this->configFactory
              ->get('bynder.settings');
            $accountDomain = $bynderSettings
              ->get('account_domain');
            $accountDomain = rtrim($accountDomain, '/');
            $completeUrl = "https://{$accountDomain}{$video_url}";
            if (UrlHelper::isValid($completeUrl)) {
              $video_url = $completeUrl;
            }
          }
          $source_attribute
            ->setAttribute('src', $video_url);

          // Try to get the extension from metadata.
          // If unable to, get if from the filename.
          // Default to mp4.
          $extensionMetaData = $source_plugin
            ->getMetadata($media, 'extension');
          $extensionType = 'mp4';
          if (!empty($extensionMetaData) && !empty($extensionMetaDataValue = reset($extensionMetaData))) {
            $extensionType = $extensionMetaDataValue;
          }
          else {
            $path_info = pathinfo($video_url);
            if ($path_info['extension']) {
              $extensionType = $path_info['extension'];
            }
          }
          $source_attribute
            ->setAttribute('type', "video/{$extensionType}");
          $source_attributes[] = $source_attribute;
        }
        $elements[] = [
          '#theme' => 'bynder_video',
          '#attributes' => $attributes,
          '#source_attributes' => $source_attributes,
        ];
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BynderFormatterBase::$bynder protected property The Bynder API service.
BynderFormatterBase::$configFactory protected property The config factory.
BynderFormatterBase::$currentUser protected property The current user.
BynderFormatterBase::$entityFieldManager protected property The entity field manager service.
BynderFormatterBase::$entityTypeManager protected property The entity type manager service.
BynderFormatterBase::$renderer protected property Renderer object.
BynderFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
BynderFormatterBase::getAttributesFieldsCandidates protected function Gets list of fields that are candidates for IMG attributes.
BynderFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BynderFormatterBase::__construct public function Constructs a BynderFormatter object. Overrides FormatterBase::__construct
BynderVideoFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BynderVideoFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BynderVideoFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
BynderVideoFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.