🛀 Uri constructor now also accepts arrays (parse_url), eliminate UriExtended, move methods to message_helpers

Author: codemasher

src/Psr17/factory_helpers.php

@@ -9,7 +9,7 @@
 namespace chillerlan\HTTP\Psr17;
 
 use Psr\Http\Message\ServerRequestInterface;
-use chillerlan\HTTP\Psr7\{ServerRequest, Stream, UriExtended};
+use chillerlan\HTTP\Psr7\{ServerRequest, Stream, Uri};
 use InvalidArgumentException;
 use Psr\Http\Message\StreamInterface;
 
@@ -77,7 +77,7 @@ function_exists('getallheaders') ? getallheaders() : [],
 /**
  * Get a Uri populated with values from $_SERVER.
  */
-function create_uri_from_globals():UriExtended{
+function create_uri_from_globals():Uri{
 	$parts    = [];
 	$hasPort  = false;
 	$hasQuery = false;
@@ -118,8 +118,7 @@ function create_uri_from_globals():UriExtended{
 		$parts['query'] = $_SERVER['QUERY_STRING'];
 	}
 
-	/** @noinspection PhpIncompatibleReturnTypeInspection */
-	return UriExtended::fromParts($parts);
+	return new Uri($parts);
 }
 
 /**

src/Psr7/Uri.php

@@ -13,7 +13,7 @@
 use InvalidArgumentException;
 use Psr\Http\Message\UriInterface;
 
-use function call_user_func_array, explode, filter_var, is_string, ltrim, parse_url,
+use function call_user_func_array, explode, filter_var, is_array, is_string, ltrim, parse_url,
 	preg_replace_callback, rawurlencode, strpos, strtolower, ucfirst;
 
 use const FILTER_FLAG_IPV6, FILTER_VALIDATE_IP;
@@ -53,18 +53,24 @@ class Uri implements UriInterface{
 	/**
 	 * Uri constructor.
 	 *
+	 * @param string|array $uri
+	 *
 	 * @throws \InvalidArgumentException
 	 */
-	public function __construct(string $uri = null){
+	public function __construct($uri = null){
+
+		if($uri !== null){
 
-		if($uri !== null && $uri !== ''){
-			$parts = parse_url($uri);
+			if(is_string($uri)){
+				$uri = parse_url($uri);
+			}
 
-			if($parts === false){
+			if(!is_array($uri)){
 				throw new InvalidArgumentException('invalid URI: "'.$uri.'"');
 			}
 
-			$this->parseUriParts($parts);
+			$this->parseUriParts($uri);
+			$this->validateState();
 		}
 
 	}

src/Psr7/UriExtended.php

@@ -9,11 +9,11 @@
 namespace chillerlan\HTTP\Psr7;
 
 use InvalidArgumentException, TypeError;
-use Psr\Http\Message\{MessageInterface, RequestInterface, ResponseInterface, UploadedFileInterface};
+use Psr\Http\Message\{MessageInterface, RequestInterface, ResponseInterface, UploadedFileInterface, UriInterface};
 
-use function array_combine, array_keys, array_map, array_merge, array_values, call_user_func_array, count, explode,
+use function array_combine, array_filter, array_keys, array_map, array_merge, array_values, call_user_func_array, count, explode,
 	gzdecode, gzinflate, gzuncompress, implode, is_array, is_bool, is_iterable, is_numeric, is_scalar, is_string,
-	json_decode, json_encode, parse_str, parse_url, rawurlencode, simplexml_load_string, sort, strtolower, trim,
+	json_decode, json_encode, parse_str, parse_url, rawurldecode, rawurlencode, simplexml_load_string, sort, strtolower, trim,
 	ucfirst, uksort;
 
 use const PHP_URL_QUERY, SORT_STRING;
@@ -499,3 +499,119 @@ function decompress_content(MessageInterface $message):string{
 	}
 
 }
+
+/**
+ * Whether the URI is absolute, i.e. it has a scheme.
+ *
+ * An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true
+ * if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative
+ * to another URI, the base URI. Relative references can be divided into several forms:
+ * - network-path references, e.g. '//example.com/path'
+ * - absolute-path references, e.g. '/path'
+ * - relative-path references, e.g. 'subpath'
+ *
+ * @see  Uri::isNetworkPathReference
+ * @see  Uri::isAbsolutePathReference
+ * @see  Uri::isRelativePathReference
+ * @link https://tools.ietf.org/html/rfc3986#section-4
+ */
+function uriIsAbsolute(UriInterface $uri):bool{
+	return $uri->getScheme() !== '';
+}
+
+/**
+ * Whether the URI is a network-path reference.
+ *
+ * A relative reference that begins with two slash characters is termed an network-path reference.
+ *
+ * @link https://tools.ietf.org/html/rfc3986#section-4.2
+ */
+function uriIsNetworkPathReference(UriInterface $uri):bool{
+	return $uri->getScheme() === '' && $uri->getAuthority() !== '';
+}
+
+/**
+ * Whether the URI is a absolute-path reference.
+ *
+ * A relative reference that begins with a single slash character is termed an absolute-path reference.
+ *
+ * @link https://tools.ietf.org/html/rfc3986#section-4.2
+ */
+function uriIsAbsolutePathReference(UriInterface $uri):bool{
+	return $uri->getScheme() === '' && $uri->getAuthority() === '' && isset($uri->getPath()[0]) && $uri->getPath()[0] === '/';
+}
+
+/**
+ * Whether the URI is a relative-path reference.
+ *
+ * A relative reference that does not begin with a slash character is termed a relative-path reference.
+ *
+ * @return bool
+ * @link https://tools.ietf.org/html/rfc3986#section-4.2
+ */
+function uriIsRelativePathReference(UriInterface $uri):bool{
+	return $uri->getScheme() === '' && $uri->getAuthority() === '' && (!isset($uri->getPath()[0]) || $uri->getPath()[0] !== '/');
+}
+
+/**
+ * removes a specific query string value.
+ *
+ * Any existing query string values that exactly match the provided key are
+ * removed.
+ *
+ * @param string $key Query string key to remove.
+ */
+function uriWithoutQueryValue(UriInterface $uri, string $key):UriInterface{
+	$current = $uri->getQuery();
+
+	if($current === ''){
+		return $uri;
+	}
+
+	$decodedKey = rawurldecode($key);
+
+	$result = array_filter(explode('&', $current), function($part) use ($decodedKey){
+		return rawurldecode(explode('=', $part)[0]) !== $decodedKey;
+	});
+
+	return $uri->withQuery(implode('&', $result));
+}
+
+/**
+ * adds a specific query string value.
+ *
+ * Any existing query string values that exactly match the provided key are
+ * removed and replaced with the given key value pair.
+ *
+ * A value of null will set the query string key without a value, e.g. "key"
+ * instead of "key=value".
+ *
+ * @param string      $key   Key to set.
+ * @param string|null $value Value to set
+ */
+function uriWithQueryValue(UriInterface $uri, string $key, string $value = null):UriInterface{
+	$current = $uri->getQuery();
+
+	if($current === ''){
+		$result = [];
+	}
+	else{
+		$decodedKey = rawurldecode($key);
+		$result     = array_filter(explode('&', $current), function($part) use ($decodedKey){
+			return rawurldecode(explode('=', $part)[0]) !== $decodedKey;
+		});
+	}
+
+	// Query string separators ("=", "&") within the key or value need to be encoded
+	// (while preventing double-encoding) before setting the query string. All other
+	// chars that need percent-encoding will be encoded by withQuery().
+	$replaceQuery = ['=' => '%3D', '&' => '%26'];
+	$key          = strtr($key, $replaceQuery);
+
+	$result[] = $value !== null
+		? $key.'='.strtr($value, $replaceQuery)
+		: $key;
+
+	return $uri->withQuery(implode('&', $result));
+}
+

src/Psr7/message_helpers.php

@@ -10,7 +10,7 @@
 
 namespace chillerlan\HTTPTest\Psr17;
 
-use chillerlan\HTTP\Psr7\{UploadedFile, UriExtended};
+use chillerlan\HTTP\Psr7\{UploadedFile, Uri};
 use InvalidArgumentException, stdClass;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\StreamInterface;
@@ -98,7 +98,7 @@ public function dataGetUriFromGlobals():array{
 	public function testCreateUriFromGlobals(string $expected, array $serverParams){
 		$_SERVER = $serverParams;
 
-		$this::assertEquals(new UriExtended($expected), create_uri_from_globals());
+		$this::assertEquals(new Uri($expected), create_uri_from_globals());
 	}
 
 	public function testCreateServerRequestFromGlobals():void{
@@ -157,7 +157,7 @@ public function testCreateServerRequestFromGlobals():void{
 		$this::assertSame($_GET, $server->getQueryParams());
 
 		$this::assertEquals(
-			new UriExtended('https://www.example.org/blog/article.php?id=10&user=foo'),
+			new Uri('https://www.example.org/blog/article.php?id=10&user=foo'),
 			$server->getUri()
 		);