Logo
URI toolkit

URI Modifiers

In some cases, you may not need to modify an entire URI, but only a specific portion of one of its components. In PHP, performing such partial updates can quickly become complex and error-prone. For example, the following illustrates how to update the query string of an existing URI object:

<?php

use GuzzleHttp\Psr7\Uri;

$uriString = "http://www.example.com?fo.o=toto#~typo";
$queryToMerge = 'fo.o=bar&taz=';

$uri = new Uri($uriString);
parse_str($uri->getQuery(), $params);
parse_str($queryToMerge, $paramsToMerge);
$query = http_build_query(
    array_merge($params, $paramsToMerge),
    '',
    '&',
    PHP_QUERY_RFC3986
);

$newUri = $uri->withQuery($query);
echo $newUri; // display http://www.example.com?fo_o=bar&taz=#~typo

In contrast, using the provided League\Uri\Modifier::mergeQuery modifier the code becomes

<?php

use League\Uri\Modifier;

$uriString = "http://www.example.com?fo.o=toto#~typo";
$queryToMerge = 'fo.o=bar&taz=';

echo Modifier::wrap($uriString)
    ->mergeQuery($queryToMerge)
    ->unwrap()
    ->toString();
// display http://www.example.com?fo.o=bar&taz=#~typo

In addition to merging the query, mergeQuery has:

  • enforced standard compliant encoding throughout the modifications;
  • not mangle your data during merging;
  • returned a valid URI object;

Since the Modifier class is immutable and each modification method returns a new instance, you can seamlessly chain multiple calls together, resulting in cleaner and more expressive code.

<?php

use League\Uri\Components\FragmentDirectives\TextDirective;
use League\Uri\Modifier;
use Uri\WhatWg\Url;

$uri = Modifier::wrap(new Url('https://www.mypoems.net/the-book-of-mwana-kupona/'))
    ->prependSegment('epic')
    ->removeLabels(-1)
    ->replaceLabel(1, "africanpoems")
    ->appendFragmentDirectives(new TextDirective(start: "Negema wangu binti", end: "neno lema kukwambia."))
    ->unwrap();

echo $uri::class, PHP_EOL; // displays Uri\WhatWg\Url
echo $uri->toAsciiString(), PHP_EOL;
// displays "https://africanpoems.net/epic/the-book-of-mwana-kupona/#:~:text=Negema%20wangu%20binti,neno%20lema%20kukwambia."

The Modifier::wrao method is the entry point from which the submitted URI will be processed. the method accepts any Stringable URI object as well as PHP new URI extension from PHP8.5 as well as its polyfill.

Modifier::from ia deprecated since version 7.6.0

Returned URI Object and String Representations

While the class does manipulate URIs it does not implement any URI related interface.

If an Uri instance is given, then the returned object will also be of the same type.

The Modifier can return different URI results depending on the context and your usage.

The Modifier::unwrap method returns a League URI Uri instance unless you instantiated the modifier with a supported Uri object in which case an instance of the same URI class is returned. If you are not interested in the returned URI but only on its underlying string representation, you can instead use the following methods:

  • Modifier::toString : returns the URI object underlying string representation.
  • Modifier::toDisplayString : returns an RFC3987 like string representation (this MAY not be a valid URL as all the components are decoded)
  • Modifier::toMarkdownAnchor : returns a Markdown representation of the URI, you can optionally set the anchor text.
  • Modifier::toHtmlAnchor : returns a HTML anchor tag <a> pre-filled with its href pre-filled; you can optionally set the anchor text and attributes.

The result of Modifier::toString is the representation used by the Stringable and the JsonSerializable interface to improve interoperability.

The Modifier::toDisplayString method returns a RFC3987 like string representation which is more suited for displaying the URI and should not be used to interact with an API as the produced URI may not be URI compliant at all.

use GuzzleHttp\Psr7\Utils;

$uri = Modifier::wrap(Utils::uriFor('https://bébé.be?foo[]=bar'))->prependLabel('shop');
$uri->unwrap()::class;        // returns 'GuzzleHttp\Psr7\Uri'
$uri->unwrap()->__toString(); // returns 'https://shop.bébé.be?foo%5B%5D=bar'
$uri->toString();          // returns 'https://shop.bébé.be?foo%5B%5D=bar'
$uri->toDisplayString();   // returns 'https://shop.bébé.be?foo[]=bar'
$uri->toMarkdownAnchor('My Shop'); // returns [My Shop](https://shop.bébé.be?foo%5B%5D=bar)
$uri->toHtmlAnchor('My Shop', ['class' => ['text-center', 'text-6xl']]);
// returns <a href="https://shop.b%C3%A9b%C3%A9.be?foo%5B%5D=bar" class="text-center text-6xl">My Shop</a>

The toDisplayString(), toMarkdownAnchor() and toHtmlAnchor() methods are available since version 7.6.0.

The getUri(), getUriString() and getIdnUriString() methods are deprecated since version 7.6.0.

The static method from() is deprecated since version 7.6.0 and replaced by the static method wrap().

General Modifiers

Available since version 7.6.0

With the addition of (2) two new native PHP URI representations, it can become complex to remember which URI method to use and which type of argument is expected. The Modifier can ease this by wrapping the underlying URI object is a common and predicable public API.

Apart from partially modifying an URI component, since version 7.6.0, you can directly:

  • completely change a URI component;
  • resolve URIs;
  • normalize URIs;

Complete URI Component Replacement

The Modifier class will perform some sanity checks and/or formatting before handing over the changed value to the underlying object to perform the action. Unless the input data is invalid, the exception thrown will be the ones from the underlying URI object.

Here’s an example:

use Uri\Rfc3986\Uri;

echo new Uri('http://example.com/foo/bar')
    ->withHost('bébé.be') 
    ->toString(), PHP_EOL;
// this will throw because
// the host contains unsupported characters
// according to RFC3986

In contrast, when using the Modifier the result is different:

use League\Uri\Modifier;
use Uri\Rfc3986\Uri;

echo Modifier::wrap(new Uri('http://example.com/foo/bar'))
    ->withHost('bébé.be')
    ->unwrap()
    ->toString(), PHP_EOL;
// the `uri()` methods returns a valid Uri\Rfc3986\Uri instance 
// its `toString()` method returns http://xn--bb-bjab.be/foo/bar
// the modifier has converted the host into its ascii representation
// to avoid the exception to be thrown.

URI Resolution

Apart from modifying a URI component, the Modifier can also normalize or resolve URI. Resolving and Normalizing URI is supported by League\Uri\Uri, and PHP’s native URI object but not by PSR-7 UriInterface and the public API diverge. using the Modifier class you get a single method for all the URI objects and add the missing support for any PSR-7 implementing class

use Uri\Whatwg\Url;

echo new Url('http://example.com/foo/bar')
    ->resolve('./../bar')
    ->toAsciiString(), PHP_EOL;
// returns http://example.com/bar
// there is no equivalent in PSR-7

using the Modifier you can do the following:

use League\Uri\Modifier;
use GuzzleHttp\Psr7\Utils;

echo Modifier::wrap(Utils::uriFor('http://example.com/foo/bar'))
    ->resolve('./../bar')
    ->unwrap()
    ->__toString(), PHP_EOL;
// `uri()` returns a Guzzle PSR-7 URI object
// returns "http://example.com/bar"

URI Normalization

RFC3986 and WHATWG URL specification both allow normalizing URIs. But both specifications do it in a different way and capacity. Normalization is mandatory when using a WHATWG URL but optional with RFC3986. It is not covered in PSR-7. Which again may leave the developer in a challenging situation. To ease developer experience, the Modifier class exposes a new normalize method which guarantee normalization regardless of the underlying URI object.

use League\Uri\Url;
use Uri\Rfc3986\Uri as Rfc3986Uri;
use Uri\Whatwg\Url as WhatwgUrl;

$uriString = 'HttP://ExamPle.com/./../foo/bar';
echo (new WhatwgUrl($uriString))->toAsciiString(), PHP_EOL;
echo (new Rfc3986Uri($uriString))->toString(), PHP_EOL;
echo Uri::new($uriString)->normalize()->toString(), PHP_EOL;
// returns 'http://example.com/foo/bar
// PSR-7 UriInterface does not have a method for that

Again using the Modifier class you will get a unified and predicable returned URI

use League\Uri\Modifier;
use GuzzleHttp\Psr7\Utils;

$uriString = 'HttP://ExamPle.com/./../foo/bar';
echo Modifier::wrap(Utils::uriFor($uriString))
    ->normalize()
    ->unwrap() 
    ->__toString();
// returns 'http://example.com/foo/bar

Partial Modifiers

Available Modifiers

Under the hood the Modifier class intensively uses the URI components objects to apply the following changes to the submitted URI.

Component modifiers since 7.6.0

Query Modifiers

Following modifiers update and normalize the URI query component.

Because each modification is done after parsing and building, the resulting query string may update the component character encoding. These changes are expected because of the rules governing parsing and building query string.

Modifier::withQuery

since version 7.6.0

Change the full query component.

use League\Uri\Modifier;

echo Modifier::wrap("https://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->withQuery('foo=bar')
    ->unwrap()
    ->getQuery(); 
//display "foo=bar"

Modifier::encodeQuery

since version 7.1.0

Change the encoding of the query string. You can either specify one of PHP’s constant between PHP_QUERY_RFC1738 and PHP_QUERY_RFC3986

use League\Uri\Modifier;

echo Modifier::wrap("https://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->encodeQuery(PHP_QUERY_RFC1738)
    ->unwrap()
    ->getQuery(); 
//display "kingkong=toto&kingkong=ape&foo=bar+baz"

or for more specific conversions you can provide a League\Uri\KeyValuePair\Converter class.

use League\Uri\KeyValuePair\Converter as KeyValuePairConverter;
use League\Uri\Modifier;
use Nyholm\Psr7\Uri;

$converter = KeyValuePairConverter::new(';')
    ->withEncodingMap([
        '%3F' => '?',
        '%2F' => '/',
        '%40' => '@',
        '%3A' => ':',
    ]);
    
Modifier::wrap(new Uri('https://example.com?foo[2]=bar#fragment'))
    ->appendQuery('url=https://example.com?foo[2]=bar#fragment')
    ->encodeQuery($converter)
    ->unwrap()
    ->getQuery();
//display "foo%5B2%5D=bar;url=https://example.com?foo%5B2%5D%3Dbar%23fragment"

Modifier::sortQuery

Sorts the query according to its key values. The sorting rules are the same uses by WHATWG URLSearchParams::sort method.

use League\Uri\Modifier;

echo Modifier::wrap("http://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->sortQuery()
    ->unwrap()
    ->getQuery(); 
//display "kingkong=toto&kingkong=ape&foo=bar%20baz"

Modifier::mergeQuery

Merges a submitted query string to the URI object to be modified. When merging two query strings with the same key value the submitted query string value takes precedence over the URI query string value.

$uri = Http::new("http://example.com/test.php?kingkong=toto&foo=bar+baz#doc3");
echo Modifier::wrap($uri)
    ->mergeQuery('kingkong=godzilla&toto')
    ->unwrap()
    ->getQuery();
//display "kingkong=godzilla&foo=bar%20baz&toto"

Modifier::appendQuery

Appends a submitted query string to the URI object to be modified. When appending two query strings with the same key value the submitted query string value is added to the return query string without modifying the URI query string value.

$uri = Http::new("http://example.com/test.php?kingkong=toto&foo=bar+baz#doc3")
echo Modifier::wrap($uri)
    ->appendQuery('kingkong=godzilla&toto')
    ->unwrap()
    ->getQuery();
//display "kingkong=toto&kingkong=godzilla&foo=bar%20baz&toto"

Modifier::appendQueryPairs

Appends a query pairs to the URI object to be modified. When appending two query strings with the same key value the submitted query string value is added to the return query string without modifying the URI query string value.

$uri = Http::new("http://example.com/test.php?kingkong=toto&foo=bar+baz#doc3")
echo Modifier::wrap($uri)
    ->appendQueryPairs([['kingkong', 'godzilla'], ['toto', null]])
    ->unwrap()
    ->getQuery();
//display "kingkong=toto&kingkong=godzilla&foo=bar%20baz&toto"

Modifier::appendQueryParameters

Appends a query PHP parameters to the URI object to be modified. When appending two query strings with the same key value the submitted query string value is added to the return query string without modifying the URI query string value.

$uri = Http::new("http://example.com/test.php?kingkong=toto&foo=bar+baz#doc3")
echo Modifier::wrap($uri)
    ->appendQueryParameters(['kingkong' => 'godzilla', 'toto' => ''])
    ->unwrap()
    ->getQuery();
//display "kingkong=toto&kingkong=godzilla&foo=bar%20baz&toto="

Modifier::removeQueryPairs

Removes query pairs from the current URI query string by providing the pairs key.

$uri = "http://example.com/test.php?kingkong=toto&foo=bar+baz&bar=baz#doc3";
$modifier = Modifier::wrap($uri);
$newUri = $modifier->removeQueryPairs('foo', 'bar');

echo $modifier->unwrap()->getQuery(); //display "kingkong=toto&foo=bar+baz&bar=baz"
echo $newUri->unwrap()->getQuery();   //display "kingkong=toto"

Modifier::removeQueryParameters

since version 7.2.0

Removes query params from the current URI query string by providing the param name. The removal preserves mangled key params.

$uri = "http://example.com/test.php?kingkong=toto&fo.o=bar&fo_o=bar";
$modifier = Modifier::wrap($uri);
$newUri = $modifier->removeQueryParameters('fo.o');

echo $modifier->unwrap()->getQuery(); //display "kingkong=toto&fo.o=bar&fo_o=bar
echo $newUri->unwrap()->getQuery();   //display "kingkong=toto&fo_o=bar"

Modifier::removeQueryParameterIndices

since version 7.2.0

Removes query params numeric indices from the current URI query string. The removal preserves mangled key params.

$uri = "http://example.com/test.php?kingkong[1]=toto&fkingkong[2]=toto";
$modifier = Modifier::wrap($uri);
$newUri = $modifier->removeQueryParameterIndices();

echo $modifier->unwrap()->getQuery(); //display "kingkong%5B1%5D=toto&fkingkong%5B2%5D=toto"
echo $newUri->unwrap()->getQuery();   //display "kingkong%5B%5D=toto&fkingkong%5B%5D=toto"

Modifier::mergeQueryParameters

since version 7.2.0

Merge PHP query parameters with the current URI query string by providing the parameters. The addition preserves mangled key params.

$uri = "http://example.com/test.php?kingkong=toto&fo.o=bar&fo_o=bar";
$newUri = Modifier::wrap($uri)->:mergeQueryParameters(['toto' => 'baz']);

echo $newUri->unwrap()->getQuery(); //display "kingkong=tot&fo.o=bar&fo_o=bar&toto=baz"

Modifier::mergeQueryPairs

since version 7.2.0

Merge query paurs with the current URI query string by providing the pairs.

$uri = "http://example.com/test.php?kingkong=toto&fo.o=bar&fo_o=bar";
$newUri = Modifier::wrap($uri)->mergeQueryPairs([['fo.o', 'champion']]);

echo $newUri->unwrap()->getQuery(); //display "kingkong=toto&fo.o=champion&fo_o=bar"

Host modifiers

The following methods update and normalize the URI host component according to the underlying URI object.

Modifier::withHost

since version 7.6.0

Change the full query component.

use League\Uri\Modifier;

echo Modifier::wrap("https://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->withHost('hello.be')
    ->unwrap()
    ->getHost(); 
//display "hello.be"

Modifier::hostToAscii

Converts the host into its ascii representation according to RFC3986:

<?php

use GuzzleHttp\Psr7\Uri;
use League\Uri\Modifier;

$uri = new Uri("http://스타벅스코리아.com/to/the/sky/");
$newUri = Modifier::wrap($uri)->hostToAscii()->unwrap();

echo get_class($newUri); //display \GuzzleHttp\Psr7\Uri
echo $newUri; //display "http://xn--oy2b35ckwhba574atvuzkc.com/to/the/sky/"

This method will have no effect on League URI objects as this conversion is done by default.

Modifier::hostToUnicode

Converts the host into its idn representation according to RFC3986:

<?php

use GuzzleHttp\Psr7\Uri;
use League\Uri\Modifiers\HostToUnicode;

$uriString = "http://xn--oy2b35ckwhba574atvuzkc.com/to/the/./sky/";
$uri = new Uri($uriString);
$newUri = Modifier::wrap($uri)->hostToUnicode();

echo get_class($newUri); //display \GuzzleHttp\Psr7\Uri
echo $newUri; //display "http://스타벅스코리아.com/to/the/sky/"

This method will have no effect on League URI objects because the object always transcode the host component into its RFC3986/ascii representation.

Modifier::hostToDecimal

Normalizes the URI host content to an IPv4 dot-decimal notation if possible otherwise returns the uri instance unchanged. See the IPv4 Converter documentation page for more information.

<?php

use League\Uri\Modifier;

$uri = 'http://0300.0250.0000.0001/path/to/the/sky.php';
echo Modifier::wrap($uri)->hostToDecimal()->unwrap();
//display 'http://192.168.0.1/path/to/the/sky.php'

Modifier::hostToOctal

Normalizes the URI host content to an IPv4 dot-octal notation if possible otherwise returns the uri instance unchanged. See the IPv4 Converter documentation page for more information.

<?php

use League\Uri\Modifier;

$uri = 'http://192.168.0.1/path/to/the/sky.php';
echo Modifier::wrap($uri)->hostToOctal()->unwrap();
//display 'http://0300.0250.0000.0001/path/to/the/sky.php'

Modifier::hostToHexadecimal

Normalizes the URI host content to a IPv4 hexadecimal notation if possible otherwise returns the uri instance unchanged. See the IPv4 Converter documentation page for more information.

<?php

use League\Uri\Modifier;

$uri = 'http://192.168.257/path/to/the/sky.php';
echo Modifier::wrap($uri)->hostToOctal()->unwrap();
//display 'http://0xc0a811/path/to/the/sky.php'

Modifier::hostToIpv6Compressed

Normalizes the URI host content to a compressed IPv6 notation if possible. See the IPv6 Converter documentation page for more information.

<?php

use League\Uri\Modifier;

$uri = 'http://[1050:0000:0000:0000:0005:0000:300c:326b]/path/to/the/sky.php';
echo Modifier::wrap($uri)->hostToIpv6Compressed()->toString();
//display 'http://[1050::5:0:300c:326b]/path/to/the/sky.php'

Modifier::hostToIpv6Expanded

Normalizes the URI host content to a expanded IPv6 notation if possible. See the IPv6 Converter documentation page for more information.

<?php

use League\Uri\Modifier;

$uri = 'http://[::1]/path/to/the/sky.php';
echo Modifier::wrap($uri)->hostToIpv6Expanded()->toString();
//display 'http://[0000:0000:0000:0000:0000:0000:0000:0001]/path/to/the/sky.php'

Modifier::removeZoneIdentifier

Removes the host zone identifier if present

<?php

use Zend\Diactoros\Uri;
use League\Uri\Modifier;

$uri = new Uri('http://[fe80::1234%25eth0-1]/path/to/the/sky.php');
$newUri = Modifier::wrap($uri)->removeZoneIdentifier()->unwrap();
echo $newUri::class; //display \Zend\Diactoros\Uri

echo $newUri; //display 'http://[fe80::1234]/path/to/the/sky.php'

Modifier::normalizeIp

Format the IP host:

  • it will compress the IP representation if the host is an IPv6 address
  • it will convert the host to its IPv4 decimal format if possible

available since version 7.6.0

$uri = "https://0:0@0:0";
echo Modifier::wrap($uri)->normalizeIp()->toString();
//display "https://0:0@0.0.0.0:0"

Modifier::normalizeHost

If the host is an IP address or a registrable domain that can be assimilated to an IPv4 address it will use the Modifier::normalizeIp method. Otherwise, it will try to convert the host into its ASCII format.

available since version 7.6.0

$uri = "https://0:0@0:0";
echo Modifier::wrap($uri)->normalizeHost()->toString();
//display "https://0:0@0.0.0.0:0"

This is the algorithm used by the WHATWG URL specification.

Modifier::addRootLabel

Adds the root label if not present

use League\Uri\Modifier;

echo Modifier::wrap('http://example.com:83')->addRootLabel(); //display 'http://example.com.:83'

Modifier::removeRootLabel

Removes the root label if present

use League\Uri\Modifier;

echo Modifier::wrap('http://example.com.#yes')->removeRootLabel();  //display 'http://example.com#yes'

Modifier::appendLabel

Appends a host to the current URI host.

use League\Uri\Modifier;

echo Modifier::wrap("http://www.example.com/path/to/the/sky/")->appendLabel('fr'); 
//display "http://www.example.com.fr/path/to/the/sky/"

Modifier::prependLabel

Prepends a host to the current URI path.

use League\Uri\Modifier;

echo Modifier::wrap("http://www.example.com/path/to/the/sky/")->prependLabel('shop');
//display "http://shop.www.example.com/path/to/the/sky/and/above"

Modifier::replaceLabel

Replaces a label from the current URI host with a host.

Hosts are hierarchical components whose labels are indexed from right to left.

use League\Uri\Modifier;

$uri = "http://www.example.com/path/to/the/sky/";
echo Modifier::wrap($uri)->replaceLabel(2, 'admin.shop');
//display "http://admin.shop.example.com/path/to/the/sky"

This modifier supports negative offset

The previous example can be rewritten using negative offset:

use League\Uri\Modifier;

$uri = "http://www.example.com/path/to/the/sky/";
echo Modifier::wrap($uri)->replaceLabel(-1, 'admin.shop');
//display "http://admin.shop.example.com/path/to/the/sky"

Modifier::removeLabels

Removes selected labels from the current URI host. Labels are indicated string variadic labels offsets.

Hosts are hierarchical components whose labels are indexed from right to left.


$uri = "http://www.localhost.com/path/to/the/sky/";
echo Modifier::wrap($uri)->removeLabels(2, 0);
//display "http://localhost/path/the/sky/"

This modifier supports negative offset

The previous example can be rewritten using negative offset:

$uri = "http://www.example.com/path/to/the/sky/";
Modifier::wrap($uri)->removeLabels(-1, -3)->toString();
//return "http://localhost/path/the/sky/"

Modifier::sliceLabels

Slice the host from the current URI host. Negative offset are also supported.

Hosts are hierarchical components whose labels are indexed from right to left.

$uri = "http://www.localhost.com/path/to/the/sky/";
echo Modifier::wrap($uri)->sliceLabels(1, 1)->toString();
//display "http://localhost/path/the/sky/"

This modifier supports negative offset

Path modifiers

Because each modification is done after parsing and building, the resulting path may update the component character encoding. These changes are expected because of the rules governing parsing and building path string.

Modifier::withPath

since version 7.6.0

Change the full path component.

use League\Uri\Modifier;

echo Modifier::wrap("https://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->withPath('/path/to')
    ->unwrap()
    ->getPath(); 
//display "/path/to"

Modifier::removeDotSegments

Removes dot segments according to RFC3986:

$uri = "http://www.example.com/path/../to/the/./sky/";
echo Modifier::wrap($uri)->removeDotSegments();
//display "http://www.example.com/to/the/sky/"

Modifier::removeEmptySegments

Removes adjacent separators with empty segment.

$uri = "http://www.example.com/path//to/the//sky/";
echo Modifier::wrap($uri)->removeEmptySegments();
//display "http://www.example.com/path/to/the/sky/"

Modifier::removeTrailingSlash

Removes the path trailing slash if present

$uri = Uri::new("http://www.example.com/path/?foo=bar");
echo Modifier::wrap($uri)->removeTrailingSlash();
//display "http://www.example.com/path?foo=bar"

Modifier::addTrailingSlash

Adds the path trailing slash if not present

$uri = "http://www.example.com/sky#top";
echo Modifier::wrap($uri)->addTrailingSlash();
//display "http://www.example.com/sky/#top"

Modifier::removeLeadingSlash

Remove the path leading slash if present.

$uri = "/path/to/the/sky/";
echo Modifier::wrap($uri)->removeLeadingSlash();
//display "path/to/the/sky"

Modifier::addLeadingSlash

Add the path leading slash if not present.

echo Modifier::wrap("path/to/the/sky/")->addLeadingSlash();
//display "/path/to/the/sky"

Modifier::replaceDirname

Adds, updates and/or removes the path dirname from the current URI path.

echo Modifier::wrap("http://www.example.com/path/to/the/sky")
    ->replaceDirname('/road/to')
    ->unwrap()
    ->getPath(); //display "/road/to/sky"

Modifier::replaceBasename

Adds, updates and or removes the path basename from the current URI path.

$uri = Http::new("http://www.example.com/path/to/the/sky");
echo Modifier::wrap($uri)
    ->replaceBasename("paradise.xml")
    ->unwrap()
    ->getPath();
     //display "/path/to/the/paradise.xml"

Modifier::replaceExtension

Adds, updates and or removes the path extension from the current URI path.

$uri = Http::new("http://www.example.com/export.html");
echo Modifier::wrap($uri)->replaceExtension('csv')->unwrap()->getPath();
//display "/export.csv"

Modifier::addBasePath

Adds the basepath to the current URI path.

$uri = Http::new("http://www.example.com/path/to/the/sky");
echo Modifier::wrap($uri)
    ->addBasePath('/the/real')
    ->unwrap()
    ->getPath();
//display "/the/real/path/to/the/sky"

Modifier::removeBasePath

Removes the basepath from the current URI path.

$uri = Http::new("http://www.example.com/path/to/the/sky");
echo Modifier::wrap($uri)
    ->removeBasePath("/path/to/the")
    ->unwrap()
    ->getPath();
//display "/sky"

Modifier::appendSegment

Appends a path to the current URI path.

$uri = Http::new("http://www.example.com/path/to/the/sky/");
echo Modifier::wrap($uri)
    ->appendSegment("and/above")
    ->unwrap()
    ->getPath();
 //display "/path/to/the/sky/and/above"

Modifier::prependSegment

Prepends a path to the current URI path.

$uri = Http::new("http://www.example.com/path/to/the/sky/");
echo Modifier::wrap($uri)
    ->prependSegment("and/above")
    ->unwrap()
    ->getPath();
 //display "/and/above/path/to/the/sky/"

Modifier::replaceSegment

Replaces a segment from the current URI path with a new path.

$uri = Http::new("http://www.example.com/path/to/the/sky/");
echo Modifier::wrap($uri)
    ->replaceSegment(3, "sea")
    ->unwrap()
    ->getPath();
 //display "/path/to/the/sea/"

This modifier supports negative offset

The previous example can be rewritten using negative offset:

echo Modifier::wrap("http://www.example.com/path/to/the/sky/")
    ->replaceSegment(-1, "sea")
    ->getPath();
//display "/path/to/the/sea/"

Modifier::removeSegments

Removes selected segments from the current URI path by providing the segments offset.

echo Modifier::wrap("http://www.example.com/path/to/the/sky/")
    ->removeSegments(1, 3)
    ->unwrap()
    ->getPath();
//display "/path/the/"

This modifier supports negative offset

echo Modifier::wrap("http://www.example.com/path/to/the/sky/")
    ->removeSegments(-1, -2])
    ->unwrap()
    ->getPath();
//display "/path/the/"

Modifier::sliceSegments

Slice the path from the current URI path. Negative offset are also supported.

$uri = "http://www.localhost.com/path/to/the/sky/";
echo Modifier::wrap($uri)->sliceSegments(2, 2)->toString();
//display "http://www.localhost.com/the/sky/"

Modifier::replaceDataUriParameters

Update Data URI parameters

$uri = Uri::new("data:text/plain;charset=US-ASCII,Hello%20World!");
echo Modifier::wrap($uri)
    ->replaceDataUriParameters("charset=utf-8")
    ->unwrap()
    ->getPath();
//display "text/plain;charset=utf-8,Hello%20World!"

Modifier::dataPathToBinary

Converts a data URI path from text to its base64 encoded version

$uri = Uri::new("data:text/plain;charset=US-ASCII,Hello%20World!");
echo Modifier::wrap($uri)
    ->dataPathToBinary()
    ->unwrap()
    ->getPath();
//display "text/plain;charset=US-ASCII;base64,SGVsbG8gV29ybGQh"

Modifier::dataPathToAscii

Converts a data URI path from text to its base64 encoded version

$uri = Uri::new("data:text/plain;charset=US-ASCII;base64,SGVsbG8gV29ybGQh");
echo Modifier::wrap($uri)
    ->dataPathToAscii()
    ->unwrap()
    ->getPath();
//display "text/plain;charset=US-ASCII,Hello%20World!"

Fragment Modifiers

Modifier::withFragment

since version 7.6.0

Change the full fragment component.

use League\Uri\Modifier;

echo Modifier::wrap("https://example.com/?kingkong=toto&foo=bar%20baz&kingkong=ape")
    ->withFragment('/path/to')
    ->unwrap()
    ->getFragment(); 
//display "/path/to"

Modifier::appendFragmentDirectives

available since version 7.6.0

Appends one or more directives to the current URI fragment.

$uri = Http::new("http://www.example.com/path/to/the/sky/");
echo Modifier::wrap($uri)
    ->appendFragmentDirectives(new TextDirective(start:"foo", end:"bar"))
    ->appendFragmentDirectives('unknownDirective')
    ->unwrap()
    ->getFragment();
// display ":~:text=foo,bar&unknownDirective"

Modifier::prependFragmentDirectives

available since version 7.6.0

Prepends one or more directives to the current URI fragment.

use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky/");
echo Modifier::wrap($uri)
    ->prependFragmentDirectives(new TextDirective(start:"foo", end:"bar"))
    ->prependFragmentDirectives('unknownDirective')
    ->unwrap()
    ->getFragment();
// display ":~:text=foo,bar&unknownDirective"

Modifier::replaceFragmentDirective

available since version 7.6.0

Replace a specific directive from the fragment.

use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky/#:~:text=foo,bar&unknownDirective");
echo Modifier::wrap($uri)
    ->replaceFragmentDirective(1, new TextDirective(start:"bar", end:"foo"))
    ->unwrap()
    ->getFragment();
// display ":~:text=foo,bar&text=bar,foo"

Modifier::removeFragmentDirectives

available since version 7.6.0

Remove directives from the fragment using their offsets.

use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky/#:~:text=foo,bar&unknownDirective");
echo Modifier::wrap($uri)
    ->removeFragmentDirectives(1)
    ->unwrap()
    ->getFragment();
// display ":~:text=foo,bar"

Modifier::sliceFragmentDirectives

available since version 7.6.0

Slice directives from the fragment using their offsets.

use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky/#:~:text=foo,bar&unknownDirective&text=yes");
echo Modifier::wrap($uri)
    ->sliceDirective(0, 2)
    ->unwrap()
    ->getFragment();
// display ":~:text=yes"

Modifier::filterFragmentDirectives

available since version 7.6.0

Remove directives from the fragment using a callback.

use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky/#:~:text=foo,bar&unknownDirective&text=yes");
echo Modifier::wrap($uri)
    ->filterFragmentDirectives(fn (Directive $directive, int $offset) => $directive->name() !== 'text')
    ->unwrap()
    ->getFragment();
// display ":~:text=foo,bar&text=yes"

Other available modifiers

Modifier::withUserInfo

available since version 7.6.0

Allow modifying the user info component

use League\Uri\Modifier;
use Uri\Rfc3986\Uri;

$uri = new Uri("http://www.example.com/path/to/the/sky");
echo Modifier::wrap($uri)
    ->withUserInfo(username: null, password: 'pa@ss')
    ->unwrap()
    ->getUserInfo();
// display ":pa%40ss"
// for information the Uri::withUserInfo method only takes a single variable.

Modifier::withScheme

available since version 7.6.0

Allow modifying the URI scheme

use League\Uri\Modifier;
use Uri\Rfc3986\Uri;

$uri = new Uri("http://www.example.com/path/to/the/sky");
$newUri = Modifier::wrap($uri)->withScheme('HtTp')->unwrap();
$newUri->getRawScheme(); // returns 'HtTp'
$newUri->getScheme(); // returns 'http'

The stored scheme value will depend on the underlying URI object.

Modifier::withPort

available since version 7.6.0

Allow modifying the URI port. Added for completeness. This method works the same across all the URI objects, but may throw depending on the restriction from the underlying URI object on port range.

use League\Uri\Modifier;
use Uri\WhatWg\Url;

$uri = new Url("http://www.example.com/path/to/the/sky");
$newUri = Modifier::wrap($uri)->withPort(433)->unwrap();
$newUri->getPort(); // returns 433