8000 [12.x] Typed getters for Arr helper (docs) (#10354) · laravel/docs@b81e485 · GitHub
[go: up one dir, main page]
Skip to content

Commit b81e485

Browse files
tibbsataylorotwell
tibbsa
and
taylorotwell
authored
[12.x] Typed getters for Arr helper (docs) (#10354)
* add docs for typed Arr getters * add disambiguation to new HTML anchors (avoid potential future confusion) * add default value examples * formatting --------- Co-authored-by: Taylor Otwell <taylor@laravel.com>
1 parent 5c9e034 commit b81e485

File tree

1 file changed

+101
-0
lines changed

1 file changed

+101
-0
lines changed

‎helpers.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
4040

4141
[Arr::accessible](#method-array-accessible)
4242
[Arr::add](#method-array-add)
43+
[Arr::array](#method-array-array)
44+
[Arr::boolean](#method-array-boolean)
4345
[Arr::collapse](#method-array-collapse)
4446
[Arr::crossJoin](#method-array-crossjoin)
4547
[Arr::divide](#method-array-divide)
@@ -48,10 +50,12 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
4850
[Arr::exists](#method-array-exists)
4951
[Arr::first](#method-array-first)
5052
[Arr::flatten](#method-array-flatten)
53+
[Arr::float](#method-array-float)
5154
[Arr::forget](#method-array-forget)
5255
[Arr::get](#method-array-get)
5356
[Arr::has](#method-array-has)
5457
[Arr::hasAny](#method-array-hasany)
58+
[Arr::integer](#method-array-integer)
5559
[Arr::isAssoc](#method-array-isassoc)
5660
[Arr::isList](#method-array-islist)
5761
[Arr::join](#method-array-join)
@@ -76,6 +80,7 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
7680
[Arr::sort](#method-array-sort)
7781
[Arr::sortDesc](#method-array-sort-desc)
7882
[Arr::sortRecursive](#method-array-sort-recursive)
83+
[Arr::string](#method-array-string)
7984
[Arr::take](#method-array-take)
8085
[Arr::toCssClasses](#method-array-to-css-classes)
8186
[Arr::toCssStyles](#method-array-to-css-styles)
@@ -261,6 +266,45 @@ $array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
261266
// ['name' => 'Desk', 'price' => 100]
262267
```
263268

269+
<a name="method-array-array"></a>
270+
#### `Arr::array()` {.collection-method}
271+
272+
The `Arr::array` method retrieves a value from a deeply nested array using "dot" notation (just as [Arr::get()](#method-array-get) does), but throws an `InvalidArgumentException` if the requested value is not an `array`:
273+
274+
```
275+
use Illuminate\Support\Arr;
276+
277+
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
278+
279+
$value = Arr::array($array, 'languages');
280+
281+
// ['PHP', 'Ruby']
282+
283+
$value = Arr::array($array, 'name');
284+
285+
// throws InvalidArgumentException
286+
```
287+
288+
<a name="method-array-boolean"></a>
289+
#### `Arr::boolean()` {.collection-method}
290+
291+
The `Arr::boolean` method retrieves a value from a deeply nested array using "dot" notation (just as [Arr::get()](#method-array-get) does), but throws an `InvalidArgumentException` if the requested value is not a `boolean`:
292+
293+
```
294+
use Illuminate\Support\Arr;
295+
296+
$array = ['name' => 'Joe', 'available' => true];
297+
298+
$value = Arr::boolean($array, 'available');
299+
300+
// true
301+
302+
$value = Arr::boolean($array, 'name');
303+
304+
// throws InvalidArgumentException
305+
```
306+
307+
264308
<a name="method-array-collapse"></a>
265309
#### `Arr::collapse()` {.collection-method}
266310

@@ -413,6 +457,25 @@ $flattened = Arr::flatten($array);
413457
// ['Joe', 'PHP', 'Ruby']
414458
```
415459

460+
<a name="method-array-float"></a>
461+
#### `Arr::float()` {.collection-method}
462+
463+
The `Arr::float` method retrieves a value from a deeply nested array using "dot" notation (just as [Arr::get()](#method-array-get) does), but throws an `InvalidArgumentException` if the requested value is not a `float< 8000 span class="pl-s">`:
464+
465+
```
466+
use Illuminate\Support\Arr;
467+
468+
$array = ['name' => 'Joe', 'balance' => 123.45];
469+
470+
$value = Arr::float($array, 'balance');
471+
472+
// 123.45
473+
474+
$value = Arr::float($array, 'name');
475+
476+
// throws InvalidArgumentException
477+
```
478+
416479
<a name="method-array-forget"></a>
417480
#### `Arr::forget()` {.collection-method}
418481

@@ -495,6 +558,25 @@ $contains = Arr::hasAny($array, ['category', 'product.discount']);
495558
// false
496559
```
497560

561+
<a name="method-array-integer"></a>
562+
#### `Arr::integer()` {.collection-method}
563+
564+
The `Arr::integer` method retrieves a value from a deeply nested array using "dot" notation (just as [Arr::get()](#method-array-get) does), but throws an `InvalidArgumentException` if the requested value is not an `int`:
565+
566+
```
567+
use Illuminate\Support\Arr;
568+
569+
$array = ['name' => 'Joe', 'age' => 42];
570+
571+
$value = Arr::integer($array, 'age');
572+
573+
// 42
574+
575+
$value = Arr::integer($array, 'name');
576+
577+
// throws InvalidArgumentException
578+
```
579+
498580
<a name="method-array-isassoc"></a>
499581
#### `Arr::isAssoc()` {.collection-method}
500582

@@ -1048,6 +1130,25 @@ If you would like the results sorted in descending order, you may use the `Arr::
10481130
$sorted = Arr::sortRecursiveDesc($array);
10491131
```
10501132

1133+
<a name="method-array-string"></a>
1134+
#### `Arr::string()` {.collection-method}
1135+
1136+
The `Arr::string` method retrieves a value from a deeply nested array using "dot" notation (just as [Arr::get()](#method-array-get) does), but throws an `InvalidArgumentException` if the requested value is not a `string`:
1137+
1138+
```
1139+
use Illuminate\Support\Arr;
1140+
1141+
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
1142+
1143+
$value = Arr::string($array, 'name');
1144+
1145+
// Joe
1146+
1147+
$value = Arr::string($array, 'languages');
1148+
1149+
// throws InvalidArgumentException
1150+
```
1151+
10511152
<a name="method-array-take"></a>
10521153
#### `Arr::take()` {.collection-method}
10531154

0 commit comments

Comments
 (0)
0