Uri::getScheme() - Code Metrics - Inspection of "repository update" - linna/http-message - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — b0.1.0 ( 56c359...717fd1 )

by Sebastian

created 2019-01-13 18:13 UTC

Uri::getScheme() A

↳ Parent: Uri

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

/**
 * Linna Psr7.
 *
 * @author Sebastian Rapetti <[email protected]>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Http\Message;

use InvalidArgumentException;
use Psr\Http\Message\UriInterface;

/**
 * Psr7 Uri Implementation.
 */
class Uri implements UriInterface
{
    use UriTrait;

    /**
     * @var array Standard schemes.
     */
    protected $standardSchemes = [
        'http'  => 80,
        'https' => 443,
    ];

    /**
     * @var array Url description.
     */
    protected $url = [
        'scheme'   => '',
        'host'     => '',
        'port'     => 0,
        'user'     => '',
        'pass'     => '',
        'path'     => '',
        'query'    => '',
        'fragment' => '',
    ];

    /**
     * Constructor.
     *
     * @param string $uri
     *
     * @throws InvalidArgumentException
     */
    public function __construct(string $uri)
    {
        if (($parsedUrl = parse_url($uri)) === false) {
            throw new InvalidArgumentException(__CLASS__.': Bad URI provided for '.__METHOD__);
        }

        $this->url = array_merge($this->url, $parsedUrl);
    }

    /**
     * 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 strtolower($this->url['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
    {
        if ($this->url['host'] === '') {
            return '';
        }

        $authority = $this->url['host'];

        if ($this->url['user'] !== '') {
            $authority = $this->getUserInfo().'@'.$authority;
        }

        if ($this->url['port'] !== 0) {
            $authority .= ':'.$this->url['port'];
        }

        return $authority;
    }

    /**
     * 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
    {
        $user = $this->url['user'];

        if ($this->url['pass'] !== '' && $this->url['pass'] !== null) {
            $user .= ':'.$this->url['pass'];
        }

        return ($user !== '') ? $user : '';
    }

    /**
     * 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 strtolower($this->url['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 zero value.
     *
     * If no port is present, but a scheme is present, this method MAY return
     * the standard port for that scheme, but SHOULD return zero.
     *
     * @return int The URI port.
     */
    public function getPort(): int
    {
        $scheme = $this->url['scheme'];
        $port = $this->url['port'];

        $standardPort = $this->checkStandardPortForCurretScheme($scheme, $port, $this->standardSchemes);
        $standardScheme = array_key_exists($scheme, $this->standardSchemes);

        //scheme present and port standard - return 0
        //scheme present and port non standard - return port
        if ($standardPort && $standardScheme) {
            return $this->getPortForStandardScheme($standardPort, $port);
        }

        //scheme present and standard, port non present - return port
        //scheme non standard, port present - return port
        return $this->getNonStandardPort($port, $scheme, $standardScheme, $this->standardSchemes);
    }

    /**
     * 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->url['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->url['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->url['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(string $scheme): UriInterface
    {
        if (!array_key_exists($scheme, $this->standardSchemes)) {
            throw new InvalidArgumentException(__CLASS__.': Invalid or unsupported scheme provided for '.__METHOD__);
        }

        $new = clone $this;
        $new->url['scheme'] = $scheme;

        return $new;
    }

    /**
     * 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 string $password The password associated with $user.
     *
     * @return static A new instance with the specified user information.
     */
    public function withUserInfo(string $user, string $password = ''): UriInterface
    {
        $new = clone $this;
        $new->url['user'] = $user;
        $new->url['pass'] = $password;

        return $new;
    }

    /**
     * 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(string $host): UriInterface
    {
        if (filter_var($host, \FILTER_VALIDATE_DOMAIN, \FILTER_FLAG_HOSTNAME) === false) {
            throw new InvalidArgumentException(__CLASS__.': Invalid host provided for '.__METHOD__);
        }

        $new = clone $this;
        $new->url['host'] = $host;

        return $new;
    }

    /**
     * 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 zero value provided for the port is equivalent to removing the port
     * information.
     *
     * @param int $port The port to use with the new instance; a zero value
     *                  removes the port information.
     *
     * @return static A new instance with the specified port.
     *
     * @throws InvalidArgumentException for invalid ports.
     */
    public function withPort(int $port = 0): UriInterface
    {
        if ($port !== 0 && ($port < 1 || $port > 65535)) {
            throw new InvalidArgumentException(__CLASS__.': Invalid port ('.$port.') number provided for '.__METHOD__);
        }

        $new = clone $this;
        $new->url['port'] = $port;

        return $new;
    }

    /**
     * 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(string $path): UriInterface
    {
        if (strpos($path, '?') !== false) {
            throw new InvalidArgumentException(__CLASS__.': Invalid path provided; must not contain a query string');
        }

        if (strpos($path, '#') !== false) {
            throw new InvalidArgumentException(__CLASS__.': Invalid path provided; must not contain a URI fragment');
        }

        $new = clone $this;
        $new->url['path'] = $path;

        return $new;
    }

    /**
     * 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(string $query): UriInterface
    {
        if (strpos($query, '#') !== false) {
            throw new InvalidArgumentException(__CLASS__.': Query string must not include a URI fragment');
        }

        $new = clone $this;
        $new->url['query'] = (strpos($query, '?') !== false) ? substr($query, 1) : $query;

        return $new;
    }

    /**
     * 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(string $fragment): UriInterface
    {
        $new = clone $this;
        $new->url['fragment'] = (strpos($fragment, '#') !== false) ? substr($fragment, 1) : $fragment;

        return $new;
    }

    /**
     * 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(): string
    {
        $scheme = $this->url['scheme'];
        $query = $this->url['query'];
        $fragment = $this->url['fragment'];

        return $this->createUriString(
            ($scheme !== '') ? $scheme.'://' : '',
               $this->getAuthority(),
               $this->getPath(),
               ($query !== '') ? '?'.$query : '',
               ($fragment !== '') ? '#'.$fragment : ''
        );
    }
}


1		<?php
2
3		/**
4		* Linna Psr7.
5		*
6		* @author Sebastian Rapetti <[email protected]>
7		* @copyright (c) 2018, Sebastian Rapetti
8		* @license http://opensource.org/licenses/MIT MIT License
9		*/
10		declare(strict_types=1);
11
12		namespace Linna\Http\Message;
13
14		use InvalidArgumentException;
15		use Psr\Http\Message\UriInterface;
16
17		/**
18		* Psr7 Uri Implementation.
19		*/
20		class Uri implements UriInterface
21		{
22		use UriTrait;
23
24		/**
25		* @var array Standard schemes.
26		*/
27		protected $standardSchemes = [
28		'http' => 80,
29		'https' => 443,
30		];
31
32		/**
33		* @var array Url description.
34		*/
35		protected $url = [
36		'scheme' => '',
37		'host' => '',
38		'port' => 0,
39		'user' => '',
40		'pass' => '',
41		'path' => '',
42		'query' => '',
43		'fragment' => '',
44		];
45
46		/**
47		* Constructor.
48		*
49		* @param string $uri
50		*
51		* @throws InvalidArgumentException
52		*/
53	82	public function __construct(string $uri)
54		{
55	82	if (($parsedUrl = parse_url($uri)) === false) {
56	1	throw new InvalidArgumentException(__CLASS__.': Bad URI provided for '.__METHOD__);
57		}
58
59	81	$this->url = array_merge($this->url, $parsedUrl);
60	81	}
61
62		/**
63		* Retrieve the scheme component of the URI.
64		*
65		* If no scheme is present, this method MUST return an empty string.
66		*
67		* The value returned MUST be normalized to lowercase, per RFC 3986
68		* Section 3.1.
69		*
70		* The trailing ":" character is not part of the scheme and MUST NOT be
71		* added.
72		*
73		* @see https://tools.ietf.org/html/rfc3986#section-3.1
74		*
75		* @return string The URI scheme.
76		*/
77	2	public function getScheme(): string
78		{
79	2	return strtolower($this->url['scheme']);
80		}
81
82		/**
83		* Retrieve the authority component of the URI.
84		*
85		* If no authority information is present, this method MUST return an empty
86		* string.
87		*
88		* The authority syntax of the URI is:
89		*
90		* <pre>
91		* [user-info@]host[:port]
92		* </pre>
93		*
94		* If the port component is not set or is the standard port for the current
95		* scheme, it SHOULD NOT be included.
96		*
97		* @see https://tools.ietf.org/html/rfc3986#section-3.2
98		*
99		* @return string The URI authority, in "[user-info@]host[:port]" format.
100		*/
101	26	public function getAuthority(): string
102		{
103	26	if ($this->url['host'] === '') {
104	5	return '';
105		}
106
107	21	$authority = $this->url['host'];
108
109	21	if ($this->url['user'] !== '') {
110	18	$authority = $this->getUserInfo().'@'.$authority;
111		}
112
113	21	if ($this->url['port'] !== 0) {
114	16	$authority .= ':'.$this->url['port'];
115		}
116
117	21	return $authority;
118		}
119
120		/**
121		* Retrieve the user information component of the URI.
122		*
123		* If no user information is present, this method MUST return an empty
124		* string.
125		*
126		* If a user is present in the URI, this will return that value;
127		* additionally, if the password is also present, it will be appended to the
128		* user value, with a colon (":") separating the values.
129		*
130		* The trailing "@" character is not part of the user information and MUST
131		* NOT be added.
132		*
133		* @return string The URI user information, in "username[:password]" format.
134		*/
135	21	public function getUserInfo(): string
136		{
137	21	$user = $this->url['user'];
138
139	21	if ($this->url['pass'] !== '' && $this->url['pass'] !== null) {
140	17	$user .= ':'.$this->url['pass'];
141		}
142
143	21	return ($user !== '') ? $user : '';
144		}
145
146		/**
147		* Retrieve the host component of the URI.
148		*
149		* If no host is present, this method MUST return an empty string.
150		*
151		* The value returned MUST be normalized to lowercase, per RFC 3986
152		* Section 3.2.2.
153		*
154		* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
155		*
156		* @return string The URI host.
157		*/
158	2	public function getHost(): string
159		{
160	2	return strtolower($this->url['host']);
161		}
162
163		/**
164		* Retrieve the port component of the URI.
165		*
166		* If a port is present, and it is non-standard for the current scheme,
167		* this method MUST return it as an integer. If the port is the standard port
168		* used with the current scheme, this method SHOULD return null.
169		*
170		* If no port is present, and no scheme is present, this method MUST return
171		* a zero value.
172		*
173		* If no port is present, but a scheme is present, this method MAY return
174		* the standard port for that scheme, but SHOULD return zero.
175		*
176		* @return int The URI port.
177		*/
178	8	public function getPort(): int
179		{
180	8	$scheme = $this->url['scheme'];
181	8	$port = $this->url['port'];
182
183	8	$standardPort = $this->checkStandardPortForCurretScheme($scheme, $port, $this->standardSchemes);
184	8	$standardScheme = array_key_exists($scheme, $this->standardSchemes);
185
186		//scheme present and port standard - return 0
187		//scheme present and port non standard - return port
188	8	if ($standardPort && $standardScheme) {
189	1	return $this->getPortForStandardScheme($standardPort, $port);
190		}
191
192		//scheme present and standard, port non present - return port
193		//scheme non standard, port present - return port
194	7	return $this->getNonStandardPort($port, $scheme, $standardScheme, $this->standardSchemes);
195		}
196
197		/**
198		* Retrieve the path component of the URI.
199		*
200		* The path can either be empty or absolute (starting with a slash) or
201		* rootless (not starting with a slash). Implementations MUST support all
202		* three syntaxes.
203		*
204		* Normally, the empty path "" and absolute path "/" are considered equal as
205		* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
206		* do this normalization because in contexts with a trimmed base path, e.g.
207		* the front controller, this difference becomes significant. It's the task
208		* of the user to handle both "" and "/".
209		*
210		* The value returned MUST be percent-encoded, but MUST NOT double-encode
211		* any characters. To determine what characters to encode, please refer to
212		* RFC 3986, Sections 2 and 3.3.
213		*
214		* As an example, if the value should include a slash ("/") not intended as
215		* delimiter between path segments, that value MUST be passed in encoded
216		* form (e.g., "%2F") to the instance.
217		*
218		* @see https://tools.ietf.org/html/rfc3986#section-2
219		* @see https://tools.ietf.org/html/rfc3986#section-3.3
220		*
221		* @return string The URI path.
222		*/
223	20	public function getPath(): string
224		{
225	20	return $this->url['path'];
226		}
227
228		/**
229		* Retrieve the query string of the URI.
230		*
231		* If no query string is present, this method MUST return an empty string.
232		*
233		* The leading "?" character is not part of the query and MUST NOT be
234		* added.
235		*
236		* The value returned MUST be percent-encoded, but MUST NOT double-encode
237		* any characters. To determine what characters to encode, please refer to
238		* RFC 3986, Sections 2 and 3.4.
239		*
240		* As an example, if a value in a key/value pair of the query string should
241		* include an ampersand ("&") not intended as a delimiter between values,
242		* that value MUST be passed in encoded form (e.g., "%26") to the instance.
243		*
244		* @see https://tools.ietf.org/html/rfc3986#section-2
245		* @see https://tools.ietf.org/html/rfc3986#section-3.4
246		*
247		* @return string The URI query string.
248		*/
249	4	public function getQuery(): string
250		{
251	4	return $this->url['query'];
252		}
253
254		/**
255		* Retrieve the fragment component of the URI.
256		*
257		* If no fragment is present, this method MUST return an empty string.
258		*
259		* The leading "#" character is not part of the fragment and MUST NOT be
260		* added.
261		*
262		* The value returned MUST be percent-encoded, but MUST NOT double-encode
263		* any characters. To determine what characters to encode, please refer to
264		* RFC 3986, Sections 2 and 3.5.
265		*
266		* @see https://tools.ietf.org/html/rfc3986#section-2
267		* @see https://tools.ietf.org/html/rfc3986#section-3.5
268		*
269		* @return string The URI fragment.
270		*/
271	4	public function getFragment(): string
272		{
273	4	return $this->url['fragment'];
274		}
275
276		/**
277		* Return an instance with the specified scheme.
278		*
279		* This method MUST retain the state of the current instance, and return
280		* an instance that contains the specified scheme.
281		*
282		* Implementations MUST support the schemes "http" and "https" case
283		* insensitively, and MAY accommodate other schemes if required.
284		*
285		* An empty scheme is equivalent to removing the scheme.
286		*
287		* @param string $scheme The scheme to use with the new instance.
288		*
289		* @return static A new instance with the specified scheme.
290		*
291		* @throws InvalidArgumentException for invalid or unsupported schemes.
292		*/
293	2	public function withScheme(string $scheme): UriInterface
294		{
295	2	if (!array_key_exists($scheme, $this->standardSchemes)) {
296	1	throw new InvalidArgumentException(__CLASS__.': Invalid or unsupported scheme provided for '.__METHOD__);
297		}
298
299	1	$new = clone $this;
300	1	$new->url['scheme'] = $scheme;
301
302	1	return $new;
303		}
304
305		/**
306		* Return an instance with the specified user information.
307		*
308		* This method MUST retain the state of the current instance, and return
309		* an instance that contains the specified user information.
310		*
311		* Password is optional, but the user information MUST include the
312		* user; an empty string for the user is equivalent to removing user
313		* information.
314		*
315		* @param string $user The user name to use for authority.
316		* @param string $password The password associated with $user.
317		*
318		* @return static A new instance with the specified user information.
319		*/
320	3	public function withUserInfo(string $user, string $password = ''): UriInterface
321		{
322	3	$new = clone $this;
323	3	$new->url['user'] = $user;
324	3	$new->url['pass'] = $password;
325
326	3	return $new;
327		}
328
329		/**
330		* Return an instance with the specified host.
331		*
332		* This method MUST retain the state of the current instance, and return
333		* an instance that contains the specified host.
334		*
335		* An empty host value is equivalent to removing the host.
336		*
337		* @param string $host The hostname to use with the new instance.
338		*
339		* @return static A new instance with the specified host.
340		*
341		* @throws InvalidArgumentException for invalid hostnames.
342		*/
343	2	public function withHost(string $host): UriInterface
344		{
345	2	if (filter_var($host, \FILTER_VALIDATE_DOMAIN, \FILTER_FLAG_HOSTNAME) === false) {
346	1	throw new InvalidArgumentException(__CLASS__.': Invalid host provided for '.__METHOD__);
347		}
348
349	1	$new = clone $this;
350	1	$new->url['host'] = $host;
351
352	1	return $new;
353		}
354
355		/**
356		* Return an instance with the specified port.
357		*
358		* This method MUST retain the state of the current instance, and return
359		* an instance that contains the specified port.
360		*
361		* Implementations MUST raise an exception for ports outside the
362		* established TCP and UDP port ranges.
363		*
364		* A zero value provided for the port is equivalent to removing the port
365		* information.
366		*
367		* @param int $port The port to use with the new instance; a zero value
368		* removes the port information.
369		*
370		* @return static A new instance with the specified port.
371		*
372		* @throws InvalidArgumentException for invalid ports.
373		*/
374	4	public function withPort(int $port = 0): UriInterface
375		{
376	4	if ($port !== 0 && ($port < 1 \|\| $port > 65535)) {
377	2	throw new InvalidArgumentException(__CLASS__.': Invalid port ('.$port.') number provided for '.__METHOD__);
378		}
379
380	2	$new = clone $this;
381	2	$new->url['port'] = $port;
382
383	2	return $new;
384		}
385
386		/**
387		* Return an instance with the specified path.
388		*
389		* This method MUST retain the state of the current instance, and return
390		* an instance that contains the specified path.
391		*
392		* The path can either be empty or absolute (starting with a slash) or
393		* rootless (not starting with a slash). Implementations MUST support all
394		* three syntaxes.
395		*
396		* If the path is intended to be domain-relative rather than path relative then
397		* it must begin with a slash ("/"). Paths not starting with a slash ("/")
398		* are assumed to be relative to some base path known to the application or
399		* consumer.
400		*
401		* Users can provide both encoded and decoded path characters.
402		* Implementations ensure the correct encoding as outlined in getPath().
403		*
404		* @param string $path The path to use with the new instance.
405		*
406		* @return static A new instance with the specified path.
407		*
408		* @throws InvalidArgumentException for invalid paths.
409		*/
410	3	public function withPath(string $path): UriInterface
411		{
412	3	if (strpos($path, '?') !== false) {
413	1	throw new InvalidArgumentException(__CLASS__.': Invalid path provided; must not contain a query string');
414		}
415
416	2	if (strpos($path, '#') !== false) {
417	1	throw new InvalidArgumentException(__CLASS__.': Invalid path provided; must not contain a URI fragment');
418		}
419
420	1	$new = clone $this;
421	1	$new->url['path'] = $path;
422
423	1	return $new;
424		}
425
426		/**
427		* Return an instance with the specified query string.
428		*
429		* This method MUST retain the state of the current instance, and return
430		* an instance that contains the specified query string.
431		*
432		* Users can provide both encoded and decoded query characters.
433		* Implementations ensure the correct encoding as outlined in getQuery().
434		*
435		* An empty query string value is equivalent to removing the query string.
436		*
437		* @param string $query The query string to use with the new instance.
438		*
439		* @return static A new instance with the specified query string.
440		*
441		* @throws InvalidArgumentException for invalid query strings.
442		*/
443	4	public function withQuery(string $query): UriInterface
444		{
445	4	if (strpos($query, '#') !== false) {
446	1	throw new InvalidArgumentException(__CLASS__.': Query string must not include a URI fragment');
447		}
448
449	3	$new = clone $this;
450	3	$new->url['query'] = (strpos($query, '?') !== false) ? substr($query, 1) : $query;
451
452	3	return $new;
453		}
454
455		/**
456		* Return an instance with the specified URI fragment.
457		*
458		* This method MUST retain the state of the current instance, and return
459		* an instance that contains the specified URI fragment.
460		*
461		* Users can provide both encoded and decoded fragment characters.
462		* Implementations ensure the correct encoding as outlined in getFragment().
463		*
464		* An empty fragment value is equivalent to removing the fragment.
465		*
466		* @param string $fragment The fragment to use with the new instance.
467		*
468		* @return static A new instance with the specified fragment.
469		*/
470	3	public function withFragment(string $fragment): UriInterface
471		{
472	3	$new = clone $this;
473	3	$new->url['fragment'] = (strpos($fragment, '#') !== false) ? substr($fragment, 1) : $fragment;
474
475	3	return $new;
476		}
477
478		/**
479		* Return the string representation as a URI reference.
480		*
481		* Depending on which components of the URI are present, the resulting
482		* string is either a full URI or relative reference according to RFC 3986,
483		* Section 4.1. The method concatenates the various components of the URI,
484		* using the appropriate delimiters:
485		*
486		* - If a scheme is present, it MUST be suffixed by ":".
487		* - If an authority is present, it MUST be prefixed by "//".
488		* - The path can be concatenated without delimiters. But there are two
489		* cases where the path has to be adjusted to make the URI reference
490		* valid as PHP does not allow to throw an exception in __toString():
491		* - If the path is rootless and an authority is present, the path MUST
492		* be prefixed by "/".
493		* - If the path is starting with more than one "/" and no authority is
494		* present, the starting slashes MUST be reduced to one.
495		* - If a query is present, it MUST be prefixed by "?".
496		* - If a fragment is present, it MUST be prefixed by "#".
497		*
498		* @see http://tools.ietf.org/html/rfc3986#section-4.1
499		*
500		* @return string
501		*/
502	19	public function __toString(): string
503		{
504	19	$scheme = $this->url['scheme'];
505	19	$query = $this->url['query'];
506	19	$fragment = $this->url['fragment'];
507
508	19	return $this->createUriString(
509	19	($scheme !== '') ? $scheme.'://' : '',
510	19	$this->getAuthority(),
511	19	$this->getPath(),
512	19	($query !== '') ? '?'.$query : '',
513	19	($fragment !== '') ? '#'.$fragment : ''
514		);
515		}
516		}
517

linna / http-message

Push — b0.1.0 ( 56c359...717fd1 )

Uri::getScheme() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like