README

Basic functions for handling mime-types

About

This library provides basic functionality for parsing mime-types names and matching them against a list of media-ranges. See RFC 9110, section 5.3.2 for a complete explanation. More information on the library can be found in the XML.com article "Just use Media Types?"

This library was forked from the original mimeparse library on Google Project Hosting. The Bitworking namespace is a nod to original author Joe Gregorio.

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a dependency using Composer.

composer require bitworking/mimeparse

Usage

Use Mimeparse to specify a list of media types your application supports and compare that to the list of media types the user agent accepts (via the HTTP Accept header; $_SERVER['HTTP_ACCEPT']). Mimeparse will give you the best match to send back to the user agent for your list of supported types or null if there is no best match.

$supportedTypes = ['application/xbel+xml', 'text/xml'];
$httpAcceptHeader = 'text/*;q=0.5,*/*; q=0.1';

$mimeType = \Bitworking\Mimeparse::bestMatch($supportedTypes, $httpAcceptHeader);

echo $mimeType; // Should echo "text/xml"

You may also use Mimeparse to get the quality value of a specific media type when compared against a range of media types (from the Accept header, for example).

$httpAcceptHeader = 'text/*;q=0.3, text/html;q=0.7, text/html;level=1, text/html;level=2;q=0.4, *\/*;q=0.5';

$quality = \Bitworking\Mimeparse::quality('text/html', $httpAcceptHeader);

echo $quality; // Should echo 0.7

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

Copyright and License

bitworking/mimeparse is copyright © Ben Ramsey and licensed for use under the terms of the MIT License (MIT).

The original mimeparse.php library is copyright © Joe Gregorio and licensed for use under the terms of the MIT License (MIT).

Please see LICENSE for more information.