independent-analytics
/
vendor
/
league
/
uri-interfaces
/
src
/
Contracts
/
UriComponentInterface.php
AuthorityInterface.php
3 years ago
DataPathInterface.php
3 years ago
DomainHostInterface.php
3 years ago
FragmentInterface.php
3 years ago
HostInterface.php
3 years ago
IpHostInterface.php
3 years ago
PathInterface.php
3 years ago
PortInterface.php
3 years ago
QueryInterface.php
3 years ago
SegmentedPathInterface.php
3 years ago
UriComponentInterface.php
3 years ago
UriException.php
3 years ago
UriInterface.php
3 years ago
UserInfoInterface.php
3 years ago
UriComponentInterface.php
82 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * League.Uri (https://uri.thephpleague.com) |
| 5 | * |
| 6 | * (c) Ignace Nyamagana Butera <nyamsprod@gmail.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | declare (strict_types=1); |
| 12 | namespace IAWP\League\Uri\Contracts; |
| 13 | |
| 14 | use IAWP\League\Uri\Exceptions\IdnSupportMissing; |
| 15 | use IAWP\League\Uri\Exceptions\SyntaxError; |
| 16 | interface UriComponentInterface extends \JsonSerializable |
| 17 | { |
| 18 | /** |
| 19 | * Returns the instance content. |
| 20 | * |
| 21 | * If the instance is defined, the value returned MUST be encoded according to the |
| 22 | * selected encoding algorithm. In any case, the value MUST NOT double-encode any character |
| 23 | * depending on the selected encoding algorithm. |
| 24 | * |
| 25 | * To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3. |
| 26 | * or RFC 3987 Section 3. By default the content is encoded according to RFC3986 |
| 27 | * |
| 28 | * If the instance is not defined null is returned |
| 29 | */ |
| 30 | public function getContent() : ?string; |
| 31 | /** |
| 32 | * Returns the instance string representation. |
| 33 | * |
| 34 | * If the instance is defined, the value returned MUST be percent-encoded, |
| 35 | * but MUST NOT double-encode any characters. To determine what characters |
| 36 | * to encode, please refer to RFC 3986, Sections 2 and 3. |
| 37 | * |
| 38 | * If the instance is not defined an empty string is returned |
| 39 | */ |
| 40 | public function __toString() : string; |
| 41 | /** |
| 42 | * Returns the instance json representation. |
| 43 | * |
| 44 | * If the instance is defined, the value returned MUST be percent-encoded, |
| 45 | * but MUST NOT double-encode any characters. To determine what characters |
| 46 | * to encode, please refer to RFC 3986 or RFC 1738. |
| 47 | * |
| 48 | * If the instance is not defined null is returned |
| 49 | */ |
| 50 | public function jsonSerialize() : ?string; |
| 51 | /** |
| 52 | * Returns the instance string representation with its optional URI delimiters. |
| 53 | * |
| 54 | * The value returned MUST be percent-encoded, but MUST NOT double-encode any |
| 55 | * characters. To determine what characters to encode, please refer to RFC 3986, |
| 56 | * Sections 2 and 3. |
| 57 | * |
| 58 | * If the instance is not defined an empty string is returned |
| 59 | */ |
| 60 | public function getUriComponent() : string; |
| 61 | /** |
| 62 | * Returns an instance with the specified content. |
| 63 | * |
| 64 | * This method MUST retain the state of the current instance, and return |
| 65 | * an instance that contains the specified content. |
| 66 | * |
| 67 | * Users can provide both encoded and decoded content characters. |
| 68 | * |
| 69 | * A null value is equivalent to removing the component content. |
| 70 | * |
| 71 | * |
| 72 | * @param ?string $content |
| 73 | * |
| 74 | * @throws SyntaxError for invalid component or transformations |
| 75 | * that would result in a object in invalid state. |
| 76 | * @throws IdnSupportMissing for component or transformations |
| 77 | * requiring IDN support when IDN support is not present |
| 78 | * or misconfigured. |
| 79 | */ |
| 80 | public function withContent(?string $content) : self; |
| 81 | } |
| 82 |