class IconMimeTypes

Same name and namespace in other branches
  1. 10 core/modules/file/src/IconMimeTypes.php \Drupal\file\IconMimeTypes

A utility class for working with MIME types.

Hierarchy

Expanded class hierarchy of IconMimeTypes

1 file declares its use of IconMimeTypes
file.module in core/modules/file/file.module

File

core/modules/file/src/IconMimeTypes.php, line 10

Namespace

Drupal\file
View source
final class IconMimeTypes {
  
  /**
   * Gets a class for the icon for a MIME type.
   *
   * @param string $mimeType
   *   A MIME type.
   *
   * @return string
   *   A class associated with the file.
   */
  public static function getIconClass(string $mimeType) : string {
    // Search for a group with the files MIME type.
    $genericMime = (string) self::getGenericMimeType($mimeType);
    if (!empty($genericMime)) {
      return $genericMime;
    }
    // Use generic icons for each category that provides such icons.
    foreach ([
      'audio',
      'image',
      'text',
      'video',
    ] as $category) {
      if (str_starts_with($mimeType, $category)) {
        return $category;
      }
    }
    // If there's no generic icon for the type the general class.
    return 'general';
  }
  
  /**
   * Determines the generic icon MIME package based on a file's MIME type.
   *
   * @param string $mimeType
   *   A MIME type.
   *
   * @return string|false
   *   The generic icon MIME package expected for this file.
   */
  public static function getGenericMimeType(string $mimeType) : string|false {
    // cspell:disable
    switch ($mimeType) {
      // Word document types.
      case 'application/msword':
      case 'application/vnd.ms-word.document.macroEnabled.12':
      case 'application/vnd.oasis.opendocument.text':
      case 'application/vnd.oasis.opendocument.text-template':
      case 'application/vnd.oasis.opendocument.text-master':
      case 'application/vnd.oasis.opendocument.text-web':
      case 'application/vnd.openxmlformats-officedocument.wordprocessingml.document':
      case 'application/vnd.stardivision.writer':
      case 'application/vnd.sun.xml.writer':
      case 'application/vnd.sun.xml.writer.template':
      case 'application/vnd.sun.xml.writer.global':
      case 'application/vnd.wordperfect':
      case 'application/x-abiword':
      case 'application/x-applix-word':
      case 'application/x-kword':
      case 'application/x-kword-crypt':
        return 'x-office-document';
      // Spreadsheet document types.
      case 'application/vnd.ms-excel':
      case 'application/vnd.ms-excel.sheet.macroEnabled.12':
      case 'application/vnd.oasis.opendocument.spreadsheet':
      case 'application/vnd.oasis.opendocument.spreadsheet-template':
      case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
      case 'application/vnd.stardivision.calc':
      case 'application/vnd.sun.xml.calc':
      case 'application/vnd.sun.xml.calc.template':
      case 'application/vnd.lotus-1-2-3':
      case 'application/x-applix-spreadsheet':
      case 'application/x-gnumeric':
      case 'application/x-kspread':
      case 'application/x-kspread-crypt':
        return 'x-office-spreadsheet';
      // Presentation document types.
      case 'application/vnd.ms-powerpoint':
      case 'application/vnd.ms-powerpoint.presentation.macroEnabled.12':
      case 'application/vnd.oasis.opendocument.presentation':
      case 'application/vnd.oasis.opendocument.presentation-template':
      case 'application/vnd.openxmlformats-officedocument.presentationml.presentation':
      case 'application/vnd.stardivision.impress':
      case 'application/vnd.sun.xml.impress':
      case 'application/vnd.sun.xml.impress.template':
      case 'application/x-kpresenter':
        return 'x-office-presentation';
      // Compressed archive types.
      case 'application/zip':
      case 'application/x-zip':
      case 'application/stuffit':
      case 'application/x-stuffit':
      case 'application/x-7z-compressed':
      case 'application/x-ace':
      case 'application/x-arj':
      case 'application/x-bzip':
      case 'application/x-bzip-compressed-tar':
      case 'application/x-compress':
      case 'application/x-compressed-tar':
      case 'application/x-cpio-compressed':
      case 'application/x-deb':
      case 'application/x-gzip':
      case 'application/x-java-archive':
      case 'application/x-lha':
      case 'application/x-lhz':
      case 'application/x-lzop':
      case 'application/x-rar':
      case 'application/x-rpm':
      case 'application/x-tzo':
      case 'application/x-tar':
      case 'application/x-tarz':
      case 'application/x-tgz':
        return 'package-x-generic';
      // Script file types.
      case 'application/ecmascript':
      case 'application/javascript':
      case 'application/mathematica':
      case 'application/vnd.mozilla.xul+xml':
      case 'application/x-asp':
      case 'application/x-awk':
      case 'application/x-cgi':
      case 'application/x-csh':
      case 'application/x-m4':
      case 'application/x-perl':
      case 'application/x-php':
      case 'application/x-ruby':
      case 'application/x-shellscript':
      case 'text/javascript':
      case 'text/vnd.wap.wmlscript':
      case 'text/x-emacs-lisp':
      case 'text/x-haskell':
      case 'text/x-literate-haskell':
      case 'text/x-lua':
      case 'text/x-makefile':
      case 'text/x-matlab':
      case 'text/x-python':
      case 'text/x-sql':
      case 'text/x-tcl':
        return 'text-x-script';
      // HTML aliases.
      case 'application/xhtml+xml':
        return 'text-html';
      // Executable types.
      case 'application/x-macbinary':
      case 'application/x-ms-dos-executable':
      case 'application/x-pef-executable':
        return 'application-x-executable';
      // Acrobat types.
      case 'application/pdf':
      case 'application/x-pdf':
      case 'applications/vnd.pdf':
      case 'text/pdf':
      case 'text/x-pdf':
        return 'application-pdf';
      default:
        return FALSE;
    }
    // cspell:enable
  }

}

Members

Title Sort descending Modifiers Object type Summary
IconMimeTypes::getGenericMimeType public static function Determines the generic icon MIME package based on a file's MIME type.
IconMimeTypes::getIconClass public static function Gets a class for the icon for a MIME type.

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