Rename and add dependency httpsoft/http-message

Author: devanych

CHANGELOG.md

@@ -1,4 +1,4 @@
-# HTTP Request Change Log
+# HTTP Server Request Change Log
 
 ## 1.0.0 - under development
 

README.md

@@ -1,4 +1,4 @@
-# HTTP Request
+# HTTP Server Request
 
 [![License](https://poser.pugx.org/httpsoft/http-request/license)](https://packagist.org/packages/httpsoft/http-request)
 [![Latest Stable Version](https://poser.pugx.org/httpsoft/http-request/v)](https://packagist.org/packages/httpsoft/http-request)
@@ -7,90 +7,66 @@
 [![Scrutinizer Code Coverage](https://scrutinizer-ci.com/g/httpsoft/http-request/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-request/?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/httpsoft/http-request/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-request/?branch=master)
 
-This package implements [Psr\Http\Message\RequestInterface](https://github.com/php-fig/http-message/blob/master/src/RequestInterface.php) and [Psr\Http\Message\ServerRequestInterface](https://github.com/php-fig/http-message/blob/master/src/ServerRequestInterface.php) from [PSR-7 HTTP Message](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md) in accordance with the [RFC 7230](https://tools.ietf.org/html/rfc7230) and [RFC 7231](https://tools.ietf.org/html/rfc7231) specifications.
+This package makes it easy and flexible to create PSR-7 components [ServerRequest](https://github.com/php-fig/http-message/blob/master/src/ServerRequestInterface.php) and [UploadedFile](https://github.com/php-fig/http-message/blob/master/src/UploadedFileInterface.php).
+
+Depends on the [httpsoft/http-message](https://github.com/httpsoft/http-message) package.
 
 ## Documentation
 
-* [In English language](https://httpsoft.org/docs/request).
-* [In Russian language](https://httpsoft.org/ru/docs/request).
+* [In English language](https://httpsoft.org/docs/server-request).
+* [In Russian language](https://httpsoft.org/ru/docs/server-request).
 
 ## Installation
 
 This package requires PHP version 7.4 or later.
 
 ```
-composer require httpsoft/http-request
+composer require httpsoft/http-server-request
 ```
 
-## Usage Request
+## Usage ServerRequestCreator
 
 ```php
-use HttpSoft\Request\Request;
-use HttpSoft\Request\RequestFactory;
-
-$request = new Request('POST', 'http://example.com', ['Content-Type' => 'text/html'], 'data://,Content', '2');
-// Or using the factory:
-$request = RequestFactory::create(
-    'POST', // Request method
-    'https://example.com', // Request URI
-    ['Content-Type' => 'text/html' /* Other headers */],
-    'data://,Content', // HTTP message body
-    '2' // HTTP protocol version
-);
-
-$request->getMethod(); // 'POST'
-$request->getProtocolVersion(); // '2'
-$request->getBody()->getContents(); // 'Content'
-(string) $request->getUri(); // 'https://example.com/path'
-$request->getHeaders(); // ['Host' => ['example.com'], 'Content-Type' => ['text/html']]
-```
+use HttpSoft\ServerRequest\ServerRequestCreator;
 
-## Usage ServerRequest
-
-```php
-use HttpSoft\Request\ServerRequest;
-use HttpSoft\Request\ServerRequestFactory;
-
-$request = new ServerRequest(
-    $_SERVER,
-    $_FILES,
-    $_COOKIE,
-    $_GET,
-    $_POST,
-    'GET', // Request method
-    'https://example.com', // Request URI
-    [/* Headers */],
-    'php://input', // HTTP message body
-    '2' // HTTP protocol version
-);
-// Or using the factory (all necessary data will be received automatically):
-$request = ServerRequestFactory::createFromGlobals($_SERVER, $_FILES, $_COOKIE, $_GET, $_POST);
+// All necessary data will be received automatically:
+$request = ServerRequestCreator::createFromGlobals($_SERVER, $_FILES, $_COOKIE, $_GET, $_POST);
 // equivalently to:
-$request = ServerRequestFactory::createFromGlobals();
+$request = ServerRequestCreator::createFromGlobals();
 // equivalently to:
-$request = ServerRequestFactory::create();
-
-$request->getMethod(); // 'GET'
-$request->getProtocolVersion(); // '2'
-$request->getBody()->getContents(); // ''
-(string) $request->getUri(); // 'https://example.com'
-$request->getHeaders(); // ['Host' => ['example.com']]
-$request->getServerParams(); // $_SERVER
-$request->getUploadedFiles(); // $_FILES
-$request->getCookieParams(); // $_COOKIE
-$request->getQueryParams(); // $_GET
-$request->getParsedBody(); // $_POST
-$request->getAttributes(); // []
+$request = ServerRequestCreator::create();
 ```
 
-By default [HttpSoft\Request\SapiNormalizer](https://github.com/httpsoft/http-request/blob/master/src/SapiNormalizer.php) is used for normalization of server parameters. You can use your own server parameters normalizer, for this you need to implement an [HttpSoft\Request\ServerNormalizerInterface](https://github.com/httpsoft/http-request/blob/master/src/ServerNormalizerInterface.php) interface.
+By default [HttpSoft\ServerRequest\SapiNormalizer](https://github.com/httpsoft/http-server-request/blob/master/src/SapiNormalizer.php) is used for normalization of server parameters. You can use your own server parameters normalizer, for this you need to implement an [HttpSoft\ServerRequest\ServerNormalizerInterface](https://github.com/httpsoft/http-server-request/blob/master/src/ServerNormalizerInterface.php) interface.
 
 ```php
 $normalizer = new YouCustomServerNormalizer();
 
-$request = ServerRequestFactory::create($normalizer);
+$request = ServerRequestCreator::create($normalizer);
 // equivalently to:
-$request = ServerRequestFactory::createFromGlobals($_SERVER, $_FILES, $_COOKIE, $_GET, $_POST, $normalizer);
-// or with custom superglobals
-$request = ServerRequestFactory::createFromGlobals($server, $files, $cookie, $get, $post, $normalizer);
+$request = ServerRequestCreator::createFromGlobals($_SERVER, $_FILES, $_COOKIE, $_GET, $_POST, $normalizer);
+// or with custom superglobals:
+$request = ServerRequestCreator::createFromGlobals($server, $files, $cookie, $get, $post, $normalizer);
+```
+
+## Usage UploadedFileCreator
+
+```php
+use HttpSoft\ServerRequest\UploadedFileCreator;
+
+/** @var StreamInterface|string|resource $streamOrFile */
+$uploadedFile = UploadedFileCreator::create($streamOrFile, 1024, UPLOAD_ERR_OK, 'file.txt', 'text/plain');
+
+// Create a new `HttpSoft\UploadedFile\UploadedFile` instance from array (the item `$_FILES`)
+$uploadedFile = UploadedFileCreator::createFromArray([
+    'name' => 'filename.jpg', // optional
+    'type' => 'image/jpeg', // optional
+    'tmp_name' => '/tmp/php/php6hst32',
+    'error' => 0, // UPLOAD_ERR_OK
+    'size' => 98174,
+]);
+
+// Normalizes the superglobal structure and converts each array
+// value to an instance of `Psr\Http\Message\UploadedFileInterface`.
+$uploadedFiles = UploadedFileCreator::createFromGlobals($_FILES);
 ```

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "httpsoft/http-server-request",
-    "description": "Functionality for creating a PSR-7 ServerRequest",
+    "description": "Infrastructure for creating PSR-7 ServerRequest and UploadedFile",
     "keywords": ["php", "http", "http-server-request", "psr-7", "http-message"],
     "homepage": "https://httpsoft.org/",
     "type": "library",

phpcs.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
-<ruleset name="HttpSoft Request Coding Standard">
-    <description>HttpSoft Request Coding Standard</description>
+<ruleset name="HttpSoft Server Request Coding Standard">
+    <description>HttpSoft Server Request Coding Standard</description>
 
     <!-- display progress -->
     <arg value="p"/>

phpunit.xml.dist

@@ -19,7 +19,7 @@
     </php>
 
     <testsuites>
-        <testsuite name="HttpSoft Request Test Suite">
+        <testsuite name="HttpSoft Server Request Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>

psalm.xml

@@ -14,12 +14,11 @@
     </projectFiles>
 
     <issueHandlers>
-        <DocblockTypeContradiction errorLevel="info" />
-        <LessSpecificImplementedReturnType errorLevel="info" />
-        <MixedArgumentTypeCoercion errorLevel="info" />
+        <InvalidReturnStatement errorLevel="info" />
+        <InvalidReturnType errorLevel="info" />
+        <MixedArgument errorLevel="info" />
         <MixedAssignment errorLevel="info" />
-        <MixedPropertyTypeCoercion errorLevel="info" />
-        <PropertyNotSetInConstructor errorLevel="info" />
-        <RedundantConditionGivenDocblockType errorLevel="info" />
+        <MixedArgumentTypeCoercion errorLevel="info" />
+        <PossiblyNullArgument errorLevel="info" />
     </issueHandlers>
 </psalm>

src/PhpInputStream.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HttpSoft\ServerRequest;
+
+use HttpSoft\Message\StreamTrait;
+use Psr\Http\Message\StreamInterface;
+
+final class PhpInputStream implements StreamInterface
+{
+    use StreamTrait {
+        read as private readInternal;
+        getContents as private getContentsInternal;
+    }
+
+    /**
+     * @var string
+     */
+    private string $cache = '';
+
+    /**
+     * @var bool
+     */
+    private bool $isEof = false;
+
+    /**
+     * @param string|resource $stream
+     */
+    public function __construct($stream = 'php://input')
+    {
+        $this->init($stream, 'r');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __toString(): string
+    {
+        if (!$this->isEof) {
+            $this->getContents();
+        }
+
+        return $this->cache;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable(): bool
+    {
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($length): string
+    {
+        $result = $this->readInternal($length);
+
+        if (!$this->isEof) {
+            $this->cache .= $result;
+        }
+
+        if ($this->eof()) {
+            $this->isEof = true;
+        }
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContents(): string
+    {
+        if ($this->isEof) {
+            return $this->cache;
+        }
+
+        $result = $this->getContentsInternal();
+        $this->cache .= $result;
+        $this->isEof = true;
+
+        return $result;
+    }
+}