added MessageUtil::toJSON()

Author: codemasher

src/MessageUtil.php

@@ -16,7 +16,7 @@
 use DateInterval, DateTimeInterface, RuntimeException, Throwable;
 use function array_map, explode, extension_loaded, function_exists, gzdecode, gzinflate, gzuncompress, implode,
 	in_array, json_decode, json_encode, rawurldecode, simplexml_load_string, sprintf, strtolower, trim;
-use const JSON_THROW_ON_ERROR;
+use const JSON_PRETTY_PRINT, JSON_THROW_ON_ERROR, JSON_UNESCAPED_SLASHES;
 
 /**
  *
@@ -68,7 +68,7 @@ public static function toString(MessageInterface $message, bool|null $appendBody
 				'%s %s HTTP/%s',
 				$message->getMethod(),
 				$message->getRequestTarget(),
-				$message->getProtocolVersion()
+				$message->getProtocolVersion(),
 			);
 
 			if(!$message->hasHeader('host')){
@@ -81,7 +81,7 @@ public static function toString(MessageInterface $message, bool|null $appendBody
 				'HTTP/%s %s %s',
 				$message->getProtocolVersion(),
 				$message->getStatusCode(),
-				$message->getReasonPhrase()
+				$message->getReasonPhrase(),
 			);
 		}
 
@@ -97,6 +97,46 @@ public static function toString(MessageInterface $message, bool|null $appendBody
 		return $msg;
 	}
 
+	/**
+	 * Returns a JSON representation of an HTTP message.
+	 */
+	public static function toJSON(MessageInterface $message, bool|null $appendBody = null):string{
+		$appendBody ??= true;
+		$msg          = [];
+
+		if($message instanceof RequestInterface){
+			$msg['request'] = [
+				'url'    => (string)$message->getUri(),
+				'method' => $message->getMethod(),
+				'target' => $message->getRequestTarget(),
+				'http'   => $message->getProtocolVersion(),
+			];
+		}
+		elseif($message instanceof ResponseInterface){
+			$msg['response'] = [
+				'status' => $message->getStatusCode(),
+				'reason' => $message->getReasonPhrase(),
+				'http'   => $message->getProtocolVersion(),
+			];
+		}
+
+		$msg['headers'] = [];
+
+		if($message instanceof RequestInterface && !$message->hasHeader('host')){
+			$msg['headers']['Host'] = $message->getUri()->getHost();
+		}
+
+		foreach($message->getHeaders() as $name => $values){
+			$msg['headers'][$name] = implode(', ', $values);
+		}
+
+		if($appendBody === true){
+			$msg['body'] = self::getContents($message);
+		}
+
+		return json_encode($msg, (JSON_THROW_ON_ERROR|JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
+	}
+
 	/**
 	 * Decompresses the message content according to the Content-Encoding header and returns the decompressed data
 	 *

tests/MessageUtilTest.php

@@ -17,6 +17,7 @@
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use function extension_loaded, file_get_contents, function_exists, sprintf, str_repeat;
+use function json_decode;
 
 /**
  *
@@ -78,6 +79,35 @@ public function testMessageToString():void{
 		);
 	}
 
+	public function testMessageToJSON():void{
+		$body = $this->streamFactory->createStream('testbody');
+
+		$request = $this->requestFactory
+			->createRequest('GET', 'https://localhost/foo')
+			->withAddedHeader('foo', 'bar')
+			->withBody($body)
+		;
+
+		$json = json_decode(MessageUtil::toJSON($request));
+
+		$this::assertSame('GET', $json->request->method);
+		$this::assertSame('localhost', $json->headers->{'Host'});
+		$this::assertSame('testbody', $json->body);
+
+
+		$response = $this->responseFactory
+			->createResponse()
+			->withAddedHeader('foo', 'bar')
+			->withBody($body)
+		;
+
+		$json = json_decode(MessageUtil::toJSON($response));
+
+		$this::assertSame(200, $json->response->status);
+		$this::assertSame('bar', $json->headers->{'foo'});
+		$this::assertSame('testbody', $json->body);
+	}
+
 	public static function decompressFnProvider():array{
 		return [
 			'br'       => ['brotli_compress', 'br'],