class MediaElementVideoFieldFormatter in MediaElement 8

Plugin implementation of the 'mediaelement_file_video' formatter.

Plugin annotation


@FieldFormatter(
  id = "mediaelement_file_video",
  label = @Translation("MediaElement.js 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\FileMediaFormatterBase implements FileMediaFormatterInterface
    class \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter
    class \Drupal\mediaelement\Plugin\Field\FieldFormatter\MediaElementVideoFieldFormatter implements ContainerFactoryPluginInterface uses MediaElementFieldFormatterTrait

Expanded class hierarchy of MediaElementVideoFieldFormatter

File

src/Plugin/Field/FieldFormatter/MediaElementVideoFieldFormatter.php, line 26

Namespace

Drupal\mediaelement\Plugin\Field\FieldFormatter

View source

class MediaElementVideoFieldFormatter extends FileVideoFormatter implements ContainerFactoryPluginInterface {

  // Include trait with global MediaElement formatter config items. Allow for
  // overriding of Trait methods.
  use MediaElementFieldFormatterTrait {
    defaultSettings as traitDefaultSettings;
    settingsForm as traitSettingsForm;
    settingsSummary as traitSettingsSummary;
    viewElements as traitViewElements;
  }

  /**
   * Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * Entity Field Manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  protected $entityFieldManager;

  /**
   * Image Style entity storage.
   *
   * @var \Drupal\image\ImageStyleInterface
   */
  protected $imageStyleStorage;

  /**
   * Constructs a StringFormatter 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\Entity\EntityTypeManager $entity_type_manager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityFieldManager $entity_field_manager
   *   The entity field manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManager $entity_type_manager, EntityFieldManager $entity_field_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
    $this->imageStyleStorage = $entity_type_manager
      ->getStorage('image_style');
  }

  /**
   * {@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('entity_type.manager'), $container
      ->get('entity_field.manager'));
  }

  /**
   * Returns array of image style information for settings form.
   *
   * @return array
   *   The image style data as [machine_name => Label].
   */
  protected function getImageStyleOptions() {
    $style_names = array_map(function ($style) {
      return $style
        ->label();
    }, $this->imageStyleStorage
      ->loadMultiple());
    return [
      'raw' => $this
        ->t('Original Image'),
    ] + $style_names;
  }

  /**
   * Returns array of any image fields defined on the current entity type.
   *
   * @return array
   *   The image fields as [field_name => Label].
   */
  protected function getImageFieldOptions() {

    // Set the option for no poster image.
    $options = [
      'none' => $this
        ->t('No Poster'),
    ];

    // Get all the image fields used on the site and filter for only ones used
    // on this entity type and bundle.
    $entity_id = $this->fieldDefinition
      ->getTargetEntityTypeId();
    $bundle = $this->fieldDefinition
      ->getTargetBundle();
    $image_fields = $this->entityFieldManager
      ->getFieldMapByFieldType('image');
    $entity_fields = $image_fields[$entity_id] ?? [];
    $bundle_fields = $this->entityFieldManager
      ->getFieldDefinitions($entity_id, $bundle);
    foreach ($entity_fields as $field_name => $field_info) {
      if (in_array($bundle, $field_info['bundles'])) {
        $options[$field_name] = $this
          ->t('@field_label (@field_name)', [
          '@field_label' => $bundle_fields[$field_name]
            ->getLabel(),
          '@field_name' => $field_name,
        ]);
      }
    }
    return $options;
  }

  /**
   * Returns the file path for the video's `poster` attribute, if set.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The current entity being rendered.
   *
   * @return string
   *   The path to the poster image.
   */
  protected function getPosterPath(EntityInterface $entity) {
    $image_field = $this->settings['poster_image_field'];
    $image_style = $this->settings['poster_image_style'];

    // @codingStandardsIgnoreLine
    if ($image_field == 'none') {
      return '';
    }
    if ($entity
      ->get($image_field)
      ->isEmpty()) {
      return '';
    }
    $image_uri = $entity->{$image_field}->entity
      ->getFileUri();
    $image_url = $image_style == 'raw' ? file_create_url($image_uri) : $this->imageStyleStorage
      ->load($image_style)
      ->buildUrl($image_uri);
    return file_url_transform_relative($image_url);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return self::traitDefaultSettings() + [
      'poster_image_field' => 'none',
      'poster_image_style' => 'raw',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return $this
      ->traitSettingsForm($form, $form_state) + [
      'poster_image_field' => [
        '#title' => $this
          ->t('Poster Image Field'),
        '#description' => $this
          ->t('Select an Image Field from this @entity_type type to use as the poster thumbnail.', [
          '@entity_type' => $this->fieldDefinition
            ->getTargetEntityTypeId(),
        ]),
        '#type' => 'select',
        '#options' => $this
          ->getImageFieldOptions(),
        '#default_value' => $this->settings['poster_image_field'],
      ],
      'poster_image_style' => [
        '#title' => $this
          ->t('Poster Image Style'),
        '#type' => 'select',
        '#options' => $this
          ->getImageStyleOptions(),
        '#default_value' => $this->settings['poster_image_style'],
        '#states' => [
          'invisible' => [
            ':input[name*="poster_image_field"]' => [
              'value' => 'none',
            ],
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = $this
      ->traitSettingsSummary();
    $summary[] = $this
      ->t('Poster Image Field: %field', [
      '%field' => $this
        ->getImageFieldOptions()[$this->settings['poster_image_field']],
    ]);
    if ($this->settings['poster_image_field'] != 'none') {
      $summary[] = $this
        ->t('Poster Image Style: %style', [
        '%style' => $this
          ->getImageStyleOptions()[$this->settings['poster_image_style']],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = $this
      ->traitViewElements($items, $langcode);
    $poster_path = $this
      ->getPosterPath($items
      ->getEntity());
    if (!empty($poster_path)) {
      foreach ($elements as &$element) {
        $element['#attributes']
          ->setAttribute('poster', $poster_path);
      }
    }
    return $elements;
  }

}

Members

Name	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
FileMediaFormatterBase::getHtmlTag	protected	function	Gets the HTML tag for the formatter.
FileMediaFormatterBase::getSourceFiles	protected	function	Gets source files with attributes.
FileMediaFormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
FileMediaFormatterBase::mimeTypeApplies	protected static	function	Check if given MIME type applies to the media type of the formatter.
FileVideoFormatter::getMediaType	public static	function	Gets the applicable media type for a formatter. Overrides FileMediaFormatterInterface::getMediaType
FileVideoFormatter::prepareAttributes	protected	function	Prepare the attributes according to the settings. Overrides FileMediaFormatterBase::prepareAttributes
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.
MediaElementFieldFormatterTrait::defaultSettings	public static	function	Aliased as: traitDefaultSettings
MediaElementFieldFormatterTrait::settingsForm	public	function	Aliased as: traitSettingsForm
MediaElementFieldFormatterTrait::settingsSummary	public	function	Aliased as: traitSettingsSummary
MediaElementFieldFormatterTrait::viewElements	public	function	Aliased as: traitViewElements
MediaElementVideoFieldFormatter::$entityFieldManager	protected	property	Entity Field Manager service.
MediaElementVideoFieldFormatter::$entityTypeManager	protected	property	Entity Type Manager service.
MediaElementVideoFieldFormatter::$imageStyleStorage	protected	property	Image Style entity storage.
MediaElementVideoFieldFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
MediaElementVideoFieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides FileVideoFormatter::defaultSettings
MediaElementVideoFieldFormatter::getImageFieldOptions	protected	function	Returns array of any image fields defined on the current entity type.
MediaElementVideoFieldFormatter::getImageStyleOptions	protected	function	Returns array of image style information for settings form.
MediaElementVideoFieldFormatter::getPosterPath	protected	function	Returns the file path for the video's `poster` attribute, if set.
MediaElementVideoFieldFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FileVideoFormatter::settingsForm
MediaElementVideoFieldFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FileVideoFormatter::settingsSummary
MediaElementVideoFieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FileMediaFormatterBase::viewElements
MediaElementVideoFieldFormatter::__construct	public	function	Constructs a StringFormatter instance. Overrides FormatterBase::__construct
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.

You are here

class MediaElementVideoFieldFormatter in MediaElement 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation