https://github.com/robbieaverill/psr7-adapters

PSR-7 compliant request and response interfaces for SilverStripe using Guzzle
https://github.com/robbieaverill/psr7-adapters

adapters psr-7 silverstripe

Last synced: 15 days ago
JSON representation

PSR-7 compliant request and response interfaces for SilverStripe using Guzzle

• Host: GitHub
• URL: https://github.com/robbieaverill/psr7-adapters
• Owner: robbieaverill
• License: mit
• Created: 2017-01-12T08:26:02.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-10T23:22:22.000Z (over 1 year ago)
• Last Synced: 2024-10-04T18:48:14.316Z (about 1 month ago)
• Topics: adapters, psr-7, silverstripe
• Language: PHP
• Size: 40 KB
• Stars: 1
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# robbie/psr7-adapters

[![Build Status](https://travis-ci.org/robbieaverill/psr7-adapters.svg?branch=master)](https://travis-ci.org/robbieaverill/psr7-adapters) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/robbieaverill/psr7-adapters/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/robbieaverill/psr7-adapters/?branch=master) [![codecov](https://codecov.io/gh/robbieaverill/psr7-adapters/branch/master/graph/badge.svg)](https://codecov.io/gh/robbieaverill/psr7-adapters)

PSR-7 compliant, immutable adapter interfaces for SilverStripe HTTP classes.

## Requirements

* `silverstripe/framework` ^4.0

* `guzzlehttp/psr7`

## Installation

Install with [Composer](https://getcomposer.org):

```shell

composer require robbie/psr7-adapters

```

Add `?flush=1` to your browser URL, `flush=1` to your `sake` command arguments or `--flush` to your [`ssconsole`](https://github.com/silverleague/silverstripe-console).

## Use

### Converting to PSR-7

This module works by providing either a `HTTPRequest` or a `HTTPResponse` class that is pre-configured and ready to be sent to the client/server to the corresponding adapter class:

* `HTTPRequest` uses the `Robbie\Psr7\HttpRequestAdapter` class

* `HTTPResponse` uses the `Robbie\Psr7\HttpResponseAdapter` class

To retrieve a bootstrapped PSR-7 `ServerRequestInterface` or `ResponseInterface` you can call `->toPsr7($request)` on either of these classes, for example:

```php

 true, 'message' => 'Your request was successful!']),

    200,

    'OK'

);

/** @var \Psr\Http\Message\ResponseInterface $response */

$response = (new \Robbie\Psr7\HttpResponseAdapter)->toPsr7($myResponse);

```

From here you can use any of the PSR-7 interface methods, and the results will be immutable:

```php

withHeader('Content-Type', 'application/json');

$newResponse = $newResponse->withHeader('X-Custom-Header', 'my-value-here');

// $response !== $newResponse -> #psr7-ftw

```

The same concept applies to the `HttpRequestAdapter`, for example:

```php

getRequest();

$adapter = new HttpRequestAdapter;

$psrInterface = $adapter->toPsr7($request);

// Outputs all your initial request headers:

print_r($psrInterface->getHeaders());

```

### Converting from PSR-7

To return a PSR-7 interface back to either an `HTTPRequest` or `HTTPResponse` class you simply need to do the same thing as going *to*, only use `->fromPsr7($input)` instead:

```php

fromPsr7($requestInterface);

```

`$httpRequest` is now a `SilverStripe\Control\HTTPRequest` instance.