php-extended / php-http-client-gzip
A psr-18 compliant middleware client that handles gz compression and decompression
Requires
- php: >=8.0
- ext-zip: *
- psr/http-client: ^1
- psr/http-factory: ^1
Requires (Dev)
- dev-master
- 7.0.6
- 7.0.5
- 7.0.4
- 7.0.3
- 7.0.2
- 7.0.1
- 7.0.0
- 6.1.6
- 6.1.5
- 6.1.4
- 6.1.3
- 6.1.2
- 6.1.1
- 6.1.0
- 6.0.3
- 6.0.2
- 6.0.1
- 6.0.0
- 5.0.1
- 5.0.0
- 4.0.1
- 4.0.0
- 3.1.23
- 3.1.22
- 3.1.21
- 3.1.20
- 3.1.19
- 3.1.18
- 3.1.17
- 3.1.16
- 3.1.15
- 3.1.14
- 3.1.13
- 3.1.12
- 3.1.11
- 3.1.10
- 3.1.9
- 3.1.8
- 3.1.7
- 3.1.6
- 3.1.5
- 3.1.4
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.0.0
- 1.0.2
- 1.0.1
- 1.0.0
This package is auto-updated.
Last update: 2024-10-31 00:22:14 UTC
README
A psr-18 compliant middleware client that handles gz compression and decompression.
Installation
The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.
- Download
composer.phar
from their website. - Then run the following command to install this library as dependency :
php composer.phar php-extended/php-http-client-gzip ^7
Basic Usage
This library is to make a man in the middle for http requests and responses and logs the events when requests passes. It may be used the following way :
/** @var $client Psr\Http\Message\ProcessorInterface */ // psr-18
/** @var $request Psr\Http\Message\RequestInterface */ // psr-7
$client = new GzipClient($client);
$response = $client->sendRequest($request);
/** @var $response Psr\Http\Message\ResponseInterface */
This library handles the adding of Accept-Header
on the requests and the
decoding according to the Content-Encoding
header on the responses.
This library is also able to unzip received gz-like files. For it to work :
- First the request must contain an
X-Php-Download-File
header pointing to a valid file path. If a file already exists in this location, it will be overwritten. - Second, the http client must support the
X-Php-Download-File
header to write the downloaded file at that location and make aStreamInterface
from that file.
If the response that is given to the X-Php-Download-File
is a gzip
compatible file, it will be uncompressed to the same directory as the current
file is but with a made-up name. All files into the tarball or equivalent
will be concatenated to this location.
This client will set the X-Php-Uncompressed-File
header with the
location of the newly uncompressed file, and will replace the existing
StreamInterface
pointing to the downloaded file with a new one pointing
to the uncompressed file.
The downloaded file will not be deleted, it is the job of the calling library to delete both the downloaded file and the uncompressed file once work has been done.
$client = new GzipClient($client);
$request = $request->withAddedHeader('X-Php-Download-File' => '/tmp/file.gz');
$response = $client->sendRequest($response);
$stream = $response->getBody();
/** @var $stream \Psr\Http\Message\StreamInterface */
// the stream points to the /tmp/{$sha1} file that is unzipped
// the exact location of the file can be uncovered with :
$filePath = $response->getHeader('X-Php-Uncompressed-File');
License
MIT (See license file).