You are here

Home » API reference » File Entity (fieldable files) 8.2 » FileVideoFormatter.php

class FileVideoFormatter in File Entity (fieldable files) 8.2

Plugin implementation of the 'file_video' formatter.

Plugin annotation


@FieldFormatter(
  id = "file_video",
  label = @Translation("Video"),
  description = @Translation("Render the file using an HTML5 video tag."),
  field_types = {
    "file"
  }
)

Hierarchy

Expanded class hierarchy of FileVideoFormatter

File

src/Plugin/Field/FieldFormatter/FileVideoFormatter.php, line 27

Namespace

Drupal\file_entity\Plugin\Field\FieldFormatter
View source 
class FileVideoFormatter extends FileFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a FileVideoFormatter instance.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The rendered service
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, RendererInterface $renderer) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->renderer = $renderer;
  }

  /**
   * {@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('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'controls' => TRUE,
      'autoplay' => FALSE,
      'loop' => FALSE,
      'muted' => FALSE,
      'playsinline' => FALSE,
      'width' => NULL,
      'height' => NULL,
      'multiple_file_behavior' => 'tags',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['controls'] = array(
      '#title' => t('Show video controls'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('controls'),
    );
    $element['autoplay'] = array(
      '#title' => t('Autoplay'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('autoplay'),
    );
    $element['loop'] = array(
      '#title' => t('Loop'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('loop'),
    );
    $element['muted'] = array(
      '#title' => t('Muted'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('muted'),
    );
    $element['playsinline'] = array(
      '#title' => t('Plays inline'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('playsinline'),
    );
    $element['width'] = array(
      '#type' => 'textfield',
      '#title' => t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#size' => 5,
      '#maxlength' => 5,
      '#field_suffix' => t('pixels'),
    );
    $element['height'] = array(
      '#type' => 'textfield',
      '#title' => t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#size' => 5,
      '#maxlength' => 5,
      '#field_suffix' => t('pixels'),
    );
    $element['multiple_file_behavior'] = array(
      '#title' => t('Display of multiple files'),
      '#type' => 'radios',
      '#options' => array(
        'tags' => t('Use multiple @tag tags, each with a single source.', array(
          '@tag' => '<video>',
        )),
        'sources' => t('Use multiple sources within a single @tag tag.', array(
          '@tag' => '<video>',
        )),
      ),
      '#default_value' => $this
        ->getSetting('multiple_file_behavior'),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $summary[] = t('Controls: %controls', array(
      '%controls' => $this
        ->getSetting('controls') ? 'visible' : 'hidden',
    ));
    $summary[] = t('Autoplay: %autoplay', array(
      '%autoplay' => $this
        ->getSetting('autoplay') ? t('yes') : t('no'),
    ));
    $summary[] = t('Loop: %loop', array(
      '%loop' => $this
        ->getSetting('loop') ? t('yes') : t('no'),
    ));
    $summary[] = t('Muted: %muted', array(
      '%muted' => $this
        ->getSetting('muted') ? t('yes') : t('no'),
    ));
    $summary[] = t('Plays inline: %playsinline', array(
      '%playsinline' => $this
        ->getSetting('playsinline') ? t('yes') : t('no'),
    ));
    $width = $this
      ->getSetting('width');
    $height = $this
      ->getSetting('height');
    if ($width && $height) {
      $summary[] = t('Size: %width x %height pixels', array(
        '%width' => $this
          ->getSetting('width'),
        '%height' => $this
          ->getSetting('height'),
      ));
    }
    $summary[] = t('Multiple files: %multiple', array(
      '%multiple' => $this
        ->getSetting('multiple_file_behavior'),
    ));
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = array();
    $multiple_file_behavior = $this
      ->getSetting('multiple_file_behavior');
    $source_files = array();

    // Because we can have the files grouped in a single video tag, we do a
    // grouping in case the multiple file behavior is not 'tags'.
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      if ($file
        ->getMimeTypeType() == 'video') {
        $source_attributes = new Attribute();
        $source_attributes
          ->setAttribute('src', file_create_url($file
          ->getFileUri()));
        $source_attributes
          ->setAttribute('type', $file
          ->getMimeType());
        if ($multiple_file_behavior == 'tags') {
          $source_files[$delta] = array(
            array(
              'file' => $file,
              'source_attributes' => $source_attributes,
            ),
          );
        }
        else {
          $source_files[0][] = array(
            'file' => $file,
            'source_attributes' => $source_attributes,
          );
        }
      }
    }
    if (!empty($source_files)) {

      // Prepare the video attributes according to the settings.
      $video_attributes = new Attribute();
      foreach (array(
        'controls',
        'autoplay',
        'loop',
        'muted',
        'playsinline',
      ) as $attribute) {
        if ($this
          ->getSetting($attribute)) {
          $video_attributes
            ->setAttribute($attribute, $attribute);
        }
      }
      $width = $this
        ->getSetting('width');
      $height = $this
        ->getSetting('height');
      if ($width && $height) {
        $video_attributes
          ->setAttribute('width', $width);
        $video_attributes
          ->setAttribute('height', $height);
      }
      foreach ($source_files as $delta => $files) {
        $elements[$delta] = array(
          '#theme' => 'file_entity_video',
          '#attributes' => $video_attributes,
          '#files' => $files,
        );
        foreach ($files as $file) {
          $this->renderer
            ->addCacheableDependency($elements[$delta], $file['file']);
        }
      }
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FileVideoFormatter::$renderer protected property The renderer service.
FileVideoFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FileVideoFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FileVideoFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FileVideoFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FileVideoFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FileVideoFormatter::__construct public function Constructs a FileVideoFormatter instance. Overrides FormatterBase::__construct
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
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.