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
AuthorityInterface.php
80 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 AuthorityInterface extends UriComponentInterface |
| 17 | { |
| 18 | /** |
| 19 | * Returns the host component of the authority. |
| 20 | */ |
| 21 | public function getHost() : ?string; |
| 22 | /** |
| 23 | * Returns the port component of the authority. |
| 24 | */ |
| 25 | public function getPort() : ?int; |
| 26 | /** |
| 27 | * Returns the user information component of the authority. |
| 28 | */ |
| 29 | public function getUserInfo() : ?string; |
| 30 | /** |
| 31 | * Return an instance with the specified host. |
| 32 | * |
| 33 | * This method MUST retain the state of the current instance, and return |
| 34 | * an instance that contains the specified host. |
| 35 | * |
| 36 | * A null value provided for the host is equivalent to removing the host |
| 37 | * information. |
| 38 | * |
| 39 | * @param ?string $host |
| 40 | * @throws SyntaxError for invalid component or transformations |
| 41 | * that would result in a object in invalid state. |
| 42 | * @throws IdnSupportMissing for component or transformations |
| 43 | * requiring IDN support when IDN support is not present |
| 44 | * or misconfigured. |
| 45 | */ |
| 46 | public function withHost(?string $host) : self; |
| 47 | /** |
| 48 | * Return an instance with the specified port. |
| 49 | * |
| 50 | * This method MUST retain the state of the current instance, and return |
| 51 | * an instance that contains the specified port. |
| 52 | * |
| 53 | * A null value provided for the port is equivalent to removing the port |
| 54 | * information. |
| 55 | * |
| 56 | * @param ?int $port |
| 57 | * |
| 58 | * @throws SyntaxError for invalid component or transformations |
| 59 | * that would result in a object in invalid state. |
| 60 | */ |
| 61 | public function withPort(?int $port) : self; |
| 62 | /** |
| 63 | * Return an instance with the specified user information. |
| 64 | * |
| 65 | * This method MUST retain the state of the current instance, and return |
| 66 | * an instance that contains the specified user information. |
| 67 | * |
| 68 | * Password is optional, but the user information MUST include the |
| 69 | * user; a null value for the user is equivalent to removing user |
| 70 | * information. |
| 71 | * |
| 72 | * @param ?string $user |
| 73 | * @param ?string $password |
| 74 | * |
| 75 | * @throws SyntaxError for invalid component or transformations |
| 76 | * that would result in a object in invalid state. |
| 77 | */ |
| 78 | public function withUserInfo(?string $user, ?string $password = null) : self; |
| 79 | } |
| 80 |