RenderAsString.md

Render as string

use function BenTools\QueryString\query_string;

$qs = query_string([
    'yummy' => [
        'fruits' => [
            'strawberries',
            'raspberries',
        ],
    ]
]);

print(urldecode((string) $qs)); // yummy[fruits][0]=strawberries&yummy[fruits][1]=raspberries

Note that the leading question mark will never be included.

Change renderer

Remove numeric indices:

This renderer will render indexed arrays as foo[]=bar&foo[]=baz instead of foo[0]=bar&foo[1]=baz.

use function BenTools\QueryString\withoutNumericIndices;

$qs = $qs->withRenderer(withoutNumericIndices());
print(urldecode((string) $qs));

Flat renderer

This renderer will render indexed arrays as foo=bar&foo=baz instead of foo[0]=bar&foo[1]=baz.

use function BenTools\QueryString\flat;

$qs = $qs->withRenderer(flat());
print(urldecode((string) $qs));

Global setting

You can define a default renderer on a global scope for future QueryString objects:

use BenTools\QueryString\QueryString;
use function BenTools\QueryString\withoutNumericIndices;

QueryString::setDefaultRenderer(withoutNumericIndices());

You can also create your own rendering logic by implementing BenTools\QueryString\Renderer\QueryStringRendererInterface.

Change encoding

This library renders query strings with RFC 3986 by default, but you can change it if needed.

$qs = query_string('param=foo bar');
print((string) $qs); // param=foo%20bar

$qs = $qs->withRenderer(
    $qs->getRenderer()->withEncoding(PHP_QUERY_RFC1738)
);
print((string) $qs); // param=foo+bar

Change separator

$qs = query_string('foo=bar&baz=bat');
$qs = $qs->withRenderer(
    $qs->getRenderer()->withSeparator(';')
);
print((string) $qs); // foo=bar;baz=bat

PSR-7 manipulation

Example:

use function BenTools\QueryString\query_string;

/**
 * @var \Psr\Http\Message\MessageInterface $uri
 */
print((string) $uri); // http://www.example.net/

$uri = $uri->withQuery(
    (string) query_string($uri)->withParam('foo', 'bar')
);

print((string) $uri); // http://www.example.net/?foo=bar

Previous - Manipulate parameters