Skip to content

Commit b68fe95

Browse files
committed
tidy up doc
1 parent b52a815 commit b68fe95

File tree

1 file changed

+53
-37
lines changed

1 file changed

+53
-37
lines changed

README.md

Lines changed: 53 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -39,87 +39,93 @@ Usage
3939
It verify that data has filtered found item at least once.
4040

4141
```php
42+
use ArrayLookup\AtLeast;
43+
4244
$data = [1, 2, 3];
4345
$filter = static fn($datum): bool => $datum === 1;
4446

45-
var_dump(\ArrayLookup\AtLeast::once($data, $filter)) // true
47+
var_dump(AtLeast::once($data, $filter)) // true
4648

4749
$data = [1, 2, 3];
4850
$filter = static fn($datum): bool => $datum === 4;
4951

50-
var_dump(\ArrayLookup\AtLeast::once($data, $filter)) // false
52+
var_dump(AtLeast::once($data, $filter)) // false
5153

5254
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
5355

5456
$data = [1, 2, 3];
5557
$filter = static fn($datum, $key): bool => $datum === 1 && $key >= 0;
5658

57-
var_dump(\ArrayLookup\AtLeast::once($data, $filter)) // true
59+
var_dump(AtLeast::once($data, $filter)) // true
5860

5961
$data = [1, 2, 3];
6062
$filter = static fn($datum, $key): bool => $datum === 4 && $key >= 0;
6163

62-
var_dump(\ArrayLookup\AtLeast::once($data, $filter)) // false
64+
var_dump(AtLeast::once($data, $filter)) // false
6365
```
6466

6567
*2. `AtLeast::twice()`*
6668

6769
It verify that data has filtered found items at least twice.
6870

6971
```php
72+
use ArrayLookup\AtLeast;
73+
7074
$data = [1, "1", 3];
7175
$filter = static fn($datum): bool => $datum == 1;
7276

73-
var_dump(\ArrayLookup\AtLeast::twice($data, $filter)) // true
77+
var_dump(AtLeast::twice($data, $filter)) // true
7478

7579
$data = [1, "1", 3];
7680
$filter = static fn($datum): bool => $datum === 1;
7781

78-
var_dump(\ArrayLookup\AtLeast::twice($data, $filter)) // false
82+
var_dump(AtLeast::twice($data, $filter)) // false
7983

8084
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
8185

8286
$data = [1, "1", 3];
8387
$filter = static fn($datum, $key): bool => $datum == 1 && $key >= 0;
8488

85-
var_dump(\ArrayLookup\AtLeast::twice($data, $filter)) // true
89+
var_dump(AtLeast::twice($data, $filter)) // true
8690

8791
$data = [1, "1", 3];
8892
$filter = static fn($datum, $key): bool => $datum === 1 && $key >= 0;
8993

90-
var_dump(\ArrayLookup\AtLeast::twice($data, $filter)) // false
94+
var_dump(AtLeast::twice($data, $filter)) // false
9195
```
9296

9397
*3. `AtLeast::times()`*
9498

9599
It verify that data has filtered found items at least times passed in 3rd arg.
96100

97101
```php
102+
use ArrayLookup\AtLeast;
103+
98104
$data = [false, null, 0];
99105
$filter = static fn($datum): bool => ! $datum;
100106
$times = 3;
101107

102-
var_dump(\ArrayLookup\AtLeast::times($data, $filter, $times)) // true
108+
var_dump(AtLeast::times($data, $filter, $times)) // true
103109

104110
$data = [1, null, 0];
105111
$filter = static fn($datum): bool => ! $datum;
106112
$times = 3;
107113

108-
var_dump(\ArrayLookup\AtLeast::times($data, $filter, $times)) // false
114+
var_dump(AtLeast::times($data, $filter, $times)) // false
109115

110116
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
111117

112118
$data = [false, null, 0];
113119
$filter = static fn($datum, $key): bool => ! $datum && $key >= 0;
114120
$times = 3;
115121

116-
var_dump(\ArrayLookup\AtLeast::times($data, $filter, $times)) // true
122+
var_dump(AtLeast::times($data, $filter, $times)) // true
117123

118124
$data = [1, null, 0];
119125
$filter = static fn($datum, $key): bool => ! $datum && $key >= 0;
120126
$times = 3;
121127

122-
var_dump(\ArrayLookup\AtLeast::times($data, $filter, $times)) // false
128+
var_dump(AtLeast::times($data, $filter, $times)) // false
123129
```
124130

125131
**B. Only**
@@ -130,91 +136,97 @@ var_dump(\ArrayLookup\AtLeast::times($data, $filter, $times)) // false
130136
It verify that data has filtered found item exactly found only once.
131137

132138
```php
139+
use ArrayLookup\Only;
140+
133141
$data = [1, 2, 3];
134142
$filter = static fn($datum): bool => $datum === 1;
135143

136-
var_dump(\ArrayLookup\Only::once($data, $filter)) // true
144+
var_dump(Only::once($data, $filter)) // true
137145

138146

139147
$data = [1, "1", 3]
140148
$filter = static fn($datum): bool => $datum == 1;
141149

142-
var_dump(\ArrayLookup\Only::once($data, $filter)) // false
150+
var_dump(Only::once($data, $filter)) // false
143151

144152
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
145153

146154
$data = [1, 2, 3];
147155
$filter = static fn($datum, $key): bool => $datum === 1 && $key >= 0;
148156

149-
var_dump(\ArrayLookup\Only::once($data, $filter)) // true
157+
var_dump(Only::once($data, $filter)) // true
150158

151159

152160
$data = [1, "1", 3]
153161
$filter = static fn($datum, $key): bool => $datum == 1 && $key >= 0;
154162

155-
var_dump(\ArrayLookup\Only::once($data, $filter)) // false
163+
var_dump(Only::once($data, $filter)) // false
156164
```
157165

158166
*2. `Only::twice()`*
159167

160168
It verify that data has filtered found items exactly found only twice.
161169

162170
```php
171+
use ArrayLookup\Only;
172+
163173
$data = [1, "1", 3];
164174
$filter = static fn($datum): bool => $datum == 1;
165175

166-
var_dump(\ArrayLookup\Only::twice($data, $filter)) // true
176+
var_dump(Only::twice($data, $filter)) // true
167177

168178
$data = [true, 1, new stdClass()];
169179
$filter = static fn($datum): bool => (bool) $datum;
170180

171-
var_dump(\ArrayLookup\Only::twice($data, $filter)) // false
181+
var_dump(Only::twice($data, $filter)) // false
172182

173183
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
174184

175185
$data = [1, "1", 3];
176186
$filter = static fn($datum, $key): bool => $datum == 1 && $key >= 0;
177187

178-
var_dump(\ArrayLookup\Only::twice($data, $filter)) // true
188+
var_dump(Only::twice($data, $filter)) // true
179189

180190
$data = [true, 1, new stdClass()];
181191
$filter = static fn($datum, $key): bool => (bool) $datum && $key >= 0;
182192

183-
var_dump(\ArrayLookup\Only::twice($data, $filter)) // false
193+
var_dump(Only::twice($data, $filter)) // false
184194
```
185195

186196
*3. `Only::times()`*
187197

188198
It verify that data has filtered found items exactly found only same with times passed in 3rd arg.
189199

190200
```php
201+
use ArrayLookup\Only;
202+
191203
$data = [false, null, 1];
192204
$filter = static fn($datum): bool => ! $datum;
193205
$times = 2;
194206

195-
var_dump(\ArrayLookup\Only::times($data, $filter, $times)) // true
207+
var_dump(Only::times($data, $filter, $times)) // true
196208

197209

198210
$data = [false, null, 0];
199211
$filter = static fn($datum): bool => ! $datum;
200212
$times = 2;
201213

202-
var_dump(\ArrayLookup\Only::times($data, $filter, $times)) // false
214+
var_dump(Only::times($data, $filter, $times)) // false
203215

204216
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
205217

206218
$data = [false, null, 1];
207219
$filter = static fn($datum, $key): bool => ! $datum && $key >= 0;
208220
$times = 2;
209221

210-
var_dump(\ArrayLookup\Only::times($data, $filter, $times)) // true
222+
var_dump(Only::times($data, $filter, $times)) // true
211223

212224

213225
$data = [false, null, 0];
214226
$filter = static fn($datum, $key): bool => ! $datum && $key >= 0;
215227
$times = 2;
216228

217-
var_dump(\ArrayLookup\Only::times($data, $filter, $times)) // false
229+
var_dump(Only::times($data, $filter, $times)) // false
218230
```
219231

220232
**3. Finder**
@@ -225,80 +237,84 @@ var_dump(\ArrayLookup\Only::times($data, $filter, $times)) // false
225237
It search first data filtered found.
226238

227239
```php
240+
use ArrayLookup\Finder;
241+
228242
$data = [1, 2, 3];
229243
$filter = static fn($datum): bool => $datum === 1;
230244

231-
var_dump(\ArrayLookup\Finder::first($data, $filter)) // 1
245+
var_dump(Finder::first($data, $filter)) // 1
232246

233247
$filter = static fn($datum): bool => $datum == 1000;
234-
var_dump(\ArrayLookup\Finder::first($data, $filter)) // null
248+
var_dump(Finder::first($data, $filter)) // null
235249

236250
// RETURN the Array key, pass true to 3rd arg
237251

238252
$filter = static fn($datum): bool => $datum === 1;
239253

240-
var_dump(\ArrayLookup\Finder::first($data, $filter, true)) // 0
254+
var_dump(Finder::first($data, $filter, true)) // 0
241255

242256
$filter = static fn($datum): bool => $datum == 1000;
243-
var_dump(\ArrayLookup\Finder::first($data, $filter, true)) // null
257+
var_dump(Finder::first($data, $filter, true)) // null
244258

245259
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
246260

247261
$filter = static fn($datum, $key): bool => $datum === 1 && $key >= 0;
248262

249-
var_dump(\ArrayLookup\Finder::first($data, $filter)) // 1
263+
var_dump(Finder::first($data, $filter)) // 1
250264

251265
$filter = static fn($datum, $key): bool => $datum == 1000 && $key >= 0;
252-
var_dump(\ArrayLookup\Finder::first($data, $filter)) // null
266+
var_dump(Finder::first($data, $filter)) // null
253267
```
254268

255269
*2. `Finder::last()`*
256270

257271
It search last data filtered found.
258272

259273
```php
274+
use ArrayLookup\Finder;
275+
260276
$data = [6, 7, 8, 9];
261-
var_dump(\ArrayLookup\Finder::last(
277+
var_dump(Finder::last(
262278
$data,
263279
static fn ($datum): bool => $datum > 5
264280
)); // 9
265281

266-
var_dump(\ArrayLookup\Finder::last(
282+
var_dump(Finder::last(
267283
$data,
268284
static fn ($datum): bool => $datum < 5
269285
)); // null
270286

271287
// RETURN the Array key, pass true to 3rd arg
272288

273289
// ... with PRESERVE original key
274-
var_dump(\ArrayLookup\Finder::last(
290+
var_dump(Finder::last(
275291
$data,
276292
static fn ($datum): bool => $datum > 5,
277293
true
278294
)); // 3
279295

280296
// ... with RESORT key, first key is last record
281-
var_dump(\ArrayLookup\Finder::last(
297+
var_dump(Finder::last(
282298
$data,
283299
static fn ($datum): bool => $datum > 5,
284300
true,
285301
false
286302
)); // 0
287303

288-
var_dump(\ArrayLookup\Finder::last(
304+
var_dump(Finder::last(
289305
$data,
290306
static fn ($datum): bool => $datum < 5,
291307
true
292308
)); // null
293309

294310
// WITH key array included, pass $key variable as 2nd arg on filter to be used in filter
295311

296-
var_dump(\ArrayLookup\Finder::last(
312+
var_dump(Finder::last(
297313
$data,
298314
static fn ($datum, $key): bool => $datum > 5 && $key >= 0
299315
)); // 9
300316

301-
var_dump(\ArrayLookup\Finder::last(
317+
var_dump(Finder::last(
302318
$data,
303319
static fn ($datum, $key): bool => $datum < 5 && $key >= 0
304320
)); // null

0 commit comments

Comments
 (0)