Skip to content

[2.8] Encode plus sign in withQueryValue() and withQueryValues() #636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GrahamCampbell merged 2 commits into from
Mar 10, 2026
Merged

[2.8] Encode plus sign in withQueryValue() and withQueryValues() #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
78a6445
Encode plus sign in withQueryValue() and withQueryValues()
eyupcanakman Mar 7, 2026
e67ee7e
Add plus sign note to Uri query comment
eyupcanakman Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/Uri.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class Uri implements UriInterface, \JsonSerializable
* @see https://datatracker.ietf.org/doc/html/rfc3986#section-2.2
*/
private const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;=';
private const QUERY_SEPARATORS_REPLACEMENT = ['=' => '%3D', '&' => '%26'];
private const QUERY_SEPARATORS_REPLACEMENT = ['=' => '%3D', '&' => '%26', '+' => '%2B'];

/** @var string Uri scheme. */
private $scheme = '';
Expand Down Expand Up @@ -661,7 +661,8 @@ private static function getFilteredQueryString(UriInterface $uri, array $keys):

private static function generateQueryString(string $key, ?string $value): string
{
// Query string separators ("=", "&") within the key or value need to be encoded
// Query string separators ("=", "&") and literal plus signs ("+") 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().
$queryString = strtr($key, self::QUERY_SEPARATORS_REPLACEMENT);
Expand Down
11 changes: 11 additions & 0 deletions tests/UriTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,17 @@ public function testWithQueryValueHandlesEncoding(): void
self::assertSame('E%3Dmc%5e2=ein%26stein', $uri->getQuery(), 'Encoded key/value do not get double-encoded');
}

public function testWithQueryValueEncodesPlusSign(): void
{
$uri = new Uri();
$uri = Uri::withQueryValue($uri, 'a+b', 'c+d');
self::assertSame('a%2Bb=c%2Bd', $uri->getQuery(), 'Plus signs in key and value get encoded to %2B');

$uri = new Uri();
$uri = Uri::withQueryValue($uri, 'query', 'a+b c');
self::assertSame('query=a%2Bb%20c', $uri->getQuery(), 'Plus sign is encoded distinctly from space');
}

public function testWithoutQueryValueHandlesEncoding(): void
{
// It also tests that the case of the percent-encoding does not matter,
Expand Down