sunrise-php / http-message

src/Response/JsonResponse.php

Indentation +46 added lines, -46 removed lines

@@ -36,57 +36,57 @@
 final class JsonResponse extends Response
 {
 
-    /**
-     * Constructor of the class
-     *
-     * @param int $statusCode
-     * @param mixed $data
-     * @param int $flags
-     * @param int $depth
-     *
-     * @throws InvalidArgumentException
-     */
-    public function __construct(int $statusCode, $data, int $flags = 0, int $depth = 512)
-    {
-        parent::__construct($statusCode);
+	/**
+	 * Constructor of the class
+	 *
+	 * @param int $statusCode
+	 * @param mixed $data
+	 * @param int $flags
+	 * @param int $depth
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(int $statusCode, $data, int $flags = 0, int $depth = 512)
+	{
+		parent::__construct($statusCode);
 
-        $this->setBody($this->createBody($data, $flags, $depth));
+		$this->setBody($this->createBody($data, $flags, $depth));
 
-        $this->setHeader('Content-Type', 'application/json; charset=utf-8');
-    }
+		$this->setHeader('Content-Type', 'application/json; charset=utf-8');
+	}
 
-    /**
-     * Creates the response body from the given JSON data
-     *
-     * @param mixed $data
-     * @param int $flags
-     * @param int $depth
-     *
-     * @return StreamInterface
-     *
-     * @throws InvalidArgumentException
-     */
-    private function createBody($data, int $flags, int $depth): StreamInterface
-    {
-        if ($data instanceof StreamInterface) {
-            return $data;
-        }
+	/**
+	 * Creates the response body from the given JSON data
+	 *
+	 * @param mixed $data
+	 * @param int $flags
+	 * @param int $depth
+	 *
+	 * @return StreamInterface
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	private function createBody($data, int $flags, int $depth): StreamInterface
+	{
+		if ($data instanceof StreamInterface) {
+			return $data;
+		}
 
-        $flags |= JSON_THROW_ON_ERROR;
+		$flags |= JSON_THROW_ON_ERROR;
 
-        try {
-            $payload = json_encode($data, $flags, $depth);
-        } catch (JsonException $e) {
-            throw new InvalidArgumentException(sprintf(
-                'Unable to create JSON response due to invalid JSON data: %s',
-                $e->getMessage()
-            ), 0, $e);
-        }
+		try {
+			$payload = json_encode($data, $flags, $depth);
+		} catch (JsonException $e) {
+			throw new InvalidArgumentException(sprintf(
+				'Unable to create JSON response due to invalid JSON data: %s',
+				$e->getMessage()
+			), 0, $e);
+		}
 
-        $stream = new PhpTempStream('r+b');
-        $stream->write($payload);
-        $stream->rewind();
+		$stream = new PhpTempStream('r+b');
+		$stream->write($payload);
+		$stream->rewind();
 
-        return $stream;
-    }
+		return $stream;
+	}
 }

src/Stream/PhpMemoryStream.php

Indentation +9 added lines, -9 removed lines

@@ -27,13 +27,13 @@
 final class PhpMemoryStream extends Stream
 {
 
-    /**
-     * Constructor of the class
-     *
-     * @param string $mode
-     */
-    public function __construct(string $mode = 'r+b')
-    {
-        parent::__construct(fopen('php://memory', $mode));
-    }
+	/**
+	 * Constructor of the class
+	 *
+	 * @param string $mode
+	 */
+	public function __construct(string $mode = 'r+b')
+	{
+		parent::__construct(fopen('php://memory', $mode));
+	}
 }

src/Stream/PhpInputStream.php

Indentation +11 added lines, -11 removed lines

@@ -28,18 +28,18 @@
 final class PhpInputStream extends Stream
 {
 
-    /**
-     * Constructor of the class
-     */
-    public function __construct()
-    {
-        $input = fopen('php://input', 'rb');
-        $resource = fopen('php://temp', 'r+b');
+	/**
+	 * Constructor of the class
+	 */
+	public function __construct()
+	{
+		$input = fopen('php://input', 'rb');
+		$resource = fopen('php://temp', 'r+b');
 
-        stream_copy_to_stream($input, $resource);
+		stream_copy_to_stream($input, $resource);
 
-        parent::__construct($resource);
+		parent::__construct($resource);
 
-        $this->rewind();
-    }
+		$this->rewind();
+	}
 }

src/Stream/FileStream.php

Indentation +26 added lines, -26 removed lines

@@ -31,30 +31,30 @@
 final class FileStream extends Stream
 {
 
-    /**
-     * Constructor of the class
-     *
-     * @param string $filename
-     * @param string $mode
-     *
-     * @throws RuntimeException
-     */
-    public function __construct(string $filename, string $mode)
-    {
-        try {
-            $resource = fopen($filename, $mode);
-        } catch (Throwable $e) {
-            $resource = false;
-        }
-
-        if (!is_resource($resource)) {
-            throw new RuntimeException(sprintf(
-                'Unable to open the file "%s" in the mode "%s"',
-                $filename,
-                $mode
-            ));
-        }
-
-        parent::__construct($resource);
-    }
+	/**
+	 * Constructor of the class
+	 *
+	 * @param string $filename
+	 * @param string $mode
+	 *
+	 * @throws RuntimeException
+	 */
+	public function __construct(string $filename, string $mode)
+	{
+		try {
+			$resource = fopen($filename, $mode);
+		} catch (Throwable $e) {
+			$resource = false;
+		}
+
+		if (!is_resource($resource)) {
+			throw new RuntimeException(sprintf(
+				'Unable to open the file "%s" in the mode "%s"',
+				$filename,
+				$mode
+			));
+		}
+
+		parent::__construct($resource);
+	}
 }

src/Stream/TmpfileStream.php

Indentation +19 added lines, -19 removed lines

@@ -35,23 +35,23 @@
 final class TmpfileStream extends Stream
 {
 
-    /**
-     * Constructor of the class
-     *
-     * @throws RuntimeException
-     */
-    public function __construct()
-    {
-        $dirname = sys_get_temp_dir();
-        if (!is_writable($dirname)) {
-            throw new RuntimeException('Temporary files directory is not writable');
-        }
-
-        $resource = tmpfile();
-        if (!is_resource($resource)) {
-            throw new RuntimeException('Temporary file cannot be created or opened');
-        }
-
-        parent::__construct($resource);
-    }
+	/**
+	 * Constructor of the class
+	 *
+	 * @throws RuntimeException
+	 */
+	public function __construct()
+	{
+		$dirname = sys_get_temp_dir();
+		if (!is_writable($dirname)) {
+			throw new RuntimeException('Temporary files directory is not writable');
+		}
+
+		$resource = tmpfile();
+		if (!is_resource($resource)) {
+			throw new RuntimeException('Temporary file cannot be created or opened');
+		}
+
+		parent::__construct($resource);
+	}
 }

src/ServerRequest.php

Indentation +350 added lines, -350 removed lines

@@ -35,354 +35,354 @@
 class ServerRequest extends Request implements ServerRequestInterface
 {
 
-    /**
-     * The server parameters
-     *
-     * @var array
-     */
-    private array $serverParams;
-
-    /**
-     * The request's query parameters
-     *
-     * @var array
-     */
-    private array $queryParams;
-
-    /**
-     * The request's cookie parameters
-     *
-     * @var array
-     */
-    private array $cookieParams;
-
-    /**
-     * The request's uploaded files
-     *
-     * @var array
-     */
-    private array $uploadedFiles;
-
-    /**
-     * The request's parsed body
-     *
-     * @var array|object|null
-     */
-    private $parsedBody;
-
-    /**
-     * The request attributes
-     *
-     * @var array
-     */
-    private array $attributes;
-
-    /**
-     * Constructor of the class
-     *
-     * @param string|null $protocolVersion
-     * @param string|null $method
-     * @param mixed $uri
-     * @param array<string, string|string[]>|null $headers
-     * @param StreamInterface|null $body
-     *
-     * @param array $serverParams
-     * @param array $queryParams
-     * @param array $cookieParams
-     * @param array $uploadedFiles
-     * @param array|object|null $parsedBody
-     * @param array $attributes
-     *
-     * @throws InvalidArgumentException
-     *         If one of the arguments isn't valid.
-     */
-    public function __construct(
-        ?string $protocolVersion = null,
-        ?string $method = null,
-        $uri = null,
-        ?array $headers = null,
-        ?StreamInterface $body = null,
-        array $serverParams = [],
-        array $queryParams = [],
-        array $cookieParams = [],
-        array $uploadedFiles = [],
-        $parsedBody = null,
-        array $attributes = []
-    ) {
-        if (isset($protocolVersion)) {
-            $this->setProtocolVersion($protocolVersion);
-        }
-
-        parent::__construct($method, $uri, $headers, $body);
-
-        $this->serverParams = $serverParams;
-        $this->queryParams = $queryParams;
-        $this->cookieParams = $cookieParams;
-        $this->setUploadedFiles($uploadedFiles);
-        $this->setParsedBody($parsedBody);
-        $this->attributes = $attributes;
-    }
-
-    /**
-     * Gets the server parameters
-     *
-     * @return array
-     */
-    public function getServerParams(): array
-    {
-        return $this->serverParams;
-    }
-
-    /**
-     * Gets the request's query parameters
-     *
-     * @return array
-     */
-    public function getQueryParams(): array
-    {
-        return $this->queryParams;
-    }
-
-    /**
-     * Creates a new instance of the request with the given query parameters
-     *
-     * @param array $query
-     *
-     * @return static
-     */
-    public function withQueryParams(array $query): ServerRequestInterface
-    {
-        $clone = clone $this;
-        $clone->queryParams = $query;
-
-        return $clone;
-    }
-
-    /**
-     * Gets the request's cookie parameters
-     *
-     * @return array
-     */
-    public function getCookieParams(): array
-    {
-        return $this->cookieParams;
-    }
-
-    /**
-     * Creates a new instance of the request with the given cookie parameters
-     *
-     * @param array $cookies
-     *
-     * @return static
-     */
-    public function withCookieParams(array $cookies): ServerRequestInterface
-    {
-        $clone = clone $this;
-        $clone->cookieParams = $cookies;
-
-        return $clone;
-    }
-
-    /**
-     * Gets the request's uploaded files
-     *
-     * @return array
-     */
-    public function getUploadedFiles(): array
-    {
-        return $this->uploadedFiles;
-    }
-
-    /**
-     * Creates a new instance of the request with the given uploaded files
-     *
-     * @param array $uploadedFiles
-     *
-     * @return static
-     *
-     * @throws InvalidArgumentException
-     *         If one of the files isn't valid.
-     */
-    public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface
-    {
-        $clone = clone $this;
-        $clone->setUploadedFiles($uploadedFiles);
-
-        return $clone;
-    }
-
-    /**
-     * Gets the request's parsed body
-     *
-     * @return array|object|null
-     */
-    public function getParsedBody()
-    {
-        return $this->parsedBody;
-    }
-
-    /**
-     * Creates a new instance of the request with the given parsed body
-     *
-     * @param array|object|null $data
-     *
-     * @return static
-     *
-     * @throws InvalidArgumentException
-     *         If the data isn't valid.
-     */
-    public function withParsedBody($data): ServerRequestInterface
-    {
-        $clone = clone $this;
-        $clone->setParsedBody($data);
-
-        return $clone;
-    }
-
-    /**
-     * Gets the request attributes
-     *
-     * @return array
-     */
-    public function getAttributes(): array
-    {
-        return $this->attributes;
-    }
-
-    /**
-     * Gets the request's attribute value by the given name
-     *
-     * Returns the default value if the attribute wasn't found.
-     *
-     * @param array-key $name
-     * @param mixed $default
-     *
-     * @return mixed
-     */
-    public function getAttribute($name, $default = null)
-    {
-        if (!array_key_exists($name, $this->attributes)) {
-            return $default;
-        }
-
-        return $this->attributes[$name];
-    }
-
-    /**
-     * Creates a new instance of the request with the given attribute
-     *
-     * @param array-key $name
-     * @param mixed $value
-     *
-     * @return static
-     */
-    public function withAttribute($name, $value): ServerRequestInterface
-    {
-        $clone = clone $this;
-        $clone->attributes[$name] = $value;
-
-        return $clone;
-    }
-
-    /**
-     * Creates a new instance of the request without an attribute with the given name
-     *
-     * @param array-key $name
-     *
-     * @return static
-     */
-    public function withoutAttribute($name): ServerRequestInterface
-    {
-        $clone = clone $this;
-        unset($clone->attributes[$name]);
-
-        return $clone;
-    }
-
-    /**
-     * Sets the given uploaded files to the request
-     *
-     * @param array $files
-     *
-     * @return void
-     *
-     * @throws InvalidArgumentException
-     *         If one of the files isn't valid.
-     */
-    final protected function setUploadedFiles(array $files): void
-    {
-        $this->validateUploadedFiles($files);
-
-        $this->uploadedFiles = $files;
-    }
-
-    /**
-     * Sets the given parsed body to the request
-     *
-     * @param array|object|null $data
-     *
-     * @return void
-     *
-     * @throws InvalidArgumentException
-     *         If the parsed body isn't valid.
-     */
-    final protected function setParsedBody($data): void
-    {
-        $this->validateParsedBody($data);
-
-        $this->parsedBody = $data;
-    }
-
-    /**
-     * Validates the given uploaded files
-     *
-     * @param array $files
-     *
-     * @return void
-     *
-     * @throws InvalidArgumentException
-     *         If one of the files isn't valid.
-     */
-    private function validateUploadedFiles(array $files): void
-    {
-        if ([] === $files) {
-            return;
-        }
-
-        /**
-         * @param mixed $file
-         *
-         * @return void
-         *
-         * @throws InvalidArgumentException
-         *
-         * @psalm-suppress MissingClosureParamType
-         */
-        array_walk_recursive($files, static function ($file): void {
-            if (! ($file instanceof UploadedFileInterface)) {
-                throw new InvalidArgumentException('Invalid uploaded files');
-            }
-        });
-    }
-
-    /**
-     * Validates the given parsed body
-     *
-     * @param mixed $data
-     *
-     * @return void
-     *
-     * @throws InvalidArgumentException
-     *         If the parsed body isn't valid.
-     */
-    private function validateParsedBody($data): void
-    {
-        if (null === $data) {
-            return;
-        }
-
-        if (!is_array($data) && !is_object($data)) {
-            throw new InvalidArgumentException('Invalid parsed body');
-        }
-    }
+	/**
+	 * The server parameters
+	 *
+	 * @var array
+	 */
+	private array $serverParams;
+
+	/**
+	 * The request's query parameters
+	 *
+	 * @var array
+	 */
+	private array $queryParams;
+
+	/**
+	 * The request's cookie parameters
+	 *
+	 * @var array
+	 */
+	private array $cookieParams;
+
+	/**
+	 * The request's uploaded files
+	 *
+	 * @var array
+	 */
+	private array $uploadedFiles;
+
+	/**
+	 * The request's parsed body
+	 *
+	 * @var array|object|null
+	 */
+	private $parsedBody;
+
+	/**
+	 * The request attributes
+	 *
+	 * @var array
+	 */
+	private array $attributes;
+
+	/**
+	 * Constructor of the class
+	 *
+	 * @param string|null $protocolVersion
+	 * @param string|null $method
+	 * @param mixed $uri
+	 * @param array<string, string|string[]>|null $headers
+	 * @param StreamInterface|null $body
+	 *
+	 * @param array $serverParams
+	 * @param array $queryParams
+	 * @param array $cookieParams
+	 * @param array $uploadedFiles
+	 * @param array|object|null $parsedBody
+	 * @param array $attributes
+	 *
+	 * @throws InvalidArgumentException
+	 *         If one of the arguments isn't valid.
+	 */
+	public function __construct(
+		?string $protocolVersion = null,
+		?string $method = null,
+		$uri = null,
+		?array $headers = null,
+		?StreamInterface $body = null,
+		array $serverParams = [],
+		array $queryParams = [],
+		array $cookieParams = [],
+		array $uploadedFiles = [],
+		$parsedBody = null,
+		array $attributes = []
+	) {
+		if (isset($protocolVersion)) {
+			$this->setProtocolVersion($protocolVersion);
+		}
+
+		parent::__construct($method, $uri, $headers, $body);
+
+		$this->serverParams = $serverParams;
+		$this->queryParams = $queryParams;
+		$this->cookieParams = $cookieParams;
+		$this->setUploadedFiles($uploadedFiles);
+		$this->setParsedBody($parsedBody);
+		$this->attributes = $attributes;
+	}
+
+	/**
+	 * Gets the server parameters
+	 *
+	 * @return array
+	 */
+	public function getServerParams(): array
+	{
+		return $this->serverParams;
+	}
+
+	/**
+	 * Gets the request's query parameters
+	 *
+	 * @return array
+	 */
+	public function getQueryParams(): array
+	{
+		return $this->queryParams;
+	}
+
+	/**
+	 * Creates a new instance of the request with the given query parameters
+	 *
+	 * @param array $query
+	 *
+	 * @return static
+	 */
+	public function withQueryParams(array $query): ServerRequestInterface
+	{
+		$clone = clone $this;
+		$clone->queryParams = $query;
+
+		return $clone;
+	}
+
+	/**
+	 * Gets the request's cookie parameters
+	 *
+	 * @return array
+	 */
+	public function getCookieParams(): array
+	{
+		return $this->cookieParams;
+	}
+
+	/**
+	 * Creates a new instance of the request with the given cookie parameters
+	 *
+	 * @param array $cookies
+	 *
+	 * @return static
+	 */
+	public function withCookieParams(array $cookies): ServerRequestInterface
+	{
+		$clone = clone $this;
+		$clone->cookieParams = $cookies;
+
+		return $clone;
+	}
+
+	/**
+	 * Gets the request's uploaded files
+	 *
+	 * @return array
+	 */
+	public function getUploadedFiles(): array
+	{
+		return $this->uploadedFiles;
+	}
+
+	/**
+	 * Creates a new instance of the request with the given uploaded files
+	 *
+	 * @param array $uploadedFiles
+	 *
+	 * @return static
+	 *
+	 * @throws InvalidArgumentException
+	 *         If one of the files isn't valid.
+	 */
+	public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface
+	{
+		$clone = clone $this;
+		$clone->setUploadedFiles($uploadedFiles);
+
+		return $clone;
+	}
+
+	/**
+	 * Gets the request's parsed body
+	 *
+	 * @return array|object|null
+	 */
+	public function getParsedBody()
+	{
+		return $this->parsedBody;
+	}
+
+	/**
+	 * Creates a new instance of the request with the given parsed body
+	 *
+	 * @param array|object|null $data
+	 *
+	 * @return static
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the data isn't valid.
+	 */
+	public function withParsedBody($data): ServerRequestInterface
+	{
+		$clone = clone $this;
+		$clone->setParsedBody($data);
+
+		return $clone;
+	}
+
+	/**
+	 * Gets the request attributes
+	 *
+	 * @return array
+	 */
+	public function getAttributes(): array
+	{
+		return $this->attributes;
+	}
+
+	/**
+	 * Gets the request's attribute value by the given name
+	 *
+	 * Returns the default value if the attribute wasn't found.
+	 *
+	 * @param array-key $name
+	 * @param mixed $default
+	 *
+	 * @return mixed
+	 */
+	public function getAttribute($name, $default = null)
+	{
+		if (!array_key_exists($name, $this->attributes)) {
+			return $default;
+		}
+
+		return $this->attributes[$name];
+	}
+
+	/**
+	 * Creates a new instance of the request with the given attribute
+	 *
+	 * @param array-key $name
+	 * @param mixed $value
+	 *
+	 * @return static
+	 */
+	public function withAttribute($name, $value): ServerRequestInterface
+	{
+		$clone = clone $this;
+		$clone->attributes[$name] = $value;
+
+		return $clone;
+	}
+
+	/**
+	 * Creates a new instance of the request without an attribute with the given name
+	 *
+	 * @param array-key $name
+	 *
+	 * @return static
+	 */
+	public function withoutAttribute($name): ServerRequestInterface
+	{
+		$clone = clone $this;
+		unset($clone->attributes[$name]);
+
+		return $clone;
+	}
+
+	/**
+	 * Sets the given uploaded files to the request
+	 *
+	 * @param array $files
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidArgumentException
+	 *         If one of the files isn't valid.
+	 */
+	final protected function setUploadedFiles(array $files): void
+	{
+		$this->validateUploadedFiles($files);
+
+		$this->uploadedFiles = $files;
+	}
+
+	/**
+	 * Sets the given parsed body to the request
+	 *
+	 * @param array|object|null $data
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the parsed body isn't valid.
+	 */
+	final protected function setParsedBody($data): void
+	{
+		$this->validateParsedBody($data);
+
+		$this->parsedBody = $data;
+	}
+
+	/**
+	 * Validates the given uploaded files
+	 *
+	 * @param array $files
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidArgumentException
+	 *         If one of the files isn't valid.
+	 */
+	private function validateUploadedFiles(array $files): void
+	{
+		if ([] === $files) {
+			return;
+		}
+
+		/**
+		 * @param mixed $file
+		 *
+		 * @return void
+		 *
+		 * @throws InvalidArgumentException
+		 *
+		 * @psalm-suppress MissingClosureParamType
+		 */
+		array_walk_recursive($files, static function ($file): void {
+			if (! ($file instanceof UploadedFileInterface)) {
+				throw new InvalidArgumentException('Invalid uploaded files');
+			}
+		});
+	}
+
+	/**
+	 * Validates the given parsed body
+	 *
+	 * @param mixed $data
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the parsed body isn't valid.
+	 */
+	private function validateParsedBody($data): void
+	{
+		if (null === $data) {
+			return;
+		}
+
+		if (!is_array($data) && !is_object($data)) {
+			throw new InvalidArgumentException('Invalid parsed body');
+		}
+	}
 }

src/Stream.php

Indentation +382 added lines, -382 removed lines

@@ -47,386 +47,386 @@
 class Stream implements StreamInterface
 {
 
-    /**
-     * The stream resource
-     *
-     * @var resource|null
-     */
-    private $resource;
-
-    /**
-     * Signals to close the stream on destruction
-     *
-     * @var bool
-     */
-    private $autoClose;
-
-    /**
-     * Constructor of the class
-     *
-     * @param mixed $resource
-     * @param bool $autoClose
-     *
-     * @throws InvalidArgumentException
-     *         If the stream cannot be initialized with the resource.
-     */
-    public function __construct($resource, bool $autoClose = true)
-    {
-        if (!is_resource($resource)) {
-            throw new InvalidArgumentException('Unexpected stream resource');
-        }
-
-        $this->resource = $resource;
-        $this->autoClose = $autoClose;
-    }
-
-    /**
-     * Creates a stream
-     *
-     * @param mixed $resource
-     *
-     * @return StreamInterface
-     *
-     * @throws InvalidArgumentException
-     *         If the stream cannot be initialized with the resource.
-     */
-    public static function create($resource): StreamInterface
-    {
-        if ($resource instanceof StreamInterface) {
-            return $resource;
-        }
-
-        return new self($resource);
-    }
-
-    /**
-     * Destructor of the class
-     */
-    public function __destruct()
-    {
-        if ($this->autoClose) {
-            $this->close();
-        }
-    }
-
-    /**
-     * Detaches a resource from the stream
-     *
-     * Returns NULL if the stream already without a resource.
-     *
-     * @return resource|null
-     */
-    public function detach()
-    {
-        $resource = $this->resource;
-        $this->resource = null;
-
-        return $resource;
-    }
-
-    /**
-     * Closes the stream
-     *
-     * @link http://php.net/manual/en/function.fclose.php
-     *
-     * @return void
-     */
-    public function close(): void
-    {
-        $resource = $this->detach();
-        if (!is_resource($resource)) {
-            return;
-        }
-
-        fclose($resource);
-    }
-
-    /**
-     * Checks if the end of the stream is reached
-     *
-     * @link http://php.net/manual/en/function.feof.php
-     *
-     * @return bool
-     */
-    public function eof(): bool
-    {
-        if (!is_resource($this->resource)) {
-            return true;
-        }
-
-        return feof($this->resource);
-    }
-
-    /**
-     * Gets the stream pointer position
-     *
-     * @link http://php.net/manual/en/function.ftell.php
-     *
-     * @return int
-     *
-     * @throws RuntimeException
-     */
-    public function tell(): int
-    {
-        if (!is_resource($this->resource)) {
-            throw new RuntimeException('The stream without a resource so the operation is not possible');
-        }
-
-        $result = ftell($this->resource);
-        if ($result === false) {
-            throw new RuntimeException('Unable to get the stream pointer position');
-        }
-
-        return $result;
-    }
-
-    /**
-     * Checks if the stream is seekable
-     *
-     * @return bool
-     */
-    public function isSeekable(): bool
-    {
-        if (!is_resource($this->resource)) {
-            return false;
-        }
-
-        /** @var array{seekable: bool} */
-        $metadata = stream_get_meta_data($this->resource);
-
-        return $metadata['seekable'];
-    }
-
-    /**
-     * Moves the stream pointer to the beginning
-     *
-     * @return void
-     *
-     * @throws RuntimeException
-     */
-    public function rewind(): void
-    {
-        $this->seek(0);
-    }
-
-    /**
-     * Moves the stream pointer to the given position
-     *
-     * @link http://php.net/manual/en/function.fseek.php
-     *
-     * @param int $offset
-     * @param int $whence
-     *
-     * @return void
-     *
-     * @throws RuntimeException
-     */
-    public function seek($offset, $whence = SEEK_SET): void
-    {
-        if (!is_resource($this->resource)) {
-            throw new RuntimeException('The stream without a resource so the operation is not possible');
-        }
-
-        if (!$this->isSeekable()) {
-            throw new RuntimeException('Stream is not seekable');
-        }
-
-        $result = fseek($this->resource, $offset, $whence);
-        if ($result !== 0) {
-            throw new RuntimeException('Unable to move the stream pointer position');
-        }
-    }
-
-    /**
-     * Checks if the stream is writable
-     *
-     * @return bool
-     */
-    public function isWritable(): bool
-    {
-        if (!is_resource($this->resource)) {
-            return false;
-        }
-
-        /** @var array{mode: string} */
-        $metadata = stream_get_meta_data($this->resource);
-
-        return strpbrk($metadata['mode'], '+acwx') !== false;
-    }
-
-    /**
-     * Writes the given string to the stream
-     *
-     * Returns the number of bytes written to the stream.
-     *
-     * @link http://php.net/manual/en/function.fwrite.php
-     *
-     * @param string $string
-     *
-     * @return int
-     *
-     * @throws RuntimeException
-     */
-    public function write($string): int
-    {
-        if (!is_resource($this->resource)) {
-            throw new RuntimeException('The stream without a resource so the operation is not possible');
-        }
-
-        if (!$this->isWritable()) {
-            throw new RuntimeException('Stream is not writable');
-        }
-
-        $result = fwrite($this->resource, $string);
-        if ($result === false) {
-            throw new RuntimeException('Unable to write to the stream');
-        }
-
-        return $result;
-    }
-
-    /**
-     * Checks if the stream is readable
-     *
-     * @return bool
-     */
-    public function isReadable(): bool
-    {
-        if (!is_resource($this->resource)) {
-            return false;
-        }
-
-        /** @var array{mode: string} */
-        $metadata = stream_get_meta_data($this->resource);
-
-        return strpbrk($metadata['mode'], '+r') !== false;
-    }
-
-    /**
-     * Reads the given number of bytes from the stream
-     *
-     * @link http://php.net/manual/en/function.fread.php
-     *
-     * @param int $length
-     *
-     * @return string
-     *
-     * @throws RuntimeException
-     */
-    public function read($length): string
-    {
-        if (!is_resource($this->resource)) {
-            throw new RuntimeException('The stream without a resource so the operation is not possible');
-        }
-
-        if (!$this->isReadable()) {
-            throw new RuntimeException('Stream is not readable');
-        }
-
-        $result = fread($this->resource, $length);
-        if ($result === false) {
-            throw new RuntimeException('Unable to read from the stream');
-        }
-
-        return $result;
-    }
-
-    /**
-     * Reads the remainder of the stream
-     *
-     * @link http://php.net/manual/en/function.stream-get-contents.php
-     *
-     * @return string
-     *
-     * @throws RuntimeException
-     */
-    public function getContents(): string
-    {
-        if (!is_resource($this->resource)) {
-            throw new RuntimeException('The stream without a resource so the operation is not possible');
-        }
-
-        if (!$this->isReadable()) {
-            throw new RuntimeException('Stream is not readable');
-        }
-
-        $result = stream_get_contents($this->resource);
-        if ($result === false) {
-            throw new RuntimeException('Unable to read the remainder of the stream');
-        }
-
-        return $result;
-    }
-
-    /**
-     * Gets the stream metadata
-     *
-     * @link http://php.net/manual/en/function.stream-get-meta-data.php
-     *
-     * @param string|null $key
-     *
-     * @return mixed
-     */
-    public function getMetadata($key = null)
-    {
-        if (!is_resource($this->resource)) {
-            return null;
-        }
-
-        $metadata = stream_get_meta_data($this->resource);
-        if ($key === null) {
-            return $metadata;
-        }
-
-        return $metadata[$key] ?? null;
-    }
-
-    /**
-     * Gets the stream size
-     *
-     * Returns NULL if the stream without a resource,
-     * or if the stream size cannot be determined.
-     *
-     * @link http://php.net/manual/en/function.fstat.php
-     *
-     * @return int|null
-     */
-    public function getSize(): ?int
-    {
-        if (!is_resource($this->resource)) {
-            return null;
-        }
-
-        /** @var array{size: int}|false */
-        $stats = fstat($this->resource);
-        if ($stats === false) {
-            return null;
-        }
-
-        return $stats['size'];
-    }
-
-    /**
-     * Converts the stream to a string
-     *
-     * @link http://php.net/manual/en/language.oop5.magic.php#object.tostring
-     *
-     * @return string
-     */
-    public function __toString(): string
-    {
-        if (!$this->isReadable()) {
-            return '';
-        }
-
-        try {
-            if ($this->isSeekable()) {
-                $this->rewind();
-            }
-
-            return $this->getContents();
-        } catch (Throwable $e) {
-            return '';
-        }
-    }
+	/**
+	 * The stream resource
+	 *
+	 * @var resource|null
+	 */
+	private $resource;
+
+	/**
+	 * Signals to close the stream on destruction
+	 *
+	 * @var bool
+	 */
+	private $autoClose;
+
+	/**
+	 * Constructor of the class
+	 *
+	 * @param mixed $resource
+	 * @param bool $autoClose
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the stream cannot be initialized with the resource.
+	 */
+	public function __construct($resource, bool $autoClose = true)
+	{
+		if (!is_resource($resource)) {
+			throw new InvalidArgumentException('Unexpected stream resource');
+		}
+
+		$this->resource = $resource;
+		$this->autoClose = $autoClose;
+	}
+
+	/**
+	 * Creates a stream
+	 *
+	 * @param mixed $resource
+	 *
+	 * @return StreamInterface
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the stream cannot be initialized with the resource.
+	 */
+	public static function create($resource): StreamInterface
+	{
+		if ($resource instanceof StreamInterface) {
+			return $resource;
+		}
+
+		return new self($resource);
+	}
+
+	/**
+	 * Destructor of the class
+	 */
+	public function __destruct()
+	{
+		if ($this->autoClose) {
+			$this->close();
+		}
+	}
+
+	/**
+	 * Detaches a resource from the stream
+	 *
+	 * Returns NULL if the stream already without a resource.
+	 *
+	 * @return resource|null
+	 */
+	public function detach()
+	{
+		$resource = $this->resource;
+		$this->resource = null;
+
+		return $resource;
+	}
+
+	/**
+	 * Closes the stream
+	 *
+	 * @link http://php.net/manual/en/function.fclose.php
+	 *
+	 * @return void
+	 */
+	public function close(): void
+	{
+		$resource = $this->detach();
+		if (!is_resource($resource)) {
+			return;
+		}
+
+		fclose($resource);
+	}
+
+	/**
+	 * Checks if the end of the stream is reached
+	 *
+	 * @link http://php.net/manual/en/function.feof.php
+	 *
+	 * @return bool
+	 */
+	public function eof(): bool
+	{
+		if (!is_resource($this->resource)) {
+			return true;
+		}
+
+		return feof($this->resource);
+	}
+
+	/**
+	 * Gets the stream pointer position
+	 *
+	 * @link http://php.net/manual/en/function.ftell.php
+	 *
+	 * @return int
+	 *
+	 * @throws RuntimeException
+	 */
+	public function tell(): int
+	{
+		if (!is_resource($this->resource)) {
+			throw new RuntimeException('The stream without a resource so the operation is not possible');
+		}
+
+		$result = ftell($this->resource);
+		if ($result === false) {
+			throw new RuntimeException('Unable to get the stream pointer position');
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Checks if the stream is seekable
+	 *
+	 * @return bool
+	 */
+	public function isSeekable(): bool
+	{
+		if (!is_resource($this->resource)) {
+			return false;
+		}
+
+		/** @var array{seekable: bool} */
+		$metadata = stream_get_meta_data($this->resource);
+
+		return $metadata['seekable'];
+	}
+
+	/**
+	 * Moves the stream pointer to the beginning
+	 *
+	 * @return void
+	 *
+	 * @throws RuntimeException
+	 */
+	public function rewind(): void
+	{
+		$this->seek(0);
+	}
+
+	/**
+	 * Moves the stream pointer to the given position
+	 *
+	 * @link http://php.net/manual/en/function.fseek.php
+	 *
+	 * @param int $offset
+	 * @param int $whence
+	 *
+	 * @return void
+	 *
+	 * @throws RuntimeException
+	 */
+	public function seek($offset, $whence = SEEK_SET): void
+	{
+		if (!is_resource($this->resource)) {
+			throw new RuntimeException('The stream without a resource so the operation is not possible');
+		}
+
+		if (!$this->isSeekable()) {
+			throw new RuntimeException('Stream is not seekable');
+		}
+
+		$result = fseek($this->resource, $offset, $whence);
+		if ($result !== 0) {
+			throw new RuntimeException('Unable to move the stream pointer position');
+		}
+	}
+
+	/**
+	 * Checks if the stream is writable
+	 *
+	 * @return bool
+	 */
+	public function isWritable(): bool
+	{
+		if (!is_resource($this->resource)) {
+			return false;
+		}
+
+		/** @var array{mode: string} */
+		$metadata = stream_get_meta_data($this->resource);
+
+		return strpbrk($metadata['mode'], '+acwx') !== false;
+	}
+
+	/**
+	 * Writes the given string to the stream
+	 *
+	 * Returns the number of bytes written to the stream.
+	 *
+	 * @link http://php.net/manual/en/function.fwrite.php
+	 *
+	 * @param string $string
+	 *
+	 * @return int
+	 *
+	 * @throws RuntimeException
+	 */
+	public function write($string): int
+	{
+		if (!is_resource($this->resource)) {
+			throw new RuntimeException('The stream without a resource so the operation is not possible');
+		}
+
+		if (!$this->isWritable()) {
+			throw new RuntimeException('Stream is not writable');
+		}
+
+		$result = fwrite($this->resource, $string);
+		if ($result === false) {
+			throw new RuntimeException('Unable to write to the stream');
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Checks if the stream is readable
+	 *
+	 * @return bool
+	 */
+	public function isReadable(): bool
+	{
+		if (!is_resource($this->resource)) {
+			return false;
+		}
+
+		/** @var array{mode: string} */
+		$metadata = stream_get_meta_data($this->resource);
+
+		return strpbrk($metadata['mode'], '+r') !== false;
+	}
+
+	/**
+	 * Reads the given number of bytes from the stream
+	 *
+	 * @link http://php.net/manual/en/function.fread.php
+	 *
+	 * @param int $length
+	 *
+	 * @return string
+	 *
+	 * @throws RuntimeException
+	 */
+	public function read($length): string
+	{
+		if (!is_resource($this->resource)) {
+			throw new RuntimeException('The stream without a resource so the operation is not possible');
+		}
+
+		if (!$this->isReadable()) {
+			throw new RuntimeException('Stream is not readable');
+		}
+
+		$result = fread($this->resource, $length);
+		if ($result === false) {
+			throw new RuntimeException('Unable to read from the stream');
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Reads the remainder of the stream
+	 *
+	 * @link http://php.net/manual/en/function.stream-get-contents.php
+	 *
+	 * @return string
+	 *
+	 * @throws RuntimeException
+	 */
+	public function getContents(): string
+	{
+		if (!is_resource($this->resource)) {
+			throw new RuntimeException('The stream without a resource so the operation is not possible');
+		}
+
+		if (!$this->isReadable()) {
+			throw new RuntimeException('Stream is not readable');
+		}
+
+		$result = stream_get_contents($this->resource);
+		if ($result === false) {
+			throw new RuntimeException('Unable to read the remainder of the stream');
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Gets the stream metadata
+	 *
+	 * @link http://php.net/manual/en/function.stream-get-meta-data.php
+	 *
+	 * @param string|null $key
+	 *
+	 * @return mixed
+	 */
+	public function getMetadata($key = null)
+	{
+		if (!is_resource($this->resource)) {
+			return null;
+		}
+
+		$metadata = stream_get_meta_data($this->resource);
+		if ($key === null) {
+			return $metadata;
+		}
+
+		return $metadata[$key] ?? null;
+	}
+
+	/**
+	 * Gets the stream size
+	 *
+	 * Returns NULL if the stream without a resource,
+	 * or if the stream size cannot be determined.
+	 *
+	 * @link http://php.net/manual/en/function.fstat.php
+	 *
+	 * @return int|null
+	 */
+	public function getSize(): ?int
+	{
+		if (!is_resource($this->resource)) {
+			return null;
+		}
+
+		/** @var array{size: int}|false */
+		$stats = fstat($this->resource);
+		if ($stats === false) {
+			return null;
+		}
+
+		return $stats['size'];
+	}
+
+	/**
+	 * Converts the stream to a string
+	 *
+	 * @link http://php.net/manual/en/language.oop5.magic.php#object.tostring
+	 *
+	 * @return string
+	 */
+	public function __toString(): string
+	{
+		if (!$this->isReadable()) {
+			return '';
+		}
+
+		try {
+			if ($this->isSeekable()) {
+				$this->rewind();
+			}
+
+			return $this->getContents();
+		} catch (Throwable $e) {
+			return '';
+		}
+	}
 }

src/Uri.php

Indentation +474 added lines, -474 removed lines

@@ -43,478 +43,478 @@
 class Uri implements UriInterface
 {
 
-    /**
-     * Scheme of the URI
-     *
-     * @var string
-     */
-    private string $scheme = '';
-
-    /**
-     * User Information of the URI
-     *
-     * @var string
-     */
-    private string $userInfo = '';
-
-    /**
-     * Host of the URI
-     *
-     * @var string
-     */
-    private string $host = '';
-
-    /**
-     * Port of the URI
-     *
-     * @var int|null
-     */
-    private ?int $port = null;
-
-    /**
-     * Path of the URI
-     *
-     * @var string
-     */
-    private string $path = '';
-
-    /**
-     * Query of the URI
-     *
-     * @var string
-     */
-    private string $query = '';
-
-    /**
-     * Fragment of the URI
-     *
-     * @var string
-     */
-    private string $fragment = '';
-
-    /**
-     * Constructor of the class
-     *
-     * @param string $uri
-     *
-     * @throws InvalidUriException
-     *         If the URI isn't valid.
-     */
-    public function __construct(string $uri = '')
-    {
-        if ($uri === '') {
-            return;
-        }
-
-        $components = parse_url($uri);
-        if ($components === false) {
-            throw new InvalidUriException('Unable to parse URI');
-        }
-
-        if (isset($components['scheme'])) {
-            $this->setScheme($components['scheme']);
-        }
-
-        if (isset($components['user'])) {
-            $this->setUserInfo(
-                $components['user'],
-                $components['pass'] ?? null
-            );
-        }
-
-        if (isset($components['host'])) {
-            $this->setHost($components['host']);
-        }
-
-        if (isset($components['port'])) {
-            $this->setPort($components['port']);
-        }
-
-        if (isset($components['path'])) {
-            $this->setPath($components['path']);
-        }
-
-        if (isset($components['query'])) {
-            $this->setQuery($components['query']);
-        }
-
-        if (isset($components['fragment'])) {
-            $this->setFragment($components['fragment']);
-        }
-    }
-
-    /**
-     * Creates a URI
-     *
-     * @param mixed $uri
-     *
-     * @return UriInterface
-     *
-     * @throws InvalidArgumentException
-     *         If the URI isn't valid.
-     */
-    public static function create($uri): UriInterface
-    {
-        if ($uri instanceof UriInterface) {
-            return $uri;
-        }
-
-        if (!is_string($uri)) {
-            throw new InvalidArgumentException('URI should be a string');
-        }
-
-        return new self($uri);
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the scheme isn't valid.
-     */
-    public function withScheme($scheme): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setScheme($scheme);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the user information isn't valid.
-     */
-    public function withUserInfo($user, $password = null): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setUserInfo($user, $password);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the host isn't valid.
-     */
-    public function withHost($host): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setHost($host);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the port isn't valid.
-     */
-    public function withPort($port): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setPort($port);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the path isn't valid.
-     */
-    public function withPath($path): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setPath($path);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the query isn't valid.
-     */
-    public function withQuery($query): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setQuery($query);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     *
-     * @throws InvalidUriComponentException
-     *         If the fragment isn't valid.
-     */
-    public function withFragment($fragment): UriInterface
-    {
-        $clone = clone $this;
-        $clone->setFragment($fragment);
-
-        return $clone;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getScheme(): string
-    {
-        return $this->scheme;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getUserInfo(): string
-    {
-        return $this->userInfo;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getHost(): string
-    {
-        return $this->host;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPort(): ?int
-    {
-        // The 80 is the default port number for the HTTP protocol.
-        if ($this->port === 80 && $this->scheme === 'http') {
-            return null;
-        }
-
-        // The 443 is the default port number for the HTTPS protocol.
-        if ($this->port === 443 && $this->scheme === 'https') {
-            return null;
-        }
-
-        return $this->port;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPath(): string
-    {
-        // CVE-2015-3257
-        if (strncmp($this->path, '//', 2) === 0) {
-            return '/' . ltrim($this->path, '/');
-        }
-
-        return $this->path;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getQuery(): string
-    {
-        return $this->query;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getFragment(): string
-    {
-        return $this->fragment;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getAuthority(): string
-    {
-        // The host is the basic subcomponent.
-        if ($this->host === '') {
-            return '';
-        }
-
-        $authority = $this->host;
-        if ($this->userInfo !== '') {
-            $authority = $this->userInfo . '@' . $authority;
-        }
-
-        $port = $this->getPort();
-        if ($port !== null) {
-            $authority = $authority . ':' . $port;
-        }
-
-        return $authority;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function __toString(): string
-    {
-        $uri = '';
-
-        $scheme = $this->scheme;
-        if ($scheme !== '') {
-            $uri .= $scheme . ':';
-        }
-
-        $authority = $this->getAuthority();
-        if ($authority !== '') {
-            $uri .= '//' . $authority;
-        }
-
-        $path = $this->path;
-        if ($path !== '') {
-            // https://github.com/sunrise-php/uri/issues/31
-            // https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
-            //
-            // If a URI contains an authority component,
-            // then the path component must either be empty
-            // or begin with a slash ("/") character.
-            if ($authority !== '' && strncmp($path, '/', 1) !== 0) {
-                $path = '/' . $path;
-            }
-
-            // https://github.com/sunrise-php/uri/issues/31
-            // https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
-            //
-            // If a URI does not contain an authority component,
-            // then the path cannot begin with two slash characters ("//").
-            if ($authority === '' && strncmp($path, '//', 2) === 0) {
-                $path = '/' . ltrim($path, '/');
-            }
-
-            $uri .= $path;
-        }
-
-        $query = $this->query;
-        if ($query !== '') {
-            $uri .= '?' . $query;
-        }
-
-        $fragment = $this->fragment;
-        if ($fragment !== '') {
-            $uri .= '#' . $fragment;
-        }
-
-        return $uri;
-    }
-
-    /**
-     * Sets the given scheme to the URI
-     *
-     * @param mixed $scheme
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the scheme isn't valid.
-     */
-    final protected function setScheme($scheme): void
-    {
-        $this->scheme = (new Scheme($scheme))->getValue();
-    }
-
-    /**
-     * Sets the given user information to the URI
-     *
-     * @param mixed $user
-     * @param mixed $password
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the user information isn't valid.
-     */
-    final protected function setUserInfo($user, $password): void
-    {
-        $this->userInfo = (new UserInfo($user, $password))->getValue();
-    }
-
-    /**
-     * Sets the given host to the URI
-     *
-     * @param mixed $host
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the host isn't valid.
-     */
-    final protected function setHost($host): void
-    {
-        $this->host = (new Host($host))->getValue();
-    }
-
-    /**
-     * Sets the given port to the URI
-     *
-     * @param mixed $port
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the port isn't valid.
-     */
-    final protected function setPort($port): void
-    {
-        $this->port = (new Port($port))->getValue();
-    }
-
-    /**
-     * Sets the given path to the URI
-     *
-     * @param mixed $path
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the path isn't valid.
-     */
-    final protected function setPath($path): void
-    {
-        $this->path = (new Path($path))->getValue();
-    }
-
-    /**
-     * Sets the given query to the URI
-     *
-     * @param mixed $query
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the query isn't valid.
-     */
-    final protected function setQuery($query): void
-    {
-        $this->query = (new Query($query))->getValue();
-    }
-
-    /**
-     * Sets the given fragment to the URI
-     *
-     * @param mixed $fragment
-     *
-     * @return void
-     *
-     * @throws InvalidUriComponentException
-     *         If the fragment isn't valid.
-     */
-    final protected function setFragment($fragment): void
-    {
-        $this->fragment = (new Fragment($fragment))->getValue();
-    }
+	/**
+	 * Scheme of the URI
+	 *
+	 * @var string
+	 */
+	private string $scheme = '';
+
+	/**
+	 * User Information of the URI
+	 *
+	 * @var string
+	 */
+	private string $userInfo = '';
+
+	/**
+	 * Host of the URI
+	 *
+	 * @var string
+	 */
+	private string $host = '';
+
+	/**
+	 * Port of the URI
+	 *
+	 * @var int|null
+	 */
+	private ?int $port = null;
+
+	/**
+	 * Path of the URI
+	 *
+	 * @var string
+	 */
+	private string $path = '';
+
+	/**
+	 * Query of the URI
+	 *
+	 * @var string
+	 */
+	private string $query = '';
+
+	/**
+	 * Fragment of the URI
+	 *
+	 * @var string
+	 */
+	private string $fragment = '';
+
+	/**
+	 * Constructor of the class
+	 *
+	 * @param string $uri
+	 *
+	 * @throws InvalidUriException
+	 *         If the URI isn't valid.
+	 */
+	public function __construct(string $uri = '')
+	{
+		if ($uri === '') {
+			return;
+		}
+
+		$components = parse_url($uri);
+		if ($components === false) {
+			throw new InvalidUriException('Unable to parse URI');
+		}
+
+		if (isset($components['scheme'])) {
+			$this->setScheme($components['scheme']);
+		}
+
+		if (isset($components['user'])) {
+			$this->setUserInfo(
+				$components['user'],
+				$components['pass'] ?? null
+			);
+		}
+
+		if (isset($components['host'])) {
+			$this->setHost($components['host']);
+		}
+
+		if (isset($components['port'])) {
+			$this->setPort($components['port']);
+		}
+
+		if (isset($components['path'])) {
+			$this->setPath($components['path']);
+		}
+
+		if (isset($components['query'])) {
+			$this->setQuery($components['query']);
+		}
+
+		if (isset($components['fragment'])) {
+			$this->setFragment($components['fragment']);
+		}
+	}
+
+	/**
+	 * Creates a URI
+	 *
+	 * @param mixed $uri
+	 *
+	 * @return UriInterface
+	 *
+	 * @throws InvalidArgumentException
+	 *         If the URI isn't valid.
+	 */
+	public static function create($uri): UriInterface
+	{
+		if ($uri instanceof UriInterface) {
+			return $uri;
+		}
+
+		if (!is_string($uri)) {
+			throw new InvalidArgumentException('URI should be a string');
+		}
+
+		return new self($uri);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the scheme isn't valid.
+	 */
+	public function withScheme($scheme): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setScheme($scheme);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the user information isn't valid.
+	 */
+	public function withUserInfo($user, $password = null): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setUserInfo($user, $password);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the host isn't valid.
+	 */
+	public function withHost($host): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setHost($host);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the port isn't valid.
+	 */
+	public function withPort($port): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setPort($port);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the path isn't valid.
+	 */
+	public function withPath($path): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setPath($path);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the query isn't valid.
+	 */
+	public function withQuery($query): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setQuery($query);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the fragment isn't valid.
+	 */
+	public function withFragment($fragment): UriInterface
+	{
+		$clone = clone $this;
+		$clone->setFragment($fragment);
+
+		return $clone;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getScheme(): string
+	{
+		return $this->scheme;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getUserInfo(): string
+	{
+		return $this->userInfo;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getHost(): string
+	{
+		return $this->host;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPort(): ?int
+	{
+		// The 80 is the default port number for the HTTP protocol.
+		if ($this->port === 80 && $this->scheme === 'http') {
+			return null;
+		}
+
+		// The 443 is the default port number for the HTTPS protocol.
+		if ($this->port === 443 && $this->scheme === 'https') {
+			return null;
+		}
+
+		return $this->port;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPath(): string
+	{
+		// CVE-2015-3257
+		if (strncmp($this->path, '//', 2) === 0) {
+			return '/' . ltrim($this->path, '/');
+		}
+
+		return $this->path;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getQuery(): string
+	{
+		return $this->query;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getFragment(): string
+	{
+		return $this->fragment;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getAuthority(): string
+	{
+		// The host is the basic subcomponent.
+		if ($this->host === '') {
+			return '';
+		}
+
+		$authority = $this->host;
+		if ($this->userInfo !== '') {
+			$authority = $this->userInfo . '@' . $authority;
+		}
+
+		$port = $this->getPort();
+		if ($port !== null) {
+			$authority = $authority . ':' . $port;
+		}
+
+		return $authority;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function __toString(): string
+	{
+		$uri = '';
+
+		$scheme = $this->scheme;
+		if ($scheme !== '') {
+			$uri .= $scheme . ':';
+		}
+
+		$authority = $this->getAuthority();
+		if ($authority !== '') {
+			$uri .= '//' . $authority;
+		}
+
+		$path = $this->path;
+		if ($path !== '') {
+			// https://github.com/sunrise-php/uri/issues/31
+			// https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+			//
+			// If a URI contains an authority component,
+			// then the path component must either be empty
+			// or begin with a slash ("/") character.
+			if ($authority !== '' && strncmp($path, '/', 1) !== 0) {
+				$path = '/' . $path;
+			}
+
+			// https://github.com/sunrise-php/uri/issues/31
+			// https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+			//
+			// If a URI does not contain an authority component,
+			// then the path cannot begin with two slash characters ("//").
+			if ($authority === '' && strncmp($path, '//', 2) === 0) {
+				$path = '/' . ltrim($path, '/');
+			}
+
+			$uri .= $path;
+		}
+
+		$query = $this->query;
+		if ($query !== '') {
+			$uri .= '?' . $query;
+		}
+
+		$fragment = $this->fragment;
+		if ($fragment !== '') {
+			$uri .= '#' . $fragment;
+		}
+
+		return $uri;
+	}
+
+	/**
+	 * Sets the given scheme to the URI
+	 *
+	 * @param mixed $scheme
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the scheme isn't valid.
+	 */
+	final protected function setScheme($scheme): void
+	{
+		$this->scheme = (new Scheme($scheme))->getValue();
+	}
+
+	/**
+	 * Sets the given user information to the URI
+	 *
+	 * @param mixed $user
+	 * @param mixed $password
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the user information isn't valid.
+	 */
+	final protected function setUserInfo($user, $password): void
+	{
+		$this->userInfo = (new UserInfo($user, $password))->getValue();
+	}
+
+	/**
+	 * Sets the given host to the URI
+	 *
+	 * @param mixed $host
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the host isn't valid.
+	 */
+	final protected function setHost($host): void
+	{
+		$this->host = (new Host($host))->getValue();
+	}
+
+	/**
+	 * Sets the given port to the URI
+	 *
+	 * @param mixed $port
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the port isn't valid.
+	 */
+	final protected function setPort($port): void
+	{
+		$this->port = (new Port($port))->getValue();
+	}
+
+	/**
+	 * Sets the given path to the URI
+	 *
+	 * @param mixed $path
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the path isn't valid.
+	 */
+	final protected function setPath($path): void
+	{
+		$this->path = (new Path($path))->getValue();
+	}
+
+	/**
+	 * Sets the given query to the URI
+	 *
+	 * @param mixed $query
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the query isn't valid.
+	 */
+	final protected function setQuery($query): void
+	{
+		$this->query = (new Query($query))->getValue();
+	}
+
+	/**
+	 * Sets the given fragment to the URI
+	 *
+	 * @param mixed $fragment
+	 *
+	 * @return void
+	 *
+	 * @throws InvalidUriComponentException
+	 *         If the fragment isn't valid.
+	 */
+	final protected function setFragment($fragment): void
+	{
+		$this->fragment = (new Fragment($fragment))->getValue();
+	}
 }

src/Uri/Component/UserInfo.php

Indentation +38 added lines, -38 removed lines

@@ -19,48 +19,48 @@
 final class UserInfo implements ComponentInterface
 {
 
-    /**
-     * URI component "user"
-     *
-     * @var User
-     */
-    private User $user;
+	/**
+	 * URI component "user"
+	 *
+	 * @var User
+	 */
+	private User $user;
 
-    /**
-     * URI component "password"
-     *
-     * @var Password|null
-     */
-    private ?Password $password = null;
+	/**
+	 * URI component "password"
+	 *
+	 * @var Password|null
+	 */
+	private ?Password $password = null;
 
-    /**
-     * Constructor of the class
-     *
-     * @param mixed $user
-     * @param mixed $password
-     */
-    public function __construct($user, $password = null)
-    {
-        $this->user = User::create($user);
+	/**
+	 * Constructor of the class
+	 *
+	 * @param mixed $user
+	 * @param mixed $password
+	 */
+	public function __construct($user, $password = null)
+	{
+		$this->user = User::create($user);
 
-        if (isset($password)) {
-            $this->password = Password::create($password);
-        }
-    }
+		if (isset($password)) {
+			$this->password = Password::create($password);
+		}
+	}
 
-    /**
-     * {@inheritdoc}
-     *
-     * @return string
-     */
-    public function getValue(): string
-    {
-        $value = $this->user->getValue();
+	/**
+	 * {@inheritdoc}
+	 *
+	 * @return string
+	 */
+	public function getValue(): string
+	{
+		$value = $this->user->getValue();
 
-        if (isset($this->password)) {
-            $value .= ':' . $this->password->getValue();
-        }
+		if (isset($this->password)) {
+			$value .= ':' . $this->password->getValue();
+		}
 
-        return $value;
-    }
+		return $value;
+	}
 }