independent-analytics
/
vendor
/
league
/
uri-interfaces
/
src
/
Contracts
/
DomainHostInterface.php
AuthorityInterface.php
2 years ago
DataPathInterface.php
2 years ago
DomainHostInterface.php
2 years ago
FragmentInterface.php
2 years ago
HostInterface.php
2 years ago
IpHostInterface.php
2 years ago
PathInterface.php
2 years ago
PortInterface.php
2 years ago
QueryInterface.php
2 years ago
SegmentedPathInterface.php
2 years ago
UriComponentInterface.php
2 years ago
UriException.php
2 years ago
UriInterface.php
2 years ago
UserInfoInterface.php
2 years ago
DomainHostInterface.php
96 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 IAWPSCOPED\League\Uri\Contracts; |
| 13 | |
| 14 | use IAWPSCOPED\League\Uri\Exceptions\SyntaxError; |
| 15 | /** |
| 16 | * @extends \IteratorAggregate<string> |
| 17 | * @internal |
| 18 | */ |
| 19 | interface DomainHostInterface extends \Countable, HostInterface, \IteratorAggregate |
| 20 | { |
| 21 | /** |
| 22 | * Returns the labels total number. |
| 23 | */ |
| 24 | public function count() : int; |
| 25 | /** |
| 26 | * Iterate over the Domain labels. |
| 27 | * |
| 28 | * @return \Iterator<string> |
| 29 | */ |
| 30 | public function getIterator() : \Iterator; |
| 31 | /** |
| 32 | * Retrieves a single host label. |
| 33 | * |
| 34 | * If the label offset has not been set, returns the null value. |
| 35 | */ |
| 36 | public function get(int $offset) : ?string; |
| 37 | /** |
| 38 | * Returns the associated key for a specific label or all the keys. |
| 39 | * |
| 40 | * @param ?string $label |
| 41 | * |
| 42 | * @return int[] |
| 43 | */ |
| 44 | public function keys(?string $label = null) : array; |
| 45 | /** |
| 46 | * Tells whether the domain is absolute. |
| 47 | */ |
| 48 | public function isAbsolute() : bool; |
| 49 | /** |
| 50 | * Prepends a label to the host. |
| 51 | */ |
| 52 | public function prepend(string $label) : self; |
| 53 | /** |
| 54 | * Appends a label to the host. |
| 55 | */ |
| 56 | public function append(string $label) : self; |
| 57 | /** |
| 58 | * Returns an instance with its Root label. |
| 59 | * |
| 60 | * @see https://tools.ietf.org/html/rfc3986#section-3.2.2 |
| 61 | */ |
| 62 | public function withRootLabel() : self; |
| 63 | /** |
| 64 | * Returns an instance without its Root label. |
| 65 | * |
| 66 | * @see https://tools.ietf.org/html/rfc3986#section-3.2.2 |
| 67 | */ |
| 68 | public function withoutRootLabel() : self; |
| 69 | /** |
| 70 | * Returns an instance with the modified label. |
| 71 | * |
| 72 | * This method MUST retain the state of the current instance, and return |
| 73 | * an instance that contains the new label |
| 74 | * |
| 75 | * If $key is non-negative, the added label will be the label at $key position from the start. |
| 76 | * If $key is negative, the added label will be the label at $key position from the end. |
| 77 | * |
| 78 | * @throws SyntaxError If the key is invalid |
| 79 | */ |
| 80 | public function withLabel(int $key, string $label) : self; |
| 81 | /** |
| 82 | * Returns an instance without the specified label. |
| 83 | * |
| 84 | * This method MUST retain the state of the current instance, and return |
| 85 | * an instance that contains the modified component |
| 86 | * |
| 87 | * If $key is non-negative, the removed label will be the label at $key position from the start. |
| 88 | * If $key is negative, the removed label will be the label at $key position from the end. |
| 89 | * |
| 90 | * @param int ...$keys |
| 91 | * |
| 92 | * @throws SyntaxError If the key is invalid |
| 93 | */ |
| 94 | public function withoutLabel(int ...$keys) : self; |
| 95 | } |
| 96 |