fossar/guzzle-transcoder

Guzzle plugin that converts responses to UTF-8

0.3.0 2023-03-07 23:13 UTC

Requires

• php: >=7.2.5
• fossar/transcoder: ^1.0 || ^2.0
• guzzlehttp/guzzle: ^6.3 || ^7.0
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• php-parallel-lint/php-parallel-lint: ^1.0
• symfony/phpunit-bridge: ^6.2

MIT

• Jan Tojnar

README

This package provides a Guzzle 6/7 middleware that transparently converts documents obtained by Guzzle from its native encoding to UTF-8 (or any other specified encoding). It supports the following features:

• Detection of charset from Content-Type HTTP header.
• Detection of charset from meta element in HTML document.
• Detection of charset from XML declaration in RSS and other XML documents.
• Updating the Content-Type header in the Response object according to target encoding.
• Updating the metadata in the Response body according to target encoding (not enabled by default).

Installation

It is recommended to install the library using Composer:

composer require fossar/guzzle-transcoder

Usage

Basic example

use Fossar\GuzzleTranscoder\GuzzleTranscoder;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;

$stack = HandlerStack::create();
$stack->push(new GuzzleTranscoder);
$client = new Client(['handler' => $stack]);

$url = 'https://www.myseosolution.de/scripts/encoding-test.php?enc=iso'; // request website with iso-8859-1 encoding
$req = $client->get($url);
echo $req->getBody();

Full example

use Fossar\GuzzleTranscoder\GuzzleTranscoder;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;

$stack = HandlerStack::create();
$stack->push(new GuzzleTranscoder([
	'targetEncoding' => 'windows-1252',
	// Swap the default settings:
	'replaceHeaders' => false,
	'replaceContent' => true,
]));
$client = new Client(['handler' => $stack]);

$url = 'https://www.myseosolution.de/scripts/encoding-test.php?enc=iso'; // request website with iso-8859-1 encoding
$req = $client->get($url);
echo $req->getHeaderLine('Content-Type') . "\n"; // HTTP header will remain unchanged
echo $req->getBody();

Credits

It is largely based on Pascal Landau’s guzzle-auto-charset-encoding-subscriber and web-utility libraries.

We are using Transcoder library. This allows us to fall back to iconv when mbstring is not available or an encoding is not supported by it.

The source code is available under the terms of MIT license