This package contains an interface to represents URI objects according to RFC 3986.
You need:
- PHP >= 7.2 but the latest stable version of PHP is recommended
$ composer require league/uri-interfaces
The UriInterface interface models generic URIs as specified in RFC 3986.
The interface provides methods for interacting with the various URI parts, which will obviate the need for repeated parsing of the URI.
It also specifies:
- a
__toString()method for casting the modeled URI to its string representation. - a
jsonSerialize()method to improve interoperability with WHATWG URL Living standard
The UriInterface interface defines the following methods to access the URI string representation, its individual parts and components.
<?php
public UriInterface::__toString(void): string
public UriInterface::jsonSerialize(void): string
public UriInterface::getScheme(void): ?string
public UriInterface::getUserInfo(void): ?string
public UriInterface::getHost(void): ?string
public UriInterface::getPort(void): ?int
public UriInterface::getAuthority(void): ?string
public UriInterface::getPath(void): string
public UriInterface::getQuery(void): ?string
public UriInterface::getFragment(void): ?stringThe Uri interface defines the following modifying methods. these methods must be implemented such that they retain the internal state of the current instance and return an instance that contains the changed state.
Delimiter characters are not part of the URI component and must not be added to the modifying method submitted value. If present they will be treated as part of the URI component content.
These methods will trigger a League\Uri\Contract\UriException exception if the resulting URI is not valid. The validation is scheme dependent.
<?php
public UriInterface::withScheme(?string $scheme): self
public UriInterface::withUserInfo(?string $user [, string $password = null]): self
public UriInterface::withHost(?string $host): self
public UriInterface::withPort(?int $port): self
public UriInterface::withPath(string $path): self
public UriInterface::withQuery(?string $query): self
public UriInterface::withFragment(?string $fragment): selfRelation with PSR-7
This interface exposes the same methods as Psr\Http\Message\UriInterface. But, differs on the following keys:
- This interface does not require the
httpandhttpsschemes to be supported. - Setter and Getter component methods, with the exception of the path component, accept and can return the
nullvalue. - If no scheme is present, you are not required to fallback to
httpandhttpsschemes specific validation rules.
The UriComponentInterface interface models generic URI components as specified in RFC 3986. The interface provides methods for interacting with an URI component, which will obviate the need for repeated parsing of the URI component. It also specifies a __toString() method for casting the modeled URI component to its string representation.
The UriComponentInterface interface defines the following methods to access the URI component content.
<?php
public UriComponentInterface::__toString(void): string
public UriComponentInterface::getContent(void): ?string
public UriComponentInterface::getUriComponent(void): ?string
public UriComponentInterface::jsonSerialize(void): ?stringThe UriComponentInterface interface defines the following modifying method. this method must be implemented such that it retains the internal state of the current instance and return an instance that contains the changed state.
<?php
public UriComponentInterface::withContent(?string $content): staticBecause each URI component has specific needs most have specialized interface which all extends the UriComponentInterface interface. The following interfaces also exist:
League\Uri\Contract\AuthorityInterfaceLeague\Uri\Contract\DataPathInterfaceLeague\Uri\Contract\DomainHostInterfaceLeague\Uri\Contract\FragmentInterfaceLeague\Uri\Contract\UserInfoInterfaceLeague\Uri\Contract\HostInterfaceLeague\Uri\Contract\IpHostInterfaceLeague\Uri\Contract\PathInterfaceLeague\Uri\Contract\PortInterfaceLeague\Uri\Contract\QueryInterfaceLeague\Uri\Contract\SegmentedPathInterface
Contributions are welcome and will be fully credited. Please see CONTRIBUTING and CONDUCT for details.
If you discover any security related issues, please email nyamsprod@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.