middlewares/negotiation

Name: negotiation

Owner: Middlewares

Description: PSR-15 middleware to implement content negotiation

Created: 2016-10-01 17:19:04.0

Updated: 2018-05-18 08:37:25.0

Pushed: 2018-01-25 19:48:31.0

Homepage:

Size: 43

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

middlewares/negotiation

Middleware using wildurand/Negotiation to implement content negotiation. Contains the following components:

• ContentType
• ContentLanguage
• ContentEncoding

Requirements

• PHP >= 7.0
• A PSR-7 http message implementation (Diactoros, Guzzle, Slim, etc…)
• A PSR-15 middleware dispatcher

Installation

This package is installable and autoloadable via Composer as middlewares/negotiation.

oser require middlewares/negotiation

Example

patcher = new Dispatcher([
new Middlewares\ContentType(),
new Middlewares\ContentLanguage(['en', 'gl', 'es']),
new Middlewares\ContentEncoding(['gzip', 'deflate']),


ponse = $dispatcher->dispatch(new ServerRequest());

ContentType

To detect the preferred mime type using the Accept header and the path extension and edit the header with this value. A Content-Type header is also added to the response if it's missing.

__construct(array $formats = null)

Set the available formats to negotiate sorted by priority. By default uses these

useDefault($useDefault = true)

Whether use the default format (the first format provided) if the negotiation does not return a valid format. Set to false to disable the default format and return a 406 response. By default is true.

charsets(array $charsets)

Array with the available charsets, to negotiate with the Accept-Charset header. By default is ['UTF-8'].

noSniff($nosniff = true)

Adds the X-Content-Type-Options: nosniff header, to mitigating MIME confusión attacks.. true by default. To disable it: noSniff(false).

uest = (new ServerRequest())
->withHeader('Accept', 'application/xml;charset=UTF-8,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8');

patcher = new Dispatcher([
new Middlewares\ContentType(),

function ($request, $next) {
    $type = $request->getHeaderLine('Accept');
    $response = new Response();

    if ($type === 'text/html') {
        $response->getBody()->write('<p>Hello world</p>');
    } elseif ($type === 'application/json') {
        $response->getBody()->write(json_encode(['message' => 'Hello world']));
    }

    return $response;
}


ponse = $dispatcher->dispatch($request);

 $response->getHeaderLine('Content-Type'); //text/html; charset=UTF-8
 $response->getBody(); //<p>Hello world</p>

ContentLanguage

To detect the preferred language using the Accept-Language header or the path prefix and edit the header with this value. A Content-Language header is also added to the response if it's missing.

__construct(array $languages)

Set the available languages to negotiate sorted by priority. The first value will be used as default if no other languages is choosen in the negotiation.

uest = (new ServerRequest())
->withHeader('Accept-Language', 'gl-es, es;q=0.8, en;q=0.7');

patcher = new Dispatcher([
new Middlewares\ContentLanguage(['es', 'en']),

function ($request, $next) {
    $language = $request->getHeaderLine('Accept-Language');
    $response = new Response();

    if ($language === 'es') {
        $response->getBody()->write('Hola mundo');
    } else {
        $response->getBody()->write('Hello world');
    }

    return $response;
}


ponse = $dispatcher->dispatch($request);

 $response->getHeaderLine('Content-Language'); //es
 $response->getBody(); //Hola mundo

usePath()

To use the base path to detect the language. This is useful if you have different paths for each language, for example /gl/foo and /en/foo.

Note: the language in the path has preference over the Accept-Language header.

uest = (new ServerRequest())->withUri(new Uri('/en/hello-world'));

patcher = new Dispatcher([
(new Middlewares\ContentLanguage(['es', 'en']))
    ->usePath(),

function ($request, $next) {
    $language = $request->getHeaderLine('Accept-Language');
    $response = new Response();

    if ($language === 'es') {
        $response->getBody()->write('Hola mundo');
    } else {
        $response->getBody()->write('Hello world');
    }

    return $response;
}


ponse = $dispatcher->dispatch($request);

 $response->getHeaderLine('Content-Language'); //en
 $response->getBody(); //Hello world

redirect()

Used to return a 302 response redirecting to a path containing the language. This only works if usePath is enabled, so for example, if the request uri is /welcome, returns a redirection to /en/welcome.

ContentEncoding

To detect the preferred encoding type using the Accept-Encoding header and edit the header with this value.

__construct(array $encodings)

Set the available encodings to negotiate.

uest = (new ServerRequest())
->withHeader('Accept-Encoding', 'gzip,deflate');

patcher = new Dispatcher([
new Middlewares\ContentEncoding(['gzip']),

function ($request, $next) {
    echo $request->getHeaderLine('Accept-Encoding'); //gzip
}


ponse = $dispatcher->dispatch($request);

---

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.