https://github.com/middlewares/encoder

PSR-15 middleware to encode the response body to gzip or deflate
https://github.com/middlewares/encoder

compression deflate gzip http middleware psr-15

Last synced: about 2 months ago
JSON representation

PSR-15 middleware to encode the response body to gzip or deflate

• Host: GitHub
• URL: https://github.com/middlewares/encoder
• Owner: middlewares
• License: mit
• Created: 2016-10-11T10:01:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-09T03:43:50.000Z (8 months ago)
• Last Synced: 2024-07-20T14:43:15.082Z (2 months ago)
• Topics: compression, deflate, gzip, http, middleware, psr-15
• Language: PHP
• Size: 52.7 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-psr15-middlewares - middlewares/encoder - Compress responses with [gzencode](http://php.net/manual/en/function.gzencode.php) or [gzdeflate](http://php.net/manual/en/function.gzdeflate.php). (Packages / Content)

README

        
# middlewares/encoder

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)

![Testing][ico-ga]

[![Total Downloads][ico-downloads]][link-downloads]

Middleware to encode the response body to `gzip` or `deflate` if the `Accept-Encoding` header is present and adds the `Content-Encoding` header. This package is splitted into the following components:

* [GzipEncoder](#gzipencoder)

* [DeflateEncoder](#deflateencoder)

You can use the component `ContentEncoding` in the [middlewares/negotiation](https://github.com/middlewares/negotiation#contentencoding) to negotiate the encoding to use.

## Requirements

* PHP >= 7.2

* A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)

* A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)

## Installation

This package is installable and autoloadable via Composer as [middlewares/encoder](https://packagist.org/packages/middlewares/encoder).

```sh

composer require middlewares/encoder

```

## GzipEncoder

Compress the response body to GZIP format using [gzencode](http://php.net/manual/en/function.gzencode.php) and add the header `Content-Encoding: gzip`.

**Note:** The response body is encoded only if the header contains the value `gzip` in the header `Accept-Encoding`.

```php

Dispatcher::run([

	new Middlewares\GzipEncoder(),

]);

```

Optionally, you can provide a `Psr\Http\Message\StreamFactoryInterface` that will be used to create the response body. If it's not defined, [Middleware\Utils\Factory](https://github.com/middlewares/utils#factory) will be used to detect it automatically.

```php

$streamFactory = new MyOwnStreamFactory();

$encoder = new Middlewares\GzipEncoder($streamFactory);

```

## DeflateEncoder

Compress the response body to Deflate format using [gzdeflate](http://php.net/manual/en/function.gzdeflate.php) and add the header `Content-Encoding: deflate`.

**Note:** The response body is encoded only if the header contains the value `deflate` in the header `Accept-Encoding`.

```php

Dispatcher::run([

	new Middlewares\DeflateEncoder(),

]);

```

Optionally, you can provide a `Psr\Http\Message\StreamFactoryInterface` that will be used to create the response body. If it's not defined, [Middleware\Utils\Factory](https://github.com/middlewares/utils#factory) will be used to detect it automatically.

```php

$streamFactory = new MyOwnStreamFactory();

$encoder = new Middlewares\DeflateEncoder($streamFactory);

```

## Common Options

### contentType

This option allows the overring of the default patterns used to detect what resources are already compressed.

The default pattern detects the following mime types `text/*`, `application/json`, `image/svg+xml` and empty content types as compressible. If the pattern begins with a forward slash `/` it is tested as a regular expression, otherwise its is case-insensitive string comparison.

```php

Dispatcher::run([

	(new Middlewares\DeflateEncoder())

            ->contentType(

                    '/^application\/pdf$/', // Regular Expression

                    'text/csv' // Text Pattern

            )

]);

```

---

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.

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

[ico-version]: https://img.shields.io/packagist/v/middlewares/encoder.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-ga]: https://github.com/middlewares/encoder/workflows/testing/badge.svg

[ico-downloads]: https://img.shields.io/packagist/dt/middlewares/encoder.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/middlewares/encoder

[link-downloads]: https://packagist.org/packages/middlewares/encoder