Uri::getHost() - Code Metrics - Inspection of "Merge pull request #31 from open-engine/dev" - open-engine/mika - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( be21dc...6c6323 )

by Akmal
created 2018-10-13 19:08 UTC
Uri::getHost() A

↳ Parent: Uri
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php declare(strict_types=1);

namespace OpenEngine\Mika\Core\Components\Http\Message\Uri;

use Psr\Http\Message\UriInterface;

class Uri implements UriInterface
{
    /**
     * @var array
     */
    private $defaultPorts = [
        'ftp' => 21,
        'http' => 80,
        'https' => 443,
        'imap' => 143,
        'ldap' => 389,
        'nntp' => 119,
        'pop' => 110,
        'telnet' => 23,
    ];

    /**
     * @var string
     */
    private $scheme;

    /**
     * @var string
     */
    private $user;

    /**
     * @var string
     */
    private $host;

    /**
     * @var int|null
     */
    private $port;

    /**
     * @var string
     */
    private $path;

    /**
     * @var string
     */
    private $query;

    /**
     * @var string
     */
    private $password;

    /**
     * @var string
     */
    private $fragment;

    /**
     * Uri constructor.
     * @param null|string $uri
     */
    public function __construct(?string $uri = null)
    {
        if ($uri === null) {
            return;
        }

        $this
            ->setScheme(parse_url($uri, PHP_URL_SCHEME))
            ->setUser(parse_url($uri, PHP_URL_USER))
            ->setPassword(parse_url($uri, PHP_URL_PASS))
            ->setHost(parse_url($uri, PHP_URL_HOST))
            ->setPort(parse_url($uri, PHP_URL_PORT))
            ->setPort(/** @scrutinizer ignore-type */ parse_url($uri, PHP_URL_PORT))
            ->setPath(parse_url($uri, PHP_URL_PATH))
            ->setQuery(parse_url($uri, PHP_URL_QUERY))
            ->setFragment(parse_url($uri, PHP_URL_FRAGMENT));
    }

    /**
     * Retrieve the scheme component of the URI.
     *
     * If no scheme is present, this method MUST return an empty string.
     *
     * The value returned MUST be normalized to lowercase, per RFC 3986
     * Section 3.1.
     *
     * The trailing ":" character is not part of the scheme and MUST NOT be
     * added.
     *
     * @see https://tools.ietf.org/html/rfc3986#section-3.1
     * @return string The URI scheme.
     */
    public function getScheme(): string
    {
        return $this->scheme;
    }

    /**
     * Retrieve the authority component of the URI.
     *
     * If no authority information is present, this method MUST return an empty
     * string.
     *
     * The authority syntax of the URI is:
     *
     * <pre>
     * [user-info@]host[:port]
     * </pre>
     *
     * If the port component is not set or is the standard port for the current
     * scheme, it SHOULD NOT be included.
     *
     * @see https://tools.ietf.org/html/rfc3986#section-3.2
     * @return string The URI authority, in "[user-info@]host[:port]" format.
     */
    public function getAuthority(): string
    {
        $result = '';

        if (!empty($this->getUserInfo())) {
            $result .= $this->getUserInfo() . '@';
        }

        $result .= $this->getHost();
        $result .= $this->getPort() === null ? '' : ':' . $this->getPort();

        return $result;
    }

    /**
     * Retrieve the user information component of the URI.
     *
     * If no user information is present, this method MUST return an empty
     * string.
     *
     * If a user is present in the URI, this will return that value;
     * additionally, if the password is also present, it will be appended to the
     * user value, with a colon (":") separating the values.
     *
     * The trailing "@" character is not part of the user information and MUST
     * NOT be added.
     *
     * @return string The URI user information, in "username[:password]" format.
     */
    public function getUserInfo(): string
    {
        $result = $this->user;

        if (!empty($this->getPassword())) {
            $result .= ':' . $this->getPassword();
        }

        return $result;
    }

    /**
     * Retrieve the host component of the URI.
     *
     * If no host is present, this method MUST return an empty string.
     *
     * The value returned MUST be normalized to lowercase, per RFC 3986
     * Section 3.2.2.
     *
     * @see http://tools.ietf.org/html/rfc3986#section-3.2.2
     * @return string The URI host.
     */
    public function getHost(): string
    {
        return $this->host;
    }

    /**
     * Retrieve the port component of the URI.
     *
     * If a port is present, and it is non-standard for the current scheme,
     * this method MUST return it as an integer. If the port is the standard port
     * used with the current scheme, this method SHOULD return null.
     *
     * If no port is present, and no scheme is present, this method MUST return
     * a null value.
     *
     * If no port is present, but a scheme is present, this method MAY return
     * the standard port for that scheme, but SHOULD return null.
     *
     * @return null|int The URI port.
     */
    public function getPort(): ?int
    {
        if ($this->isDefaultPort()) {
            return null;
        }

        return $this->port;
    }

    /**
     * Retrieve the path component of the URI.
     *
     * The path can either be empty or absolute (starting with a slash) or
     * rootless (not starting with a slash). Implementations MUST support all
     * three syntaxes.
     *
     * Normally, the empty path "" and absolute path "/" are considered equal as
     * defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
     * do this normalization because in contexts with a trimmed base path, e.g.
     * the front controller, this difference becomes significant. It's the task
     * of the user to handle both "" and "/".
     *
     * The value returned MUST be percent-encoded, but MUST NOT double-encode
     * any characters. To determine what characters to encode, please refer to
     * RFC 3986, Sections 2 and 3.3.
     *
     * As an example, if the value should include a slash ("/") not intended as
     * delimiter between path segments, that value MUST be passed in encoded
     * form (e.g., "%2F") to the instance.
     *
     * @see https://tools.ietf.org/html/rfc3986#section-2
     * @see https://tools.ietf.org/html/rfc3986#section-3.3
     * @return string The URI path.
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Retrieve the query string of the URI.
     *
     * If no query string is present, this method MUST return an empty string.
     *
     * The leading "?" character is not part of the query and MUST NOT be
     * added.
     *
     * The value returned MUST be percent-encoded, but MUST NOT double-encode
     * any characters. To determine what characters to encode, please refer to
     * RFC 3986, Sections 2 and 3.4.
     *
     * As an example, if a value in a key/value pair of the query string should
     * include an ampersand ("&") not intended as a delimiter between values,
     * that value MUST be passed in encoded form (e.g., "%26") to the instance.
     *
     * @see https://tools.ietf.org/html/rfc3986#section-2
     * @see https://tools.ietf.org/html/rfc3986#section-3.4
     * @return string The URI query string.
     */
    public function getQuery(): string
    {
        return $this->query;
    }

    /**
     * Retrieve the fragment component of the URI.
     *
     * If no fragment is present, this method MUST return an empty string.
     *
     * The leading "#" character is not part of the fragment and MUST NOT be
     * added.
     *
     * The value returned MUST be percent-encoded, but MUST NOT double-encode
     * any characters. To determine what characters to encode, please refer to
     * RFC 3986, Sections 2 and 3.5.
     *
     * @see https://tools.ietf.org/html/rfc3986#section-2
     * @see https://tools.ietf.org/html/rfc3986#section-3.5
     * @return string The URI fragment.
     */
    public function getFragment(): string
    {
        return $this->fragment;
    }

    /**
     * Return an instance with the specified scheme.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified scheme.
     *
     * Implementations MUST support the schemes "http" and "https" case
     * insensitively, and MAY accommodate other schemes if required.
     *
     * An empty scheme is equivalent to removing the scheme.
     *
     * @param string $scheme The scheme to use with the new instance.
     * @return static A new instance with the specified scheme.
     * @throws \InvalidArgumentException for invalid or unsupported schemes.
     */
    public function withScheme($scheme)
    {
        $clone = clone $this;
        return $clone->setScheme($scheme);
    }

    /**
     * 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; an empty string for the user is equivalent to removing user
     * information.
     *
     * @param string $user The user name to use for authority.
     * @param null|string $password The password associated with $user.
     * @return static A new instance with the specified user information.
     */
    public function withUserInfo($user, $password = null)
    {
        $clone = clone $this;
        return $clone->setUser($user)->setPassword($password);
    }

    /**
     * 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.
     *
     * An empty host value is equivalent to removing the host.
     *
     * @param string $host The hostname to use with the new instance.
     * @return static A new instance with the specified host.
     * @throws \InvalidArgumentException for invalid hostnames.
     */
    public function withHost($host)
    {
        $clone = clone $this;
        return $clone->setHost($host);
    }

    /**
     * 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.
     *
     * Implementations MUST raise an exception for ports outside the
     * established TCP and UDP port ranges.
     *
     * A null value provided for the port is equivalent to removing the port
     * information.
     *
     * @param null|int $port The port to use with the new instance; a null value
     *     removes the port information.
     * @return static A new instance with the specified port.
     * @throws \InvalidArgumentException for invalid ports.
     */
    public function withPort($port)
    {
        $clone = clone $this;
        return $clone->setPort($port);
    }

    /**
     * Return an instance with the specified path.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified path.
     *
     * The path can either be empty or absolute (starting with a slash) or
     * rootless (not starting with a slash). Implementations MUST support all
     * three syntaxes.
     *
     * If the path is intended to be domain-relative rather than path relative then
     * it must begin with a slash ("/"). Paths not starting with a slash ("/")
     * are assumed to be relative to some base path known to the application or
     * consumer.
     *
     * Users can provide both encoded and decoded path characters.
     * Implementations ensure the correct encoding as outlined in getPath().
     *
     * @param string $path The path to use with the new instance.
     * @return static A new instance with the specified path.
     * @throws \InvalidArgumentException for invalid paths.
     */
    public function withPath($path)
    {
        $clone = clone $this;
        return $clone->setPath($path);
    }

    /**
     * Return an instance with the specified query string.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified query string.
     *
     * Users can provide both encoded and decoded query characters.
     * Implementations ensure the correct encoding as outlined in getQuery().
     *
     * An empty query string value is equivalent to removing the query string.
     *
     * @param string $query The query string to use with the new instance.
     * @return static A new instance with the specified query string.
     * @throws \InvalidArgumentException for invalid query strings.
     */
    public function withQuery($query)
    {
        $clone = clone $this;
        return $clone->setQuery($query);
    }

    /**
     * Return an instance with the specified URI fragment.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified URI fragment.
     *
     * Users can provide both encoded and decoded fragment characters.
     * Implementations ensure the correct encoding as outlined in getFragment().
     *
     * An empty fragment value is equivalent to removing the fragment.
     *
     * @param string $fragment The fragment to use with the new instance.
     * @return static A new instance with the specified fragment.
     */
    public function withFragment($fragment)
    {
        $clone = clone $this;
        return $clone->setFragment($fragment);
    }

    /**
     * Return the string representation as a URI reference.
     *
     * Depending on which components of the URI are present, the resulting
     * string is either a full URI or relative reference according to RFC 3986,
     * Section 4.1. The method concatenates the various components of the URI,
     * using the appropriate delimiters:
     *
     * - If a scheme is present, it MUST be suffixed by ":".
     * - If an authority is present, it MUST be prefixed by "//".
     * - The path can be concatenated without delimiters. But there are two
     *   cases where the path has to be adjusted to make the URI reference
     *   valid as PHP does not allow to throw an exception in __toString():
     *     - If the path is rootless and an authority is present, the path MUST
     *       be prefixed by "/".
     *     - If the path is starting with more than one "/" and no authority is
     *       present, the starting slashes MUST be reduced to one.
     * - If a query is present, it MUST be prefixed by "?".
     * - If a fragment is present, it MUST be prefixed by "#".
     *
     * @see http://tools.ietf.org/html/rfc3986#section-4.1
     * @return string
     */
    public function __toString()
    {
        return
            $this->getSchemeWithColon() .
            $this->getAuthorityWithDoubleSlash() .
            $this->getPathWithSlash() .
            $this->getQueryWithMark() .
            $this->getFragmentWithSharp();
    }

    /**
     * Returns empty string if scheme is not set or ":scheme"
     *
     * @return string
     */
    private function getSchemeWithColon(): string
    {
        return empty($this->getScheme()) ? '' : $this->getScheme() . ':';
    }

    /**
     * Returns empty string if authority is not set or "//authority"
     *
     * @return string
     */
    private function getAuthorityWithDoubleSlash(): string
    {
        return empty($this->getAuthority()) ? '' : '//' . $this->getAuthority();
    }

    /**
     * Returns empty string if path is not set or "/path"
     *
     * @return string
     */
    private function getPathWithSlash(): string
    {
        $path = '';

        if (!empty($this->getPath())) {
            $path .= strpos($this->getPath(), '/') === 0 ? '' : '/';
            $path .= $this->getPath();
        }

        return $path;
    }

    /**
     * Returns empty string if query is not set or "?query"
     *
     * @return string
     */
    private function getQueryWithMark(): string
    {
        return empty($this->getQuery()) ? '' : '?' . $this->getQuery();
    }

    /**
     * Returns empty string if fragment is not set or "#fragment"
     *
     * @return string
     */
    private function getFragmentWithSharp(): string
    {
        return empty($this->getFragment()) ? '' : '#' . $this->getFragment();
    }

    /**
     * @return bool
     */
    private function isDefaultPort(): bool
    {
        if ($this->port === null) {
            return true;
        }

        return
            isset($this->defaultPorts[$this->getScheme()]) &&
            $this->port === $this->defaultPorts[$this->getScheme()];
    }

    /**
     * @return string
     */
    private function getPassword(): string
    {
        return $this->password;
    }

    /**
     * @param string $scheme
     * @return Uri
     */
    private function setScheme(?string $scheme): Uri
    {
        if ($scheme !== null) {
            $this->scheme = strtolower($scheme);
        }

        return $this;
    }

    /**
     * @param string $user
     * @return Uri
     */
    private function setUser(?string $user): Uri
    {
        $this->user = $user ?? '';
        return $this;
    }

    /**
     * @param string $host
     * @return Uri
     */
    private function setHost(?string $host): Uri
    {
        $this->host = $host ?? '';
        return $this;
    }

    /**
     * @param int|null $port
     * @return Uri
     */
    private function setPort(?int $port): Uri
    {
        $this->port = $port;
        return $this;
    }

    /**
     * @param string $path
     * @return Uri
     */
    private function setPath(?string $path): Uri
    {
        $this->path = $path ?? '';
        return $this;
    }

    /**
     * @param string $query
     * @return Uri
     */
    private function setQuery(?string $query): Uri
    {
        $this->query = $query ?? '';
        return $this;
    }

    /**
     * @param null|string $password
     * @return Uri
     */
    private function setPassword(?string $password): Uri
    {
        $this->password = $password ?? '';
        return $this;
    }

    /**
     * @param null|string $fragment
     * @return Uri
     */
    private function setFragment(?string $fragment): Uri
    {
        $this->fragment = $fragment ?? '';
        return $this;
    }
}

open-engine / mika

Push — master ( be21dc...6c6323 )

Uri::getHost() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
