D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
psa
/
admin
/
plib
/
modules
/
grafana
/
vendor
/
league
/
uri-interfaces
/
Contracts
/
Filename :
AuthorityInterface.php
back
Copy
<?php /** * League.Uri (https://uri.thephpleague.com) * * (c) Ignace Nyamagana Butera <nyamsprod@gmail.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ declare (strict_types=1); namespace PleskGrafana\League\Uri\Contracts; use PleskGrafana\League\Uri\Exceptions\MissingFeature; use PleskGrafana\League\Uri\Exceptions\SyntaxError; use Stringable; interface AuthorityInterface extends UriComponentInterface { /** * Returns the host component of the authority. */ public function getHost() : ?string; /** * Returns the port component of the authority. */ public function getPort() : ?int; /** * Returns the user information component of the authority. */ public function getUserInfo() : ?string; /** * Returns an associative array containing all the Authority components. * * The returned a hashmap similar to PHP's parse_url return value * * @link https://tools.ietf.org/html/rfc3986 * * @return array{user: ?string, pass : ?string, host: ?string, port: ?int} */ public function components() : array; /** * Return an instance with the specified host. * * This method MUST retain the state of the current instance, and return * an instance that contains the specified host. * * A null value provided for the host is equivalent to removing the host * information. * * @throws SyntaxError for invalid component or transformations * that would result in an object in invalid state. * @throws MissingFeature for component or transformations * requiring IDN support when IDN support is not present * or misconfigured. */ public function withHost(Stringable|string|null $host) : self; /** * Return an instance with the specified port. * * This method MUST retain the state of the current instance, and return * an instance that contains the specified port. * * A null value provided for the port is equivalent to removing the port * information. * * @throws SyntaxError for invalid component or transformations * that would result in an object in invalid state. */ public function withPort(?int $port) : self; /** * Return an instance with the specified user information. * * This method MUST retain the state of the current instance, and return * an instance that contains the specified user information. * * Password is optional, but the user information MUST include the * user; a null value for the user is equivalent to removing user * information. * * @throws SyntaxError for invalid component or transformations * that would result in an object in invalid state. */ public function withUserInfo(Stringable|string|null $user, Stringable|string|null $password = null) : self; }