Skip to content

Commit db13b33

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 4ed8e99 + 2a42be6 commit db13b33

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
* [Mapping](manipulating-array/mapping.md)
3232
* [Filtering](manipulating-array/filtering.md)
3333
* [Grouping](manipulating-array/grouping.md)
34+
* [Finding](manipulating-array/finding.md)
3435
* [Sorting](manipulating-array/sorting.md)
3536
* [Computations](manipulating-array/computation.md)
3637
* [Flattening](manipulating-array/flattening.md)

docs/manipulating-array/finding.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Finding
2+
3+
## find
4+
5+
#### Definition
6+
7+
```php
8+
Arr::find(array|Iterator|IteratorAggregate $array, callable $condition, string $return = self::FIND_RETURN_VALUE): mixed|mixed[]
9+
```
10+
11+
#### Description
12+
13+
Find array \(or iterable object\) element\(s\) that match specified condition.
14+
15+
#### Modes \(`$return` method argument\)
16+
17+
| Constant name | Description |
18+
| :--- | :--- |
19+
| FIND\_RETURN\_VALUE | Return value of array element matching find condition |
20+
| FIND\_RETURN\_KEY | Return key of array element matching find condition |
21+
| FIND\_RETURN\_ALL | Return array of all values \(preserving original keys\) of array elements matching find condition |
22+
23+
#### Examples
24+
25+
```php
26+
$array = [
27+
'a' => 0,
28+
'b' => 1,
29+
3 => 'c',
30+
4 => 5
31+
];
32+
33+
34+
Arr::find($array, 'boolval') -> 1
35+
Arr::find($array, function ($element) {
36+
return is_string($element);
37+
}) -> 'c'
38+
39+
40+
Arr::find($array, 'boolval', Arr::FIND_RETURN_KEY) -> 'b'
41+
Arr::find($array, function ($element) {
42+
return is_string($element);
43+
}, Arr::FIND_RETURN_KEY) -> 3
44+
45+
46+
Arr::find($array, 'boolval', Arr::FIND_RETURN_ALL) ->
47+
[
48+
'b' => 1,
49+
3 => 'c',
50+
4 => 5
51+
]
52+
53+
Arr::find($array, function ($element) {
54+
return is_string($element);
55+
}, Arr::FIND_RETURN_ALL) ->
56+
[
57+
3 => 'c',
58+
]
59+
60+
Arr::find($array, function ($element) {
61+
return is_number($element);
62+
}, Arr::FIND_RETURN_ALL) ->
63+
[
64+
'a' => 0,
65+
'b' => 1,
66+
4 => 5
67+
]
68+
```
69+

0 commit comments

Comments
 (0)