library http-message-util

narrowspark/http-message-util

This repository holds utility classes and constants to facilitate common operations of PSR-7.

Http Message Util

This repository holds utility classes and constants to facilitate common operations of PSR-7.

, _(*1)

Each header class is named after the specific http header and has the following functions for parsing and signing., _(*2)

Installation

$ composer require narrowspark/http-message-util

Use

Here's an example using the InteractsWithAcceptLanguage class: ``` php <?php declare(strict_types=1);, _(*3)

use Narrowspark\Http\Message\Util\InteractsWithAcceptLanguage;, _(*4)

$request = new Request(); $request = $request->withHeader('Accept-Language', 'zh, en-us; q=0.8, en; q=0.6');, _(*5)

return InteractsWithAcceptLanguage::getLanguages($request); // => ['zh', 'en', 'en_US'], _(*6)

Here's an example using the InteractsWithAuthorization class:

``` php
<?php
declare(strict_types=1);

use Narrowspark\Http\Message\Util\InteractsWithAuthorization;

$request = new Request();
$request = $request->withHeader('Authorization', 'Basic QWxhZGRpbjpPcGVuU2VzYW1l');

return InteractsWithAuthorization::getAuthorization($request); // => ['Basic', 'QWxhZGRpbjpPcGVuU2VzYW1l']

Here's an example using the InteractsWithContentTypes class:, _(*7)

``` php <?php declare(strict_types=1);, <sub>(*8)</sub>

use Narrowspark\Http\Message\Util\InteractsWithContentTypes;, <sub>(*9)</sub>

$request = new Request(); $request = $request->withHeader('Content-Type', 'application/json, /');, <sub>(*10)</sub>

return InteractsWithContentTypes::isJson($request); // => true, <sub>(*11)</sub>

$request = $request->withHeader('X-Pjax', 'true');, <sub>(*12)</sub>

return InteractsWithContentTypes::isPjax($request); // => true, <sub>(*13)</sub>

$request = $request->withHeader('X-Requested-With', 'XMLHttpRequest');, <sub>(*14)</sub>

return InteractsWithContentTypes::isAjax($request); // => true, <sub>(*15)</sub>

Here's an example using the HeaderUtils class:
``` php
<?php
declare(strict_types=1);

use Narrowspark\Http\Message\Util\HeaderUtils;

return HeaderUtils::split("da, en-gb;q=0.8", ",;"); // => array(array('da'), array('en-gb', 'q=0.8'))

or

return HeaderUtils::combine(array(array("foo", "abc"), array("bar"))); // => array("foo" => "abc", "bar" => true)

or

return HeaderUtils::toString(array("foo" => "abc", "bar" => true, "baz" => "a b c"), ",");  // => 'foo=abc, bar, baz="a b c"'

or

return HeaderUtils::quote('foo bar'); // => "foo bar"

or

return HeaderUtils::unquote('"foo bar"'); // => foo bar

Here's an example using the InteractsWithDisposition class: ``` php <?php declare(strict_types=1);, <sub>(*16)</sub>

use Narrowspark\Http\Message\Util\InteractsWithDisposition;, <sub>(*17)</sub>

$response = InteractsWithDisposition::appendDispositionHeader(new Response(), InteractsWithDisposition::DISPOSITION_ATTACHMENT, 'foo.html');, <sub>(*18)</sub>

return $response->getHeaderLine('Content-Disposition'); // => attachment; filename=foo.html, <sub>(*19)</sub>

or, <sub>(*20)</sub>

return InteractsWithDisposition::makeDisposition(InteractsWithDisposition::DISPOSITION_ATTACHMENT, 'foo.html'); // => attachment; filename=foo.html, <sub>(*21)</sub>

Testing
------------

``` bash
$ vendor/bin/phpunit

Contributing

If you would like to help take a look at the list of issues and check our Contributing guild., <sub>(*22)</sub>

Note: Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms., <sub>(*23)</sub>

License

The Narrowspark http-emitter is open-sourced software licensed under the MIT license, <sub>(*24)</sub>