UriInterface.php — Independent Analytics – WordPress Analytics Plugin 1.18

independent-analytics / vendor / league / uri-interfaces / src / Contracts / UriInterface.php

independent-analytics / vendor / league / uri-interfaces / src / Contracts Last commit date

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

UriInterface.php

274 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 UriInterface extends \JsonSerializable
17	{
18	/**
19	* Returns the string representation as a URI reference.
20	*
21	* @see http://tools.ietf.org/html/rfc3986#section-4.1
22	*/
23	public function __toString() : string;
24	/**
25	* Returns the string representation as a URI reference.
26	*
27	* @see http://tools.ietf.org/html/rfc3986#section-4.1
28	* @see ::__toString
29	*/
30	public function jsonSerialize() : string;
31	/**
32	* Retrieve the scheme component of the URI.
33	*
34	* If no scheme is present, this method MUST return a null value.
35	*
36	* The value returned MUST be normalized to lowercase, per RFC 3986
37	* Section 3.1.
38	*
39	* The trailing ":" character is not part of the scheme and MUST NOT be
40	* added.
41	*
42	* @see https://tools.ietf.org/html/rfc3986#section-3.1
43	*/
44	public function getScheme() : ?string;
45	/**
46	* Retrieve the authority component of the URI.
47	*
48	* If no scheme is present, this method MUST return a null value.
49	*
50	* If the port component is not set or is the standard port for the current
51	* scheme, it SHOULD NOT be included.
52	*
53	* @see https://tools.ietf.org/html/rfc3986#section-3.2
54	*/
55	public function getAuthority() : ?string;
56	/**
57	* Retrieve the user information component of the URI.
58	*
59	* If no scheme is present, this method MUST return a null value.
60	*
61	* If a user is present in the URI, this will return that value;
62	* additionally, if the password is also present, it will be appended to the
63	* user value, with a colon (":") separating the values.
64	*
65	* The trailing "@" character is not part of the user information and MUST
66	* NOT be added.
67	*/
68	public function getUserInfo() : ?string;
69	/**
70	* Retrieve the host component of the URI.
71	*
72	* If no host is present this method MUST return a null value.
73	*
74	* The value returned MUST be normalized to lowercase, per RFC 3986
75	* Section 3.2.2.
76	*
77	* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
78	*/
79	public function getHost() : ?string;
80	/**
81	* Retrieve the port component of the URI.
82	*
83	* If a port is present, and it is non-standard for the current scheme,
84	* this method MUST return it as an integer. If the port is the standard port
85	* used with the current scheme, this method SHOULD return null.
86	*
87	* If no port is present, and no scheme is present, this method MUST return
88	* a null value.
89	*
90	* If no port is present, but a scheme is present, this method MAY return
91	* the standard port for that scheme, but SHOULD return null.
92	*/
93	public function getPort() : ?int;
94	/**
95	* Retrieve the path component of the URI.
96	*
97	* The path can either be empty or absolute (starting with a slash) or
98	* rootless (not starting with a slash). Implementations MUST support all
99	* three syntaxes.
100	*
101	* Normally, the empty path "" and absolute path "/" are considered equal as
102	* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
103	* do this normalization because in contexts with a trimmed base path, e.g.
104	* the front controller, this difference becomes significant. It's the task
105	* of the user to handle both "" and "/".
106	*
107	* The value returned MUST be percent-encoded, but MUST NOT double-encode
108	* any characters. To determine what characters to encode, please refer to
109	* RFC 3986, Sections 2 and 3.3.
110	*
111	* As an example, if the value should include a slash ("/") not intended as
112	* delimiter between path segments, that value MUST be passed in encoded
113	* form (e.g., "%2F") to the instance.
114	*
115	* @see https://tools.ietf.org/html/rfc3986#section-2
116	* @see https://tools.ietf.org/html/rfc3986#section-3.3
117	*/
118	public function getPath() : string;
119	/**
120	* Retrieve the query string of the URI.
121	*
122	* If no host is present this method MUST return a null value.
123	*
124	* The leading "?" character is not part of the query and MUST NOT be
125	* added.
126	*
127	* The value returned MUST be percent-encoded, but MUST NOT double-encode
128	* any characters. To determine what characters to encode, please refer to
129	* RFC 3986, Sections 2 and 3.4.
130	*
131	* As an example, if a value in a key/value pair of the query string should
132	* include an ampersand ("&") not intended as a delimiter between values,
133	* that value MUST be passed in encoded form (e.g., "%26") to the instance.
134	*
135	* @see https://tools.ietf.org/html/rfc3986#section-2
136	* @see https://tools.ietf.org/html/rfc3986#section-3.4
137	*/
138	public function getQuery() : ?string;
139	/**
140	* Retrieve the fragment component of the URI.
141	*
142	* If no host is present this method MUST return a null value.
143	*
144	* The leading "#" character is not part of the fragment and MUST NOT be
145	* added.
146	*
147	* The value returned MUST be percent-encoded, but MUST NOT double-encode
148	* any characters. To determine what characters to encode, please refer to
149	* RFC 3986, Sections 2 and 3.5.
150	*
151	* @see https://tools.ietf.org/html/rfc3986#section-2
152	* @see https://tools.ietf.org/html/rfc3986#section-3.5
153	*/
154	public function getFragment() : ?string;
155	/**
156	* Return an instance with the specified scheme.
157	*
158	* This method MUST retain the state of the current instance, and return
159	* an instance that contains the specified scheme.
160	*
161	* A null value provided for the scheme is equivalent to removing the scheme
162	* information.
163	*
164	* @param ?string $scheme
165	*
166	* @throws SyntaxError for invalid component or transformations
167	* that would result in a object in invalid state.
168	*/
169	public function withScheme(?string $scheme) : self;
170	/**
171	* Return an instance with the specified user information.
172	*
173	* This method MUST retain the state of the current instance, and return
174	* an instance that contains the specified user information.
175	*
176	* Password is optional, but the user information MUST include the
177	* user; a null value for the user is equivalent to removing user
178	* information.
179	*
180	* @param ?string $user
181	* @param ?string $password
182	*
183	* @throws SyntaxError for invalid component or transformations
184	* that would result in a object in invalid state.
185	*/
186	public function withUserInfo(?string $user, ?string $password = null) : self;
187	/**
188	* Return an instance with the specified host.
189	*
190	* This method MUST retain the state of the current instance, and return
191	* an instance that contains the specified host.
192	*
193	* A null value provided for the host is equivalent to removing the host
194	* information.
195	*
196	* @param ?string $host
197	*
198	* @throws SyntaxError for invalid component or transformations
199	* that would result in a object in invalid state.
200	* @throws IdnSupportMissing for component or transformations
201	* requiring IDN support when IDN support is not present
202	* or misconfigured.
203	*/
204	public function withHost(?string $host) : self;
205	/**
206	* Return an instance with the specified port.
207	*
208	* This method MUST retain the state of the current instance, and return
209	* an instance that contains the specified port.
210	*
211	* A null value provided for the port is equivalent to removing the port
212	* information.
213	*
214	* @param ?int $port
215	*
216	* @throws SyntaxError for invalid component or transformations
217	* that would result in a object in invalid state.
218	*/
219	public function withPort(?int $port) : self;
220	/**
221	* Return an instance with the specified path.
222	*
223	* This method MUST retain the state of the current instance, and return
224	* an instance that contains the specified path.
225	*
226	* The path can either be empty or absolute (starting with a slash) or
227	* rootless (not starting with a slash). Implementations MUST support all
228	* three syntaxes.
229	*
230	* Users can provide both encoded and decoded path characters.
231	* Implementations ensure the correct encoding as outlined in getPath().
232	*
233	* @throws SyntaxError for invalid component or transformations
234	* that would result in a object in invalid state.
235	*/
236	public function withPath(string $path) : self;
237	/**
238	* Return an instance with the specified query string.
239	*
240	* This method MUST retain the state of the current instance, and return
241	* an instance that contains the specified query string.
242	*
243	* Users can provide both encoded and decoded query characters.
244	* Implementations ensure the correct encoding as outlined in getQuery().
245	*
246	* A null value provided for the query is equivalent to removing the query
247	* information.
248	*
249	* @param ?string $query
250	*
251	* @throws SyntaxError for invalid component or transformations
252	* that would result in a object in invalid state.
253	*/
254	public function withQuery(?string $query) : self;
255	/**
256	* Return an instance with the specified URI fragment.
257	*
258	* This method MUST retain the state of the current instance, and return
259	* an instance that contains the specified URI fragment.
260	*
261	* Users can provide both encoded and decoded fragment characters.
262	* Implementations ensure the correct encoding as outlined in getFragment().
263	*
264	* A null value provided for the fragment is equivalent to removing the fragment
265	* information.
266	*
267	* @param ?string $fragment
268	*
269	* @throws SyntaxError for invalid component or transformations
270	* that would result in a object in invalid state.
271	*/
272	public function withFragment(?string $fragment) : self;
273	}
274