PHP package for converting file extensions to MIME types and vice versa.
This package uses httpd's mime.types to generate a mapping of file extension to MIME type and the other way around. Click here to view the changelog from their svn: changelog
The mime.types file is parsed by bin/generate.php and converted into an optimized JSON object in dist/mime.types.min.json
which is then wrapped by helper class MimeTypes.
Also provides a generated PHP enum with all mime types and methods to get the extension. Can also be used to get the enum value from an extension.
Compatible with PHP >= 8.2 and can be installed with Composer.
$ composer require esi/mimey$mimes = new MimeTypes;
// Convert extension to MIME type:
$mimes->getMimeType('json'); // application/json
// Convert MIME type to extension:
$mimes->getExtension('application/json'); // json$json = MimeType::ApplicationJson;
echo $json->getExtension(); // json
echo $json->value; // application/json
$html = MimeType::fromExtension('html');
echo $html->value; // text/html
MimeType::fromExtension('asdf'); // throws an InvalidArgumentException if the extension cannot be foundIt's rare, but some extensions have multiple MIME types:
// Get all MIME types for an extension:
$mimes->getAllMimeTypes('wmz'); // array('application/x-ms-wmz', 'application/x-msmetafile')However, there are many MIME types that have multiple extensions:
// Get all extensions for a MIME type:
$mimes->getAllExtensions('image/jpeg'); // array('jpeg', 'jpg', 'jpe')You can add custom conversions by changing the mapping that is given to MimeTypes.
There is a Mapping\Builder that can help with this:
use Esi\Mimey\Mapping\Builder;
// Create a builder using the built-in conversions as the basis.
$builder = Builder::create();
// Add a conversion. This conversion will take precedence over existing ones.
$builder->add('custom/mime-type', 'myextension');
$mimes = new MimeTypes($builder->getMapping());
$mimes->getMimeType('myextension'); // custom/mime-type
$mimes->getExtension('custom/mime-type'); // myextensionYou can add as many conversions as you would like to the builder:
$builder->add('custom/mime-type', 'myextension');
$builder->add('foo/bar', 'foobar');
$builder->add('foo/bar', 'fbar');
$builder->add('baz/qux', 'qux');
$builder->add('cat/qux', 'qux');
...You can optimize the loading of custom conversions by saving all conversions to a compiled PHP file as part of a build step.
// Add a bunch of custom conversions.
$builder->add(...);
$builder->add(...);
$builder->add(...);
...
// Save the conversions to a cached file.
$builder->save($cacheFilePath);The file can then be loaded to avoid overhead of repeated $builder->add(...) calls:
// Load the conversions from a cached file.
$builder = Builder::load($cacheFilePath);
$mimes = new MimeTypes($builder->getMapping());- Mimey works with PHP 8.2.0 or above.
- Author: Eric Sizemore
- Thanks to all Contributors.
- Special thanks to JetBrains for their Licenses for Open Source Development.
Esi\Mimey would not be possible without the wonderful work of the libraries that came before it, which it is forked from:
My thanks to them, and all their contributors. To view changes in this library in comparison to the original library, please see the CHANGELOG.md file.
Missing a MIME type?
Open an issue or even add it yourself! The process is very easy:
- fork this repository
- add your MIME type to the
data/mime.types.customfile (make sure it's properly formatted!) - push your changes
- submit a pull request
See CONTRIBUTING for more information.
Bugs and feature requests are tracked on GitHub.
See backward-compatibility.md for more information on Backwards Compatibility.
See the CHANGELOG for more information on what has changed recently.
See the LICENSE for more information on the license that applies to this project.
See SECURITY for more information on the security disclosure process.
See UPGRADING for more information on the upgrade process.
