function File::getThumbnail

Same name and namespace in other branches
  1. 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File::getThumbnail()
  2. 8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File::getThumbnail()
  3. 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File::getThumbnail()

Gets the thumbnail image URI based on a file entity.

Parameters

\Drupal\file\FileInterface $file: A file entity.

Return value

string File URI of the thumbnail image or NULL if there is no specific icon.

1 call to File::getThumbnail()
File::getMetadata in core/modules/media/src/Plugin/media/Source/File.php
Gets the value for a metadata attribute for a given media item.

File

core/modules/media/src/Plugin/media/Source/File.php, line 95

Class

File
File entity media source.

Namespace

Drupal\media\Plugin\media\Source

Code

protected function getThumbnail(FileInterface $file) {
    $icon_base = $this->configFactory
        ->get('media.settings')
        ->get('icon_base_uri');
    // We try to automatically use the most specific icon present in the
    // $icon_base directory, based on the MIME type. For instance, if an
    // icon file named "pdf.png" is present, it will be used if the file
    // matches this MIME type.
    $mimetype = $file->getMimeType();
    $mimetype = explode('/', $mimetype);
    $icon_names = [
        $mimetype[0] . '--' . $mimetype[1],
        $mimetype[1],
        $mimetype[0],
    ];
    foreach ($icon_names as $icon_name) {
        $thumbnail = $icon_base . '/' . $icon_name . '.png';
        if (is_file($thumbnail)) {
            return $thumbnail;
        }
    }
    return NULL;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.