You are here

Home » API reference » Blazy 8 » BlazyVideoFormatter.php

class BlazyVideoFormatter in Blazy 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/BlazyVideoFormatter.php \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyVideoFormatter

Plugin implementation of the 'Blazy Video' to get VEF videos.

Hierarchy

Expanded class hierarchy of BlazyVideoFormatter

File

src/Plugin/Field/FieldFormatter/BlazyVideoFormatter.php, line 16

Namespace

Drupal\blazy\Plugin\Field\FieldFormatter
View source 
class BlazyVideoFormatter extends BlazyVideoBase implements ContainerFactoryPluginInterface {
  use BlazyFormatterBaseTrait;
  use BlazyVideoTrait;

  /**
   * Constructs a BlazyFormatter object.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, BlazyFormatterManager $blazy_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->blazyManager = $blazy_manager;
  }

  /**
   * {@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('blazy.formatter.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $build = [];

    // Early opt-out if the field is empty.
    if ($items
      ->isEmpty()) {
      return $build;
    }

    // Collects specific settings to this formatter.
    $settings = $this
      ->buildSettings();
    $settings['blazy'] = TRUE;
    $settings['namespace'] = $settings['item_id'] = $settings['lazy'] = 'blazy';

    // Build the settings.
    $build = [
      'settings' => $settings,
    ];

    // Modifies settings.
    $this->blazyManager
      ->buildSettings($build, $items);

    // Fecthes URI from the first item to build dimensions once.
    $this
      ->buildVideo($build['settings'], $items[0]->value);

    // Build the elements.
    $this
      ->buildElements($build, $items);

    // Updates settings.
    $settings = $build['settings'];
    unset($build['settings']);

    // Supports Blazy multi-breakpoint images if provided.
    if (!empty($settings['uri'])) {
      $this->blazyManager
        ->isBlazy($settings, $build[0]['#build']);
    }
    $build['#blazy'] = $settings;
    $build['#attached'] = $this->blazyManager
      ->attach($settings);
    return $build;
  }

  /**
   * Build the blazy elements.
   */
  public function buildElements(array &$build, $items) {
    $settings = $build['settings'];
    foreach ($items as $delta => $item) {
      $settings['input_url'] = trim(strip_tags($item->value));
      $settings['delta'] = $delta;
      if (empty($settings['input_url'])) {
        continue;
      }
      $this
        ->buildVideo($settings);
      $box = [
        'item' => $item,
        'settings' => $settings,
      ];

      // Image with responsive image, lazyLoad, and lightbox supports.
      $build[$delta] = $this->blazyManager
        ->getImage($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

Namesort descending Modifiers Type Description Overrides
BlazyFormatterBaseTrait::$blazyManager protected property The blazy manager service.
BlazyFormatterBaseTrait::admin public function Returns the blazy admin service. 1
BlazyFormatterBaseTrait::blazyManager public function Returns the blazy manager.
BlazyFormatterBaseTrait::buildSettings public function Builds the settings. 1
BlazyFormatterBaseTrait::settingsSummary public function
BlazyVideoBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BlazyVideoBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BlazyVideoFormatter::buildElements public function Build the blazy elements.
BlazyVideoFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
BlazyVideoFormatter::getScopedFormElements public function Defines the scope for the form elements. Overrides BlazyVideoBase::getScopedFormElements
BlazyVideoFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BlazyVideoFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BlazyVideoFormatter::__construct public function Constructs a BlazyFormatter object. Overrides FormatterBase::__construct
BlazyVideoTrait::buildVideo public function Builds relevant video embed field settings based on the given media url.
BlazyVideoTrait::getImageItem public function Gets the faked image item out of file entity, or ER, if applicable.
BlazyVideoTrait::getMediaItem public function Gets the Media item thumbnail, or re-associate the file entity to ME.
BlazyVideoTrait::imageFactory public function Returns the image factory.
BlazyVideoTrait::videoEmbedMediaManager public static function Returns the optional VEF service to avoid dependency for optional plugins.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.