VideoEmbedField.php in Video Embed Field 8.2

Namespace

Drupal\video_embed_media\Plugin\media\Source

File

modules/video_embed_media/src/Plugin/media/Source/VideoEmbedField.php

<?php

namespace Drupal\video_embed_media\Plugin\media\Source;

use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\media\MediaInterface;
use Drupal\media\MediaSourceBase;
use Drupal\media\MediaTypeInterface;
use Drupal\video_embed_field\ProviderManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides media source plugin for video embed field.
 *
 * @MediaSource(
 *   id = "video_embed_field",
 *   label = @Translation("Video embed field"),
 *   description = @Translation("Enables video_embed_field integration with media."),
 *   allowed_field_types = {"video_embed_field"},
 *   default_thumbnail_filename = "video.png"
 * )
 */
class VideoEmbedField extends MediaSourceBase {

  /**
   * The video provider manager.
   *
   * @var \Drupal\video_embed_field\ProviderManagerInterface
   */
  protected $providerManager;

  /**
   * The media settings.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $mediaSettings;

  /**
   * Constructs a new class instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   Entity field manager service.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   Config field type manager service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory service.
   * @param \Drupal\video_embed_field\ProviderManagerInterface $provider_manager
   *   The video provider manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, FieldTypePluginManagerInterface $field_type_manager, ConfigFactoryInterface $config_factory, ProviderManagerInterface $provider_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $entity_field_manager, $field_type_manager, $config_factory);
    $this->providerManager = $provider_manager;
    $this->mediaSettings = $config_factory
      ->get('media.settings');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'), $container
      ->get('plugin.manager.field.field_type'), $container
      ->get('config.factory'), $container
      ->get('video_embed_field.provider_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'source_field' => 'field_media_video_embed_field',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadata(MediaInterface $media, $attribute_name) {
    $url = $this
      ->getVideoUrl($media);
    switch ($attribute_name) {
      case 'default_name':
        if ($provider = $this->providerManager
          ->loadProviderFromInput($url)) {
          return $provider
            ->getName();
        }
        return parent::getMetadata($media, 'default_name');
      case 'id':
        if ($provider = $this->providerManager
          ->loadProviderFromInput($url)) {
          return $provider
            ->getIdFromInput($url);
        }
        return FALSE;
      case 'source':
      case 'source_name':
        $definition = $this->providerManager
          ->loadDefinitionFromInput($url);
        if (!empty($definition)) {
          return $definition['id'];
        }
        return FALSE;
      case 'image_local':
      case 'image_local_uri':
        $thumbnail_uri = $this
          ->getMetadata($media, 'thumbnail_uri');
        if (!empty($thumbnail_uri) && file_exists($thumbnail_uri)) {
          return $thumbnail_uri;
        }
        return parent::getMetadata($media, 'thumbnail_uri');
      case 'thumbnail_uri':
        if ($provider = $this->providerManager
          ->loadProviderFromInput($url)) {
          $provider
            ->downloadThumbnail();
          $thumbnail_uri = $provider
            ->getLocalThumbnailUri();
          if (!empty($thumbnail_uri)) {
            return $thumbnail_uri;
          }
        }
        return parent::getMetadata($media, 'thumbnail_uri');
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadataAttributes() {
    return [
      'id' => $this
        ->t('Video ID.'),
      'source' => $this
        ->t('Video source machine name.'),
      'source_name' => $this
        ->t('Video source human name.'),
      'image_local' => $this
        ->t('Copies thumbnail image to the local filesystem and returns the URI.'),
      'image_local_uri' => $this
        ->t('Gets URI of the locally saved image.'),
    ];
  }

  /**
   * Get the video URL from a media entity.
   *
   * @param \Drupal\media\MediaInterface $media
   *   The media entity.
   *
   * @return string|bool
   *   A video URL or FALSE on failure.
   */
  protected function getVideoUrl(MediaInterface $media) {
    $media_type = $this->entityTypeManager
      ->getStorage('media_type')
      ->load($media
      ->bundle());
    $source_field = $this
      ->getSourceFieldDefinition($media_type);
    $field_name = $source_field
      ->getName();
    $video_url = $media->{$field_name}->value;
    return !empty($video_url) ? $video_url : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function createSourceField(MediaTypeInterface $type) {
    return parent::createSourceField($type)
      ->set('label', 'Video Url');
  }

  /**
   * {@inheritdoc}
   */
  public function getSourceFieldDefinition(MediaTypeInterface $type) {

    // video_embed_media has not historically had a value in
    // $this->configuration['source_field'], instead just creating
    // field_media_video_embed_field on install and treating that as the source.
    // Here we privilege the standard way, but also allow the old VEM way, of
    // getting the source field's name.
    $field = !empty($this->configuration['source_field']) ? $this->configuration['source_field'] : 'field_media_video_embed_field';
    if ($field) {

      // Be sure that the suggested source field actually exists.
      $fields = $this->entityFieldManager
        ->getFieldDefinitions('media', $type
        ->id());
      return isset($fields[$field]) ? $fields[$field] : NULL;
    }
    return NULL;
  }

}

Classes

Name	Description
VideoEmbedField	Provides media source plugin for video embed field.