Merge pull request #44 from sunrise-php/release/v3.4.3

v3.4.3

Author: fenric

README.md

@@ -1,178 +1,5 @@
-# HTTP message wrapper for PHP 7.4+, based on RFC-7230, PSR-7, and PSR-17.
+# An HTTP message implementation based on PSR-7, PSR-17 and RFC-7230
 
-[![Build Status](https://scrutinizer-ci.com/g/sunrise-php/http-message/badges/build.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-message/build-status/master)
-[![Code Coverage](https://scrutinizer-ci.com/g/sunrise-php/http-message/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-message/?branch=master)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunrise-php/http-message/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-message/?branch=master)
-[![Total Downloads](https://poser.pugx.org/sunrise/http-message/downloads?format=flat)](https://packagist.org/packages/sunrise/http-message)
-[![Latest Stable Version](https://poser.pugx.org/sunrise/http-message/v/stable?format=flat)](https://packagist.org/packages/sunrise/http-message)
-[![License](https://poser.pugx.org/sunrise/http-message/license?format=flat)](https://packagist.org/packages/sunrise/http-message)
+## Resources
 
----
-
-## Installation
-
-```bash
-composer require sunrise/http-message
-```
-
-## How to Use
-
-We highly recommend studying [PSR-7](https://www.php-fig.org/psr/psr-7/) and [PSR-17](https://www.php-fig.org/psr/psr-17/), as only basic examples are provided below.
-
-### Server Request from Global Environment
-
-```php
-$request = \Sunrise\Http\Message\ServerRequestFactory::fromGlobals();
-```
-
-### Typed Messages
-
-#### JSON Request
-
-```php
-$request = new \Sunrise\Http\Message\Request\JsonRequest('POST', '/', ['foo' => 'bar']);
-```
-
-You can also specify [encoding flags](https://www.php.net/manual/en/json.constants.php#constant.json-hex-tag) and the maximum nesting depth as shown below:
-
-```php
-$request = new \Sunrise\Http\Message\Request\JsonRequest('POST', '/', [], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE, 512);
-```
-
-#### URL Encoded Request
-
-```php
-$request = new \Sunrise\Http\Message\Request\UrlEncodedRequest('POST', '/', ['foo' => 'bar']);
-```
-
-You can also specify the [encoding type](https://www.php.net/manual/ru/url.constants.php#constant.php-query-rfc1738) as shown below:
-
-```php
-$rfc1738 = \Sunrise\Http\Message\Request\UrlEncodedRequest::ENCODING_TYPE_RFC1738;
-$request = new \Sunrise\Http\Message\Request\UrlEncodedRequest('POST', '/', [], $rfc1738);
-```
-
-```php
-$rfc3986 = \Sunrise\Http\Message\Request\UrlEncodedRequest::ENCODING_TYPE_RFC3986;
-$request = new \Sunrise\Http\Message\Request\UrlEncodedRequest('POST', '/', [], $rfc3986);
-```
-
-#### JSON Response
-
-```php
-$response = new \Sunrise\Http\Message\Response\JsonResponse(200, ['foo' => 'bar']);
-```
-
-You can also specify [encoding flags](https://www.php.net/manual/en/json.constants.php#constant.json-hex-tag) and the maximum nesting depth as shown below:
-
-```php
-$response = new \Sunrise\Http\Message\Response\JsonResponse(200, [], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE, 512);
-```
-
-#### HTML Response
-
-```php
-$response = new \Sunrise\Http\Message\Response\HtmlResponse(200, '<h1>Welcome!</h1>');
-```
-
-### Streams
-
-#### File Stream
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\FileStream('/folder/file', 'r+b');
-```
-
-#### Input Stream
-
-More details about this stream can be found on the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.input).
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\PhpInputStream();
-```
-
-#### Memory Stream
-
-More details about this stream can be found on the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.input).
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\PhpMemoryStream('r+b');
-```
-
-#### Temporary Stream
-
-More details about this stream can be found on the [official page](https://www.php.net/manual/en/wrappers.php.php#wrappers.php.input).
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\PhpTempStream('r+b');
-```
-
-You can also specify a memory limit. When this limit is reached, PHP will switch to using a temporary file instead of memory.
-
-> Please note that the default memory limit is 2MB.
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\PhpTempStream('r+b', 1e+6);
-```
-
-#### Temporary File Stream
-
-For more details about the behavior of temporary files, visit [the official page](https://www.php.net/manual/en/function.tmpfile).
-
-The stream opens a unique temporary file in binary read/write mode (w+b). The file will be automatically deleted when it is closed or when the program terminates.
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\TmpfileStream();
-$stream->getMetadata('uri'); // the file path
-```
-
-If you don't require the behavior described above, you can use an alternative temporary file stream:
-
-```php
-$stream = new \Sunrise\Http\Message\Stream\TempFileStream();
-$stream->getMetadata('uri'); // the file path
-```
-
-### PSR-7 and PSR-17
-
-The following classes are implementations 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 are implementations 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`
-
-### Error Handling
-
-Any exceptions thrown by this package can be caught through the following interface:
-
-```php
-try {
-} catch (\Sunrise\Http\Message\Exception\ExceptionInterface $e) {
-}
-```
-
----
-
-## 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/
+- [Documentation](https://dev.sunrise-studio.io/docs/packages/sunrise/http-message/)

composer.json

@@ -1,22 +1,17 @@
 {
   "name": "sunrise/http-message",
   "homepage": "https://github.com/sunrise-php/http-message",
-  "description": "HTTP message implementation for PHP 7.4+ based on RFC-7230, PSR-7 and PSR-17.",
+  "description": "An HTTP message implementation based on PSR-7, PSR-17 and RFC-7230.",
   "license": "MIT",
   "keywords": [
     "fenric",
     "sunrise",
     "http",
-    "header",
-    "message",
     "request",
     "response",
-    "stream",
-    "uri",
-    "upload",
-    "rfc-7230",
     "psr-7",
-    "psr-17"
+    "psr-17",
+    "rfc-7230"
   ],
   "authors": [
     {

psalm.xml.dist

@@ -14,7 +14,6 @@
   </projectFiles>
 
   <issueHandlers>
-    <ClassMustBeFinal errorLevel="suppress" />
     <MissingOverrideAttribute errorLevel="suppress" />
     <PossiblyUnusedMethod errorLevel="suppress" />
     <PossiblyUnusedReturnValue errorLevel="suppress" />

src/Exception/InvalidArgumentException.php

@@ -11,6 +11,9 @@
 
 namespace Sunrise\Http\Message\Exception;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
 }

src/Exception/RuntimeException.php

@@ -11,6 +11,9 @@
 
 namespace Sunrise\Http\Message\Exception;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {
 }

src/Request/UrlEncodedRequest.php

@@ -15,13 +15,8 @@
 use Sunrise\Http\Message\Exception\InvalidArgumentException;
 use Sunrise\Http\Message\Request;
 use Sunrise\Http\Message\Stream\PhpTempStream;
-use TypeError;
 
-use function gettype;
 use function http_build_query;
-use function is_array;
-use function is_object;
-use function sprintf;
 
 use const PHP_QUERY_RFC1738;
 use const PHP_QUERY_RFC3986;
@@ -36,32 +31,21 @@ final class UrlEncodedRequest extends Request
 
     /**
      * @param mixed $uri
-     * @param array<array-key, mixed>|object $data
+     * @param mixed $data
      * @param self::ENCODING_TYPE_* $encodingType
      *
      * @throws InvalidArgumentException
      */
     public function __construct(string $method, $uri, $data, int $encodingType = self::ENCODING_TYPE_RFC1738)
     {
-        /**
-         * @psalm-suppress DocblockTypeContradiction
-         * @phpstan-ignore-next-line
-         */
-        if (!is_array($data) && !is_object($data)) {
-            throw new TypeError(sprintf(
-                'Argument #3 ($data) must be of type string, %s given',
-                gettype($data),
-            ));
-        }
-
         parent::__construct($method, $uri);
 
         $this->setBody(self::createBody($data, $encodingType));
         $this->setHeader('Content-Type', 'application/x-www-form-urlencoded; charset=utf-8');
     }
 
     /**
-     * @param array<array-key, mixed>|object $data
+     * @param mixed $data
      * @param self::ENCODING_TYPE_* $encodingType
      */
     private static function createBody($data, int $encodingType): StreamInterface
@@ -70,10 +54,10 @@ private static function createBody($data, int $encodingType): StreamInterface
             return $data;
         }
 
-        $encodedData = http_build_query($data, '', '&', $encodingType);
+        $query = http_build_query((array) $data, '', '&', $encodingType);
 
         $stream = new PhpTempStream('r+b');
-        $stream->write($encodedData);
+        $stream->write($query);
         $stream->rewind();
 
         return $stream;

src/RequestFactory.php

@@ -14,6 +14,9 @@
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class RequestFactory implements RequestFactoryInterface
 {
     /**

src/ResponseFactory.php

@@ -14,6 +14,9 @@
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class ResponseFactory implements ResponseFactoryInterface
 {
     /**

src/ServerRequest.php

@@ -21,6 +21,9 @@
 use function is_array;
 use function is_object;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class ServerRequest extends Request implements ServerRequestInterface
 {
     /**

src/ServerRequestFactory.php

@@ -15,6 +15,9 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Sunrise\Http\Message\Stream\PhpInputStream;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class ServerRequestFactory implements ServerRequestFactoryInterface
 {
     /**