43081j/php-negotiator

Minimal PHP content negotiation library

PHP Negotiator

A minimal PHP content negotiation library to process common headers such as media types, encodings, charsets and so on., _(*1)

Quite a few concepts are taken from Negotiator., _(*2)

Accept (Media Types)

require 'vendor/autoload.php';

$negotiator = new Negotiator\Parser([
    'accept-charset' => 'utf-8, iso-8859-1;q=0.8, utf-7;q=0.2',
    'accept' => 'text/html, application/*;q=0.2, image/jpeg;q=0.8',
    'accept-language' => 'en;q=0.8, es, pt',
    'accept-encoding' => 'gzip, compress;q=0.2, identity;q=0.5',
]);

$available = ['text/html', 'text/plain', 'application/json'];

$negotiator->preferredMediaTypes();
// ['text/html', 'image/jpeg', 'application/*']

$negotiator->preferredMediaTypes($available);
// ['text/html', 'application/json']

$negotiator->preferredMediaType($available);
// 'text/html'

Do note that you must retrieve the headers yourself and standardise the keys to lowercase representations (e.g. 'accept' vs. 'Accept')., _(*3)

Methods

preferredMediaTypes($available), _(*4)

Returns an array of preferred media types ordered by priority and optionally selected from a set of available types., _(*5)

preferredMediaType($available), _(*6)

Returns a string of the highest priority media type preferred, optionally selected from a set of available types., _(*7)

preferredLanguages($available), _(*8)

Returns an array of preferred languages ordered by priority and optionally selected from a set of available languages., _(*9)

preferredLanguage($available), _(*10)

Returns a string of the highest priority language preferred, optionally selected from a set of available languages., _(*11)

preferredCharsets($available), _(*12)

Returns an array of preferred character sets ordered by priority and optionally selected from a set of available character sets., _(*13)

preferredCharset($available), _(*14)

Returns a string of the highest priority character set preferred, optionally selected from a set of available character sets., _(*15)

preferredEncodings($available), _(*16)

Returns an array of preferred encodings ordered by priority and optionally selected from a set of available encodings., _(*17)

preferredEncoding($available), _(*18)

Returns a string of the highest priority encoding preferred, optionally selected from a set of available encodings., _(*19)