https://github.com/ptlis/psr7-conneg
PSR-7 Content negotiation
https://github.com/ptlis/psr7-conneg
Last synced: 8 months ago
JSON representation
PSR-7 Content negotiation
- Host: GitHub
- URL: https://github.com/ptlis/psr7-conneg
- Owner: ptlis
- License: mit
- Created: 2015-05-12T19:30:50.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-16T17:14:48.000Z (almost 11 years ago)
- Last Synced: 2025-08-19T23:57:33.576Z (10 months ago)
- Language: PHP
- Size: 168 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PSR-7 ConNeg
A content negotiation middleware that uses the PSR-7 interfaces.
Configurable component that decorate processed requests with preferred type information.
Built upon [ptlis/ConNeg](https://github.com/ptlis/conneg).
[](https://travis-ci.org/ptlis/psr7-conneg) [](https://scrutinizer-ci.com/g/ptlis/psr7-conneg/?branch=master) [](https://scrutinizer-ci.com/g/ptlis/psr7-conneg/?branch=master) [](https://github.com/ptlis/psr7-conneg/blob/master/licence.txt) [](https://packagist.org/packages/ptlis/psr7-conneg)
## Install
Either from the console:
```shell
$ composer require ptlis/psr7-conneg:~1.2
```
Or by Editing composer.json:
```javascript
{
"require": {
...
"ptlis/conneg-psr7-conneg": "~1.2",
...
}
}
```
Followed by a composer update:
```shell
$ composer update
```
## Usage
The package ships with a single class to provide negotiation.
```php
use ptlis\Psr7ConNeg\Negotiator;
$negotiator = new Negotiator();
```
To opt-in to negotiation on a field use the appropriate ```with*``` method (note these methods return a new instance in the manner of the PSR-7 interfaces).
To negotiate the preferred mime-type use the ```withMime``` method, providing it with a list of your application's type preference:
```
$negotiator = $negotiator->withMime('application/json;q=1.0,text/xml;q=0.7');
```
With your negotiator configured you can now perform negotiation:
```
$request = $negotiator->negotiate($request);
```
This adds attributes to the request containing the preferred type. These can be accessed with the appropriate getters, in the above example of negotiation on the Accept field this looks like:
```
$mime = $newRequest->getAttribute(Negotiator::MIME_BEST);
```
If the Accept field of the request contained ```application/json,text/xml``` then the value returned from this lookup would be ```application/json```.
### With Zend-Stratigility
To use the zend-stratigility component, configure your negotiator instance as described above and pass it to the Stratigility negotiator.
```
$stratigilityNegotiator = new StratigilityNegotiator($negotiator);
```
To perform negotiation on all routes, add it with an empty route:
```
$app->pipe('', $stratigilityNegotiator);
```
For further information please refer to the Stratigility documentation.
### With Relay
To use the relay component, configure your negotiator instance as described above and pass it to the Relay negotiator.
```
$queue[] = new RelayNegotiator($negotiator);
```
Note: The negotiator must be earlier in the queue than middleware components that depend upon negotiation data.
## Integration
Middlewares integration is shipped for the following packages:
* [Zend-Stratigility](https://github.com/zendframework/zend-stratigility)
* [Relay](https://github.com/relayphp/Relay.Relay)
## Contributing
You can contribute by submitting an Issue to the [issue tracker](https://github.com/ptlis/psr-7conneg/issues) or submitting a pull request.