Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunrise-php/http-message
HTTP message wrapper for PHP 7.4+ based on RFC-7230, PSR-7 & PSR-17
https://github.com/sunrise-php/http-message
header http http-message message-factory php-library php7 php8 psr-17 psr-7 request response rfc-7230 stream uri
Last synced: about 2 months ago
JSON representation
HTTP message wrapper for PHP 7.4+ based on RFC-7230, PSR-7 & PSR-17
- Host: GitHub
- URL: https://github.com/sunrise-php/http-message
- Owner: sunrise-php
- License: mit
- Created: 2018-11-12T13:05:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T04:04:08.000Z (about 2 months ago)
- Last Synced: 2024-08-02T05:24:30.056Z (about 2 months ago)
- Topics: header, http, http-message, message-factory, php-library, php7, php8, psr-17, psr-7, request, response, rfc-7230, stream, uri
- Language: PHP
- Homepage:
- Size: 249 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-psr15-middlewares - sunrise/http-message
README
# HTTP message wrapper for PHP 7.4+ based on RFC-7230, PSR-7 and PSR-17
[](https://scrutinizer-ci.com/g/sunrise-php/http-message/build-status/master)
[](https://scrutinizer-ci.com/g/sunrise-php/http-message/?branch=master)
[](https://scrutinizer-ci.com/g/sunrise-php/http-message/?branch=master)
[](https://packagist.org/packages/sunrise/http-message)
[](https://packagist.org/packages/sunrise/http-message)
[](https://packagist.org/packages/sunrise/http-message)
---
## Installation
```bash
composer require sunrise/http-message
```
## Documentation navigation
- [Server request from global environment](#server-request-from-global-environment)
- [HTML and JSON responses](#html-and-json-responses)
- - [HTML response](#html-response)
- - [JSON response](#json-response)
- [Streams](#streams)
- - [File stream](#file-stream)
- - [PHP input stream](#php-input-stream)
- - [PHP memory stream](#php-memory-stream)
- - [PHP temporary stream](#php-temporary-stream)
- - [Temporary file stream](#temporary-file-stream)
- [PSR-7 and PSR-17](#psr-7-and-psr-17)
- [Exceptions](#exceptions)
## How to use
We highly recommend that you study [PSR-7](https://www.php-fig.org/psr/psr-7/) and [PSR-17](https://www.php-fig.org/psr/psr-17/) because only superficial examples will be presented below.
### Server request from global environment
```php
use Sunrise\Http\Message\ServerRequestFactory;
$request = ServerRequestFactory::fromGlobals();
```
### HTML and JSON responses
#### HTML response
```php
use Sunrise\Http\Message\Response\HtmlResponse;
/** @var $html string|Stringable */
$response = new HtmlResponse(200, $html);
```
#### JSON response
```php
use Sunrise\Http\Message\Response\JsonResponse;
/** @var $data mixed */
$response = new JsonResponse(200, $data);
```
You can also specify [encoding flags](https://www.php.net/manual/en/json.constants.php#constant.json-hex-tag) and maximum nesting depth like below:
```php
$response = new JsonResponse(200, $data, JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE, 512);
```
### Streams
#### File stream
```php
use Sunrise\Http\Message\Stream\FileStream;
$fileStream = new FileStream('/folder/file', 'r+b');
```
#### PHP input stream
More details about the stream at the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.input).
```php
use Sunrise\Http\Message\Stream\PhpInputStream;
$inputStream = new PhpInputStream();
```
#### PHP memory stream
More details about the stream at the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.memory).
```php
use Sunrise\Http\Message\Stream\PhpMemoryStream;
$memoryStream = new PhpMemoryStream('r+b');
```
#### PHP temporary stream
More details about the stream at the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.memory).
```php
use Sunrise\Http\Message\Stream\PhpTempStream;
$tempStream = new PhpTempStream('r+b');
```
You can also specify the memory limit, when the limit is reached, PHP will start using the temporary file instead of memory.
> Please note that the default memory limit is 2MB.
```php
$maxMemory = 1e+6; // 1MB
$tempStream = new PhpTempStream('r+b', $maxMemory);
```
#### Temporary file stream
More details about the temporary file behaviour at [the official page](https://www.php.net/manual/en/function.tmpfile).
The stream opens a unique temporary file in binary read/write (w+b) mode. The file will be automatically deleted when it is closed or the program terminates.
```php
use Sunrise\Http\Message\Stream\TmpfileStream;
$tmpfileStream = new TmpfileStream();
// Returns the file path...
$tmpfileStream->getMetadata('uri');
```
If you don't need the above behavior, you can use another temporary file stream:
```php
use Sunrise\Http\Message\Stream\TempFileStream;
$tempFileStream = new TempFileStream();
// Returns the file path...
$tempFileStream->getMetadata('uri');
```
### PSR-7 and PSR-17
The following classes implement PSR-7:
- `Sunrise\Http\Message\Request`
- `Sunrise\Http\Message\Response`
- `Sunrise\Http\Message\ServerRequest`
- `Sunrise\Http\Message\Stream`
- `Sunrise\Http\Message\UploadedFile`
- `Sunrise\Http\Message\Uri`
The following classes implement PSR-17:
- `Sunrise\Http\Message\RequestFactory`
- `Sunrise\Http\Message\ResponseFactory`
- `Sunrise\Http\Message\ServerRequestFactory`
- `Sunrise\Http\Message\StreamFactory`
- `Sunrise\Http\Message\UploadedFileFactory`
- `Sunrise\Http\Message\UriFactory`
### Exceptions
Any exceptions of this package can be caught through the interface:
```php
use Sunrise\Http\Message\Exception\ExceptionInterface;
try {
// some code...
} catch (ExceptionInterface $e) {
// some logic...
}
```
---
## Test run
```bash
composer test
```
## Useful links
- https://tools.ietf.org/html/rfc7230
- https://www.php-fig.org/psr/psr-7/
- https://www.php-fig.org/psr/psr-17/