bitworking/mimeparse

Basic functions for handling mime-types.

2.2.0 2016-02-09 18:45 UTC

Requires

• php: >=5.3.2

Requires (Dev)

• jakub-onderka/php-parallel-lint: ^0.9.0
• phpunit/phpunit: ^4.7|^5.0
• satooshi/php-coveralls: ^0.6.1
• squizlabs/php_codesniffer: ^2.3

MIT

• Joe Gregorio
• Andrew "Venom" K.
• Ben Ramsey

• http
• mime
• accept

README

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

This library was taken from the original mimeparse library on Google Project Hosting and has been cleaned up to conform to PSR-1, PSR-2, and PSR-4 standards. It also now has support for Composer. The Bitworking namespace is a nod to Joe Gregorio, the original author of this library.

Installation

The preferred method of installation is via Packagist and Composer. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require bitworking/mimeparse

Examples

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.

<?php
$supportedTypes = array('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).

<?php
$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! Please read CONTRIBUTING for details.

Copyright and license

The original mimeparse library is copyright © Joe Gregorio. The bitworking/mimeparse library for PHP is copyright © Ben Ramsey. Both authors have licensed the source for use under the MIT License (MIT). Please see LICENSE for more information.