class MediaService in Gutenberg 8.2

The media service class.

Hierarchy

• class \Drupal\gutenberg\Service\MediaService

1 file declares its use of MediaService

MediaController.php in src/Controller/MediaController.php

1 string reference to 'MediaService'

gutenberg.services.yml in ./gutenberg.services.yml

gutenberg.services.yml

1 service uses MediaService

gutenberg.media_service in ./gutenberg.services.yml

Drupal\gutenberg\Service\MediaService

File

src/Service/MediaService.php, line 26

Namespace

Drupal\gutenberg\Service

class MediaService {

  /**
   * The media type guesser.
   *
   * @var \Drupal\gutenberg\MediaTypeGuesserInterface
   */
  protected $mediaTypeGuesser;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The media type persistence manager.
   *
   * @var \Drupal\gutenberg\Persistence\MediaTypePersistenceManager
   */
  protected $mediaTypePersisterManager;

  /**
   * The entity data provider manager.
   *
   * @var \Drupal\gutenberg\DataProvider\EntityDataProviderManager
   */
  protected $entityDataProviderManager;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The media uploader.
   *
   * @var \Drupal\gutenberg\MediaUploaderInterface
   */
  protected $mediaUploader;

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

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The media entity renderer.
   *
   * @var \Drupal\gutenberg\MediaEntityRendererInterface
   */
  protected $mediaEntityRenderer;

  /**
   * The media library UI builder.
   *
   * @var \Drupal\media_library\MediaLibraryUiBuilder|null
   */
  protected $builder;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * MediaController constructor.
   *
   * @param \Drupal\gutenberg\MediaTypeGuesserInterface $media_type_guesser
   *   The media type guesser.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\gutenberg\Persistence\MediaTypePersistenceManager $media_type_persistence_manager
   *   The media type persistence manager.
   * @param \Drupal\gutenberg\DataProvider\EntityDataProviderManager $entity_data_provider_manager
   *   The entity data provider manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\gutenberg\MediaUploaderInterface $media_uploader
   *   The media uploader.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle service.
   * @param \Drupal\gutenberg\MediaEntityRendererInterface $media_entity_renderer
   *   The media entity renderer.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct(MediaTypeGuesserInterface $media_type_guesser, EntityTypeManagerInterface $entity_type_manager, MediaTypePersistenceManager $media_type_persistence_manager, EntityDataProviderManager $entity_data_provider_manager, ModuleHandlerInterface $module_handler, MediaUploaderInterface $media_uploader, RendererInterface $renderer, EntityTypeBundleInfoInterface $entity_type_bundle_info, MediaEntityRendererInterface $media_entity_renderer, Connection $connection, EntityDisplayRepositoryInterface $entity_display_repository) {
    $this->mediaTypeGuesser = $media_type_guesser;
    $this->entityTypeManager = $entity_type_manager;
    $this->mediaTypePersisterManager = $media_type_persistence_manager;
    $this->entityDataProviderManager = $entity_data_provider_manager;
    $this->moduleHandler = $module_handler;
    $this->mediaUploader = $media_uploader;
    $this->renderer = $renderer;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->mediaEntityRenderer = $media_entity_renderer;
    $this->connection = $connection;
    $this->entityDisplayRepository = $entity_display_repository;
    if ($this->moduleHandler
      ->moduleExists('media_library')) {
      $this->builder = \Drupal::getContainer()
        ->get('gutenberg.media_library.ui_builder');
    }
  }

  /**
   * Renders media library dialog for Gutenberg editor.
   *
   * @param array $media_types
   *   Array of media types.
   *
   * @return string
   *   The rendered element.
   *
   * @throws \Drupal\gutenberg\Service\MediaTypeNotFoundException
   */
  public function renderDialog(array $media_types) {
    $media_types = array_filter($media_types) ? $media_types : [
      'application',
      'image',
      'audio',
      'video',
      'text',
    ];
    $allowed_media_type_ids = [];
    foreach ($media_types as $media_type) {
      $allowed_media_type_ids = array_merge($allowed_media_type_ids, $this->mediaTypeGuesser
        ->guess($media_type));
    }
    if (!$allowed_media_type_ids) {
      throw new MediaTypeNotFoundException();
    }
    $buildUi = $this->builder
      ->buildUi(MediaLibraryState::create('gutenberg.media_library.opener', array_unique($allowed_media_type_ids), reset($allowed_media_type_ids), 1));
    $this->moduleHandler
      ->alter('gutenberg_media_library_view', $buildUi);
    return $this->renderer
      ->render($buildUi);
  }

  /**
   * Render media entities.
   *
   * @param \Drupal\media\MediaInterface $media_entity
   *   Media entity instance.
   *
   * @return array
   *   The rendered view modes.
   */
  public function getRenderedMediaEntity(MediaInterface $media_entity) {
    $rendered_view_modes = [];
    try {

      /** @var \Drupal\media\Entity\Media $media_entity */
      $view_modes = $this->entityDisplayRepository
        ->getViewModeOptionsByBundle('media', $media_entity
        ->bundle());
      foreach ($view_modes as $view_mode => $view_mode_name) {
        $rendered_view_modes[$view_mode] = [
          'view_mode' => $view_mode,
          'view_mode_name' => (string) $view_mode_name,
          'html' => $this->mediaEntityRenderer
            ->render($media_entity, $view_mode),
        ];
      }
    } catch (\Throwable $exception) {

      // Catch silently.
    }
    return $rendered_view_modes;
  }

  /**
   * Save uploaded file, create file and media entity if possible.
   *
   * @param string $form_field_name
   *   The file field name.
   * @param \Symfony\Component\HttpFoundation\File\UploadedFile $uploaded_file
   *   Uploaded file instance.
   * @param \Drupal\editor\Entity\Editor $editor
   *   Editor entity instance.
   *
   * @return mixed
   *   The media entity data.
   *
   * @throws \Drupal\gutenberg\Service\FileEntityNotSavedException
   * @throws \Drupal\gutenberg\Service\MediaEntityNotSavedException
   * @throws \Drupal\gutenberg\Service\MediaEntityNotMatchedException
   */
  public function processMediaEntityUpload(string $form_field_name, UploadedFile $uploaded_file, Editor $editor) {
    $media_installed = $this->moduleHandler
      ->moduleExists('media');

    // Allow all media file types by default.
    $file_settings = [];
    if ($media_installed) {
      $mime_type_pieces = explode('/', $uploaded_file
        ->getClientMimeType());
      if (!($media_type = $this->mediaTypeGuesser
        ->guess(reset($mime_type_pieces), MediaTypeGuesserInterface::RETURN_NEGOTIATED))) {
        throw new MediaEntityNotMatchedException();
      }

      // Fetch settings to restrict the file extensions by the Media entity.
      $file_settings = $this->mediaTypePersisterManager
        ->getFileSettings($media_type);
    }

    /** @var \Drupal\file\Entity\File $file_entity */
    if (!($file_entity = $this->mediaUploader
      ->upload($form_field_name, $uploaded_file, $editor, $file_settings))) {
      throw new FileEntityNotSavedException();
    }
    if ($media_installed) {
      if (!($media_entity = $this->mediaTypePersisterManager
        ->save($media_type, $file_entity))) {
        throw new MediaEntityNotSavedException();
      }
      return $this->entityDataProviderManager
        ->getData('media', $file_entity, [
        'media_id' => $media_entity
          ->id(),
        'media_type' => $media_entity
          ->bundle(),
      ]);
    }
    return $this->entityDataProviderManager
      ->getData('file', $file_entity);
  }

  /**
   * Load file entity data.
   *
   * @param \Drupal\file\FileInterface $file
   *   File entity instance.
   *
   * @return mixed
   *   The file entity data.
   *
   * @throws \Exception
   */
  public function loadFileData(FileInterface $file) {
    return $this->entityDataProviderManager
      ->getData('file', $file);
  }

  /**
   * Load media entity data.
   *
   * @param \Drupal\media\MediaInterface $media
   *   Media entity instance.
   *
   * @return mixed
   *   The file entity data for the specified media.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function loadMediaData(MediaInterface $media) {
    $file_entity_id = $media
      ->getSource()
      ->getSourceFieldValue($media);
    $file_entity = $this->entityTypeManager
      ->getStorage('file')
      ->load($file_entity_id);
    $file_data = $this->entityDataProviderManager
      ->getData('file', $file_entity);
    $file_data['media_entity'] = [
      'bundle' => $media
        ->bundle(),
      'id' => $media
        ->id(),
      'label' => $media
        ->label(),
    ];
    return $file_data;
  }

  /**
   * Search for file entities.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Current request.
   * @param string $type
   *   Mime type of searched files.
   * @param string $search
   *   Specific filename to search for.
   *
   * @return array
   *   The found file entities.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function search(Request $request, string $type = '', string $search = '') {
    $query = $this->entityTypeManager
      ->getStorage('file')
      ->getQuery();
    $query
      ->addTag('gutenberg_media_search');
    if ($search !== '*') {
      $query
        ->condition('filename', $search, 'CONTAINS');
    }
    if ($type !== '*') {
      $group = $query
        ->orConditionGroup();
      foreach (explode(' ', $type) as $key => $type_item) {
        $group
          ->condition('filemime', $type_item, 'CONTAINS');
      }
      $query
        ->condition($group);
    }
    $query
      ->sort('created', 'DESC');
    $this->moduleHandler
      ->invokeAll('gutenberg_media_search_query_alter', [
      $request,
      $type,
      $search,
      $query,
    ]);
    $files = $this->entityTypeManager
      ->getStorage('file')
      ->loadMultiple($query
      ->execute());
    $result = [];
    foreach ($files as $key => $file) {
      $result[] = $this->entityDataProviderManager
        ->getData('file', $file);
    }
    return $result;
  }

  /**
   * Update media data.
   *
   * @param string $fid
   *   File entity ID.
   * @param array $data
   *   Media data.
   *
   * @throws \Exception
   */
  public function updateMediaData(string $fid, array $data) {
    $this->connection
      ->merge('file_managed_data')
      ->key([
      'fid' => $fid,
    ])
      ->fields([
      'data' => serialize($data),
    ])
      ->execute();
  }

  /**
   * Get media entity results for autocomplete endpoint.
   *
   * @param string $search
   *   Text to search. Can be an ID.
   *
   * @return array
   *   The media entity results.
   */
  public function getMediaEntityAutoCompleteData(string $search) {
    try {
      $query = $this->entityTypeManager
        ->getStorage('media')
        ->getQuery();
      if (is_numeric($search)) {
        $query
          ->condition('id', $search);
      }
      else {
        $query
          ->condition('name', $search, 'CONTAINS');
      }
      $query
        ->condition('uid', \Drupal::currentUser()
        ->id());
      $query
        ->sort('created', 'DESC');
      $media_ids = $query
        ->execute();
      $media_entities = $this->entityTypeManager
        ->getStorage('media')
        ->loadMultiple($media_ids ?: []);
      return array_values(array_map(function (MediaInterface $media_entity) {
        return [
          'title' => $media_entity
            ->getName(),
          'url' => $media_entity
            ->getName() . ' (' . $media_entity
            ->id() . ')',
          'id' => $media_entity
            ->id(),
          'media_type' => $media_entity
            ->bundle(),
          'file_id' => $media_entity
            ->getSource()
            ->getSourceFieldValue($media_entity),
        ];
      }, $media_entities));
    } catch (\Throwable $exception) {
      return [];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MediaService::$builder	protected	property	The media library UI builder.
MediaService::$connection	protected	property	The database connection.
MediaService::$entityDataProviderManager	protected	property	The entity data provider manager.
MediaService::$entityDisplayRepository	protected	property	The entity display repository.
MediaService::$entityTypeBundleInfo	protected	property	The entity type bundle info.
MediaService::$entityTypeManager	protected	property	The entity type manager.
MediaService::$mediaEntityRenderer	protected	property	The media entity renderer.
MediaService::$mediaTypeGuesser	protected	property	The media type guesser.
MediaService::$mediaTypePersisterManager	protected	property	The media type persistence manager.
MediaService::$mediaUploader	protected	property	The media uploader.
MediaService::$moduleHandler	protected	property	The module handler.
MediaService::$renderer	protected	property	Drupal\Core\Render\RendererInterface instance.
MediaService::getMediaEntityAutoCompleteData	public	function	Get media entity results for autocomplete endpoint.
MediaService::getRenderedMediaEntity	public	function	Render media entities.
MediaService::loadFileData	public	function	Load file entity data.
MediaService::loadMediaData	public	function	Load media entity data.
MediaService::processMediaEntityUpload	public	function	Save uploaded file, create file and media entity if possible.
MediaService::renderDialog	public	function	Renders media library dialog for Gutenberg editor.
MediaService::search	public	function	Search for file entities.
MediaService::updateMediaData	public	function	Update media data.
MediaService::__construct	public	function	MediaController constructor.