Uri::withUserInfo() - Code Metrics - Inspection of "Added test and implementation for ServerRequest@wi..." - patoui/router - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06492c...c2e867 )

by Patrique

created 2019-11-22 13:37 UTC

Uri::withUserInfo() A

↳ Parent: Uri

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

declare(strict_types=1);

namespace Patoui\Router;

use Psr\Http\Message\UriInterface;

class Uri implements UriInterface
{
    /** @var string */
    private $uri;

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

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

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

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

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

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

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

    public function __construct(string $uri)
    {
        $parsedUri = parse_url($uri);

        if ($parsedUri === false) {
            throw new \InvalidArgumentException("Invalid URI: {$uri}");
        }

        $this->scheme = isset($parsedUri['scheme']) ? $parsedUri['scheme'] : '';
        $this->host = isset($parsedUri['host']) ? $parsedUri['host'] : '';
        $this->port = isset($parsedUri['port']) ? $parsedUri['port'] : '';
        $this->user = isset($parsedUri['user']) ? $parsedUri['user'] : '';
        $this->path = isset($parsedUri['path']) ? $parsedUri['path'] : '';
        $this->query = isset($parsedUri['query']) ? $parsedUri['query'] : '';
        $this->fragment = isset($parsedUri['fragment']) ? $parsedUri['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()
    {
        // TODO: Implement getScheme() method.
    }

    /**
     * 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()
    {
        // TODO: Implement getAuthority() method.
    }

    /**
     * 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()
    {
        // TODO: Implement getUserInfo() method.
    }

    /**
     * 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()
    {
        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()
    {
        // TODO: Implement getPort() method.
    }

    /**
     * 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()
    {
        // TODO: Implement getPath() method.
    }

    /**
     * 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()
    {
        // TODO: Implement getQuery() method.
    }

    /**
     * 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()
    {
        // TODO: Implement getFragment() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withScheme() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withUserInfo() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withHost() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withPort() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withPath() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withQuery() method.
    }

    /**
     * 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)
    {
        // TODO: Implement withFragment() method.
    }

    /**
     * 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()
    {
        // TODO: Implement __toString() method.
    }
}


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

patoui / router

GitHub Access Token became invalid

Push — master ( 06492c...c2e867 )

Uri::withUserInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like