QueryInterface.php — Independent Analytics – WordPress Analytics Plugin 1.18

independent-analytics / vendor / league / uri-interfaces / src / Contracts / QueryInterface.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

QueryInterface.php

206 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	/**
15	* @extends \IteratorAggregate<array{0:string, 1:string\|null}>
16	*/
17	interface QueryInterface extends \Countable, \IteratorAggregate, UriComponentInterface
18	{
19	/**
20	* Returns the query separator.
21	*/
22	public function getSeparator() : string;
23	/**
24	* Returns the number of key/value pairs present in the object.
25	*/
26	public function count() : int;
27	/**
28	* Returns an iterator allowing to go through all key/value pairs contained in this object.
29	*
30	* The pair is represented as an array where the first value is the pair key
31	* and the second value the pair value.
32	*
33	* The key of each pair is a string
34	* The value of each pair is a scalar or the null value
35	*
36	* @return \Iterator<int, array{0:string, 1:string\|null}>
37	*/
38	public function getIterator() : \Iterator;
39	/**
40	* Returns an iterator allowing to go through all key/value pairs contained in this object.
41	*
42	* The return type is as a Iterator where its offset is the pair key and its value the pair value.
43	*
44	* The key of each pair is a string
45	* The value of each pair is a scalar or the null value
46	*
47	* @return iterable<string, string\|null>
48	*/
49	public function pairs() : iterable;
50	/**
51	* Tells whether a pair with a specific name exists.
52	*
53	* @see https://url.spec.whatwg.org/#dom-urlsearchparams-has
54	*/
55	public function has(string $key) : bool;
56	/**
57	* Returns the first value associated to the given pair name.
58	*
59	* If no value is found null is returned
60	*
61	* @see https://url.spec.whatwg.org/#dom-urlsearchparams-get
62	*/
63	public function get(string $key) : ?string;
64	/**
65	* Returns all the values associated to the given pair name as an array or all
66	* the instance pairs.
67	*
68	* If no value is found an empty array is returned
69	*
70	* @see https://url.spec.whatwg.org/#dom-urlsearchparams-getall
71	*
72	* @return array<int, string\|null>
73	*/
74	public function getAll(string $key) : array;
75	/**
76	* Returns the store PHP variables as elements of an array.
77	*
78	* The result is similar as PHP parse_str when used with its
79	* second argument with the difference that variable names are
80	* not mangled.
81	*
82	* If a key is submitted it will returns the value attached to it or null
83	*
84	* @see http://php.net/parse_str
85	* @see https://wiki.php.net/rfc/on_demand_name_mangling
86	*
87	* @param ?string $key
88	* @return mixed the collection of stored PHP variables or the empty array if no input is given,
89	* the single value of a stored PHP variable or null if the variable is not present in the collection
90	*/
91	public function params(?string $key = null);
92	/**
93	* Returns the RFC1738 encoded query.
94	*/
95	public function toRFC1738() : ?string;
96	/**
97	* Returns the RFC3986 encoded query.
98	*
99	* @see ::getContent
100	*/
101	public function toRFC3986() : ?string;
102	/**
103	* Returns an instance with a different separator.
104	*
105	* This method MUST retain the state of the current instance, and return
106	* an instance that contains the query component with a different separator
107	*/
108	public function withSeparator(string $separator) : self;
109	/**
110	* Sorts the query string by offset, maintaining offset to data correlations.
111	*
112	* This method MUST retain the state of the current instance, and return
113	* an instance that contains the modified query
114	*
115	* @see https://url.spec.whatwg.org/#dom-urlsearchparams-sort
116	*/
117	public function sort() : self;
118	/**
119	* Returns an instance without duplicate key/value pair.
120	*
121	* This method MUST retain the state of the current instance, and return
122	* an instance that contains the query component normalized by removing
123	* duplicate pairs whose key/value are the same.
124	*/
125	public function withoutDuplicates() : self;
126	/**
127	* Returns an instance without empty key/value where the value is the null value.
128	*
129	* This method MUST retain the state of the current instance, and return
130	* an instance that contains the query component normalized by removing
131	* empty pairs.
132	*
133	* A pair is considered empty if its value is equal to the null value
134	*/
135	public function withoutEmptyPairs() : self;
136	/**
137	* Returns an instance where numeric indices associated to PHP's array like key are removed.
138	*
139	* This method MUST retain the state of the current instance, and return
140	* an instance that contains the query component normalized so that numeric indexes
141	* are removed from the pair key value.
142	*
143	* ie.: toto[3]=bar[3]&foo=bar becomes toto[]=bar[3]&foo=bar
144	*/
145	public function withoutNumericIndices() : self;
146	/**
147	* Returns an instance with the a new key/value pair added to it.
148	*
149	* This method MUST retain the state of the current instance, and return
150	* an instance that contains the modified query
151	*
152	* If the pair already exists the value will replace the existing value.
153	*
154	* @see https://url.spec.whatwg.org/#dom-urlsearchparams-set
155	*
156	* @param ?string $value
157	*/
158	public function withPair(string $key, ?string $value) : self;
159	/**
160	* Returns an instance with the new pairs set to it.
161	*
162	* This method MUST retain the state of the current instance, and return
163	* an instance that contains the modified query
164	*
165	* @see ::withPair
166	*/
167	public function merge(string $query) : self;
168	/**
169	* Returns an instance without the specified keys.
170	*
171	* This method MUST retain the state of the current instance, and return
172	* an instance that contains the modified component
173	*
174	* @param string ...$keys
175	*/
176	public function withoutPair(string ...$keys) : self;
177	/**
178	* Returns a new instance with a specified key/value pair appended as a new pair.
179	*
180	* This method MUST retain the state of the current instance, and return
181	* an instance that contains the modified query
182	*
183	* @param ?string $value
184	*/
185	public function appendTo(string $key, ?string $value) : self;
186	/**
187	* Returns an instance with the new pairs appended to it.
188	*
189	* This method MUST retain the state of the current instance, and return
190	* an instance that contains the modified query
191	*
192	* If the pair already exists the value will be added to it.
193	*/
194	public function append(string $query) : self;
195	/**
196	* Returns an instance without the specified params.
197	*
198	* This method MUST retain the state of the current instance, and return
199	* an instance that contains the modified component without PHP's value.
200	* PHP's mangled is not taken into account.
201	*
202	* @param string ...$keys
203	*/
204	public function withoutParam(string ...$keys) : self;
205	}
206