Helpers

簡介
可用方法
其他工具
- 效能評測
- 日期
- 延遲函式
- Lottery
- Pipeline
- Sleep
- Timebox

簡介

Laravel 包含各種全域「helper」PHP 函式。這些函式許多都是框架本身所使用；然而，如果您覺得方便，可以自由地在自己的應用程式中使用它們。

可用方法

陣列 & 物件

雜項

陣列 & 物件

`Arr::accessible()`

Arr::accessible 方法判斷給定的值是否為陣列可存取

 1use Illuminate\Support\Arr;
 2use Illuminate\Support\Collection;
 3 
 4$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
 5 
 6// true
 7 
 8$isAccessible = Arr::accessible(new Collection);
 9 
10// true
11 
12$isAccessible = Arr::accessible('abc');
13 
14// false
15 
16$isAccessible = Arr::accessible(new stdClass);
17 
18// false

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;

$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);

// true

$isAccessible = Arr::accessible(new Collection);

// true

$isAccessible = Arr::accessible('abc');

// false

$isAccessible = Arr::accessible(new stdClass);

// false

`Arr::add()`

如果給定的鍵在陣列中尚不存在或設定為 null，則 Arr::add 方法會將給定的鍵 / 值對新增到陣列中

1use Illuminate\Support\Arr;
2 
3$array = Arr::add(['name' => 'Desk'], 'price', 100);
4 
5// ['name' => 'Desk', 'price' => 100]
6 
7$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
8 
9// ['name' => 'Desk', 'price' => 100]

use Illuminate\Support\Arr;

$array = Arr::add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

`Arr::collapse()`

Arr::collapse 方法將陣列的陣列摺疊成單一陣列

1use Illuminate\Support\Arr;
2 
3$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
4 
5// [1, 2, 3, 4, 5, 6, 7, 8, 9]

use Illuminate\Support\Arr;

$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

`Arr::crossJoin()`

Arr::crossJoin 方法交叉聯結給定的陣列，傳回包含所有可能排列的笛卡爾積

 1use Illuminate\Support\Arr;
 2 
 3$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
 4 
 5/*
 6    [
 7        [1, 'a'],
 8        [1, 'b'],
 9        [2, 'a'],
10        [2, 'b'],
11    ]
12*/
13 
14$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
15 
16/*
17    [
18        [1, 'a', 'I'],
19        [1, 'a', 'II'],
20        [1, 'b', 'I'],
21        [1, 'b', 'II'],
22        [2, 'a', 'I'],
23        [2, 'a', 'II'],
24        [2, 'b', 'I'],
25        [2, 'b', 'II'],
26    ]
27*/

use Illuminate\Support\Arr;

$matrix = Arr::crossJoin([1, 2], ['a', 'b']);

/*
    [
        [1, 'a'],
        [1, 'b'],
        [2, 'a'],
        [2, 'b'],
    ]
*/

$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);

/*
    [
        [1, 'a', 'I'],
        [1, 'a', 'II'],
        [1, 'b', 'I'],
        [1, 'b', 'II'],
        [2, 'a', 'I'],
        [2, 'a', 'II'],
        [2, 'b', 'I'],
        [2, 'b', 'II'],
    ]
*/

`Arr::divide()`

Arr::divide 方法傳回兩個陣列：一個包含鍵，另一個包含給定陣列的值

1use Illuminate\Support\Arr;
2 
3[$keys, $values] = Arr::divide(['name' => 'Desk']);
4 
5// $keys: ['name']
6 
7// $values: ['Desk']

use Illuminate\Support\Arr;

[$keys, $values] = Arr::divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

Arr::dot 方法將多維陣列扁平化為單一層級陣列，該陣列使用「點」表示法來表示深度

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$flattened = Arr::dot($array);
6 
7// ['products.desk.price' => 100]

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$flattened = Arr::dot($array);

// ['products.desk.price' => 100]

`Arr::except()`

Arr::except 方法從陣列中移除給定的鍵 / 值對

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$filtered = Arr::except($array, ['price']);
6 
7// ['name' => 'Desk']

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$filtered = Arr::except($array, ['price']);

// ['name' => 'Desk']

`Arr::exists()`

Arr::exists 方法檢查給定的鍵是否存在於提供的陣列中

 1use Illuminate\Support\Arr;
 2 
 3$array = ['name' => 'John Doe', 'age' => 17];
 4 
 5$exists = Arr::exists($array, 'name');
 6 
 7// true
 8 
 9$exists = Arr::exists($array, 'salary');
10 
11// false

use Illuminate\Support\Arr;

$array = ['name' => 'John Doe', 'age' => 17];

$exists = Arr::exists($array, 'name');

// true

$exists = Arr::exists($array, 'salary');

// false

`Arr::first()`

Arr::first 方法傳回通過給定真值測試的陣列的第一個元素

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300];
4 
5$first = Arr::first($array, function (int $value, int $key) {
6    return $value >= 150;
7});
8 
9// 200

use Illuminate\Support\Arr;

$array = [100, 200, 300];

$first = Arr::first($array, function (int $value, int $key) {
    return $value >= 150;
});

// 200

也可以將預設值作為方法的第三個參數傳遞。如果沒有值通過真值測試，則會傳回此值

1use Illuminate\Support\Arr;
2 
3$first = Arr::first($array, $callback, $default);

use Illuminate\Support\Arr;

$first = Arr::first($array, $callback, $default);

`Arr::flatten()`

Arr::flatten 方法將多維陣列扁平化為單一層級陣列

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$flattened = Arr::flatten($array);
6 
7// ['Joe', 'PHP', 'Ruby']

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$flattened = Arr::flatten($array);

// ['Joe', 'PHP', 'Ruby']

`Arr::forget()`

Arr::forget 方法使用「點」表示法從深度巢狀陣列中移除給定的鍵 / 值對

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::forget($array, 'products.desk');
6 
7// ['products' => []]

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::forget($array, 'products.desk');

// ['products' => []]

`Arr::get()`

Arr::get 方法使用「點」表示法從深度巢狀陣列中檢索值

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$price = Arr::get($array, 'products.desk.price');
6 
7// 100

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$price = Arr::get($array, 'products.desk.price');

// 100

Arr::get 方法也接受預設值，如果在陣列中找不到指定的鍵，則會傳回該值

1use Illuminate\Support\Arr;
2 
3$discount = Arr::get($array, 'products.desk.discount', 0);
4 
5// 0

use Illuminate\Support\Arr;

$discount = Arr::get($array, 'products.desk.discount', 0);

// 0

`Arr::has()`

Arr::has 方法檢查給定的項目或多個項目是否使用「點」表示法存在於陣列中

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::has($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::has($array, ['product.price', 'product.discount']);
10 
11// false

use Illuminate\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::has($array, 'product.name');

// true

$contains = Arr::has($array, ['product.price', 'product.discount']);

// false

`Arr::hasAny()`

Arr::hasAny 方法檢查給定集合中的任何項目是否使用「點」表示法存在於陣列中

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::hasAny($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
10 
11// true
12 
13$contains = Arr::hasAny($array, ['category', 'product.discount']);
14 
15// false

use Illuminate\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::hasAny($array, 'product.name');

// true

$contains = Arr::hasAny($array, ['product.name', 'product.discount']);

// true

$contains = Arr::hasAny($array, ['category', 'product.discount']);

// false

`Arr::isAssoc()`

如果給定的陣列是關聯陣列，則 Arr::isAssoc 方法傳回 true。如果陣列沒有從零開始的循序數字鍵，則視為「關聯陣列」

1use Illuminate\Support\Arr;
2 
3$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
4 
5// true
6 
7$isAssoc = Arr::isAssoc([1, 2, 3]);
8 
9// false

use Illuminate\Support\Arr;

$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);

// true

$isAssoc = Arr::isAssoc([1, 2, 3]);

// false

`Arr::isList()`

如果給定陣列的鍵是從零開始的循序整數，則 Arr::isList 方法傳回 true

1use Illuminate\Support\Arr;
2 
3$isList = Arr::isList(['foo', 'bar', 'baz']);
4 
5// true
6 
7$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
8 
9// false

use Illuminate\Support\Arr;

$isList = Arr::isList(['foo', 'bar', 'baz']);

// true

$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);

// false

`Arr::join()`

Arr::join 方法使用字串聯結陣列元素。使用此方法的第二個引數，您也可以為陣列的最後一個元素指定聯結字串

 1use Illuminate\Support\Arr;
 2 
 3$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
 4 
 5$joined = Arr::join($array, ', ');
 6 
 7// Tailwind, Alpine, Laravel, Livewire
 8 
 9$joined = Arr::join($array, ', ', ' and ');
10 
11// Tailwind, Alpine, Laravel and Livewire

use Illuminate\Support\Arr;

$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];

$joined = Arr::join($array, ', ');

// Tailwind, Alpine, Laravel, Livewire

$joined = Arr::join($array, ', ', ' and ');

// Tailwind, Alpine, Laravel and Livewire

`Arr::keyBy()`

Arr::keyBy 方法依給定的鍵為陣列建立索引鍵。如果多個項目具有相同的鍵，則只有最後一個項目會出現在新陣列中

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['product_id' => 'prod-100', 'name' => 'Desk'],
 5    ['product_id' => 'prod-200', 'name' => 'Chair'],
 6];
 7 
 8$keyed = Arr::keyBy($array, 'product_id');
 9 
10/*
11    [
12        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
13        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
14    ]
15*/

use Illuminate\Support\Arr;

$array = [
    ['product_id' => 'prod-100', 'name' => 'Desk'],
    ['product_id' => 'prod-200', 'name' => 'Chair'],
];

$keyed = Arr::keyBy($array, 'product_id');

/*
    [
        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
    ]
*/

`Arr::last()`

Arr::last 方法傳回通過給定真值測試的陣列的最後一個元素

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300, 110];
4 
5$last = Arr::last($array, function (int $value, int $key) {
6    return $value >= 150;
7});
8 
9// 300

use Illuminate\Support\Arr;

$array = [100, 200, 300, 110];

$last = Arr::last($array, function (int $value, int $key) {
    return $value >= 150;
});

// 300

可以將預設值作為方法的第三個引數傳遞。如果沒有值通過真值測試，則會傳回此值

1use Illuminate\Support\Arr;
2 
3$last = Arr::last($array, $callback, $default);

use Illuminate\Support\Arr;

$last = Arr::last($array, $callback, $default);

`Arr::map()`

Arr::map 方法迭代陣列，並將每個值和鍵傳遞到給定的回呼函式。陣列值會被回呼函式傳回的值取代

1use Illuminate\Support\Arr;
2 
3$array = ['first' => 'james', 'last' => 'kirk'];
4 
5$mapped = Arr::map($array, function (string $value, string $key) {
6    return ucfirst($value);
7});
8 
9// ['first' => 'James', 'last' => 'Kirk']

use Illuminate\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

`Arr::mapSpread()`

Arr::mapSpread 方法迭代陣列，將每個巢狀項目值傳遞到給定的閉包。閉包可以自由修改項目並傳回它，從而形成一個新的修改項目陣列

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    [0, 1],
 5    [2, 3],
 6    [4, 5],
 7    [6, 7],
 8    [8, 9],
 9];
10 
11$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
12    return $even + $odd;
13});
14 
15/*
16    [1, 5, 9, 13, 17]
17*/

use Illuminate\Support\Arr;

$array = [
    [0, 1],
    [2, 3],
    [4, 5],
    [6, 7],
    [8, 9],
];

$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
    return $even + $odd;
});

/*
    [1, 5, 9, 13, 17]
*/

`Arr::mapWithKeys()`

Arr::mapWithKeys 方法迭代陣列，並將每個值傳遞到給定的回呼函式。回呼函式應傳回包含單一鍵 / 值對的關聯陣列

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    [
 5        'name' => 'John',
 6        'department' => 'Sales',
 7        'email' => '[email protected]',
 8    ],
 9    [
10        'name' => 'Jane',
11        'department' => 'Marketing',
12        'email' => '[email protected]',
13    ]
14];
15 
16$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
17    return [$item['email'] => $item['name']];
18});
19 
20/*
21    [
22        '[email protected]' => 'John',
23        '[email protected]' => 'Jane',
24    ]
25*/

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => '[email protected]',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => '[email protected]',
    ]
];

$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});

/*
    [
        '[email protected]' => 'John',
        '[email protected]' => 'Jane',
    ]
*/

`Arr::only()`

Arr::only 方法僅從給定的陣列傳回指定的鍵 / 值對

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
4 
5$slice = Arr::only($array, ['name', 'price']);
6 
7// ['name' => 'Desk', 'price' => 100]

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$slice = Arr::only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

`Arr::pluck()`

Arr::pluck 方法從陣列中檢索給定鍵的所有值

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['developer' => ['id' => 1, 'name' => 'Taylor']],
 5    ['developer' => ['id' => 2, 'name' => 'Abigail']],
 6];
 7 
 8$names = Arr::pluck($array, 'developer.name');
 9 
10// ['Taylor', 'Abigail']

use Illuminate\Support\Arr;

$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];

$names = Arr::pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

您也可以指定希望如何為產生的列表建立索引鍵

1use Illuminate\Support\Arr;
2 
3$names = Arr::pluck($array, 'developer.name', 'developer.id');
4 
5// [1 => 'Taylor', 2 => 'Abigail']

use Illuminate\Support\Arr;

$names = Arr::pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail']

`Arr::prepend()`

Arr::prepend 方法會將項目推送到陣列的開頭

1use Illuminate\Support\Arr;
2 
3$array = ['one', 'two', 'three', 'four'];
4 
5$array = Arr::prepend($array, 'zero');
6 
7// ['zero', 'one', 'two', 'three', 'four']

use Illuminate\Support\Arr;

$array = ['one', 'two', 'three', 'four'];

$array = Arr::prepend($array, 'zero');

// ['zero', 'one', 'two', 'three', 'four']

如果需要，您可以指定應用於該值的鍵

1use Illuminate\Support\Arr;
2 
3$array = ['price' => 100];
4 
5$array = Arr::prepend($array, 'Desk', 'name');
6 
7// ['name' => 'Desk', 'price' => 100]

use Illuminate\Support\Arr;

$array = ['price' => 100];

$array = Arr::prepend($array, 'Desk', 'name');

// ['name' => 'Desk', 'price' => 100]

`Arr::prependKeysWith()`

Arr::prependKeysWith 將給定字首加到關聯陣列的所有鍵名稱之前

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Desk',
 5    'price' => 100,
 6];
 7 
 8$keyed = Arr::prependKeysWith($array, 'product.');
 9 
10/*
11    [
12        'product.name' => 'Desk',
13        'product.price' => 100,
14    ]
15*/

use Illuminate\Support\Arr;

$array = [
    'name' => 'Desk',
    'price' => 100,
];

$keyed = Arr::prependKeysWith($array, 'product.');

/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

`Arr::pull()`

Arr::pull 方法傳回並從陣列中移除鍵 / 值對

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$name = Arr::pull($array, 'name');
6 
7// $name: Desk
8 
9// $array: ['price' => 100]

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$name = Arr::pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

可以將預設值作為方法的第三個引數傳遞。如果鍵不存在，則會傳回此值

1use Illuminate\Support\Arr;
2 
3$value = Arr::pull($array, $key, $default);

use Illuminate\Support\Arr;

$value = Arr::pull($array, $key, $default);

`Arr::query()`

Arr::query 方法將陣列轉換為查詢字串

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Taylor',
 5    'order' => [
 6        'column' => 'created_at',
 7        'direction' => 'desc'
 8    ]
 9];
10 
11Arr::query($array);
12 
13// name=Taylor&order[column]=created_at&order[direction]=desc

use Illuminate\Support\Arr;

$array = [
    'name' => 'Taylor',
    'order' => [
        'column' => 'created_at',
        'direction' => 'desc'
    ]
];

Arr::query($array);

// name=Taylor&order[column]=created_at&order[direction]=desc

`Arr::random()`

Arr::random 方法從陣列中傳回隨機值

1use Illuminate\Support\Arr;
2 
3$array = [1, 2, 3, 4, 5];
4 
5$random = Arr::random($array);
6 
7// 4 - (retrieved randomly)

use Illuminate\Support\Arr;

$array = [1, 2, 3, 4, 5];

$random = Arr::random($array);

// 4 - (retrieved randomly)

您也可以指定要傳回的項目數作為可選的第二個引數。請注意，即使只需要一個項目，提供此引數也會傳回陣列

1use Illuminate\Support\Arr;
2 
3$items = Arr::random($array, 2);
4 
5// [2, 5] - (retrieved randomly)

use Illuminate\Support\Arr;

$items = Arr::random($array, 2);

// [2, 5] - (retrieved randomly)

`Arr::set()`

Arr::set 方法使用「點」表示法在深度巢狀陣列中設定值

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::set($array, 'products.desk.price', 200);
6 
7// ['products' => ['desk' => ['price' => 200]]]

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

`Arr::shuffle()`

Arr::shuffle 方法隨機洗牌陣列中的項目

1use Illuminate\Support\Arr;
2 
3$array = Arr::shuffle([1, 2, 3, 4, 5]);
4 
5// [3, 2, 5, 1, 4] - (generated randomly)

use Illuminate\Support\Arr;

$array = Arr::shuffle([1, 2, 3, 4, 5]);

// [3, 2, 5, 1, 4] - (generated randomly)

`Arr::sort()`

Arr::sort 方法依其值排序陣列

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sort($array);
6 
7// ['Chair', 'Desk', 'Table']

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sort($array);

// ['Chair', 'Desk', 'Table']

您也可以依給定閉包的結果排序陣列

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sort($array, function (array $value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Chair'],
16        ['name' => 'Desk'],
17        ['name' => 'Table'],
18    ]
19*/

use Illuminate\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sort($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

`Arr::sortDesc()`

Arr::sortDesc 方法依其值降序排序陣列

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sortDesc($array);
6 
7// ['Table', 'Desk', 'Chair']

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

$sorted = Arr::sortDesc($array);

// ['Table', 'Desk', 'Chair']

您也可以依給定閉包的結果排序陣列

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sortDesc($array, function (array $value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Table'],
16        ['name' => 'Desk'],
17        ['name' => 'Chair'],
18    ]
19*/

use Illuminate\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sortDesc($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Table'],
        ['name' => 'Desk'],
        ['name' => 'Chair'],
    ]
*/

`Arr::sortRecursive()`

Arr::sortRecursive 方法遞迴排序陣列，數值索引子陣列使用 sort 函式，關聯子陣列使用 ksort 函式

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['Roman', 'Taylor', 'Li'],
 5    ['PHP', 'Ruby', 'JavaScript'],
 6    ['one' => 1, 'two' => 2, 'three' => 3],
 7];
 8 
 9$sorted = Arr::sortRecursive($array);
10 
11/*
12    [
13        ['JavaScript', 'PHP', 'Ruby'],
14        ['one' => 1, 'three' => 3, 'two' => 2],
15        ['Li', 'Roman', 'Taylor'],
16    ]
17*/

use Illuminate\Support\Arr;

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

$sorted = Arr::sortRecursive($array);

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

如果您希望以遞減順序排序結果，可以使用 Arr::sortRecursiveDesc 方法。

1$sorted = Arr::sortRecursiveDesc($array);

$sorted = Arr::sortRecursiveDesc($array);

`Arr::take()`

Arr::take 方法傳回包含指定項目數的新陣列

1use Illuminate\Support\Arr;
2 
3$array = [0, 1, 2, 3, 4, 5];
4 
5$chunk = Arr::take($array, 3);
6 
7// [0, 1, 2]

use Illuminate\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]

您也可以傳遞負整數，從陣列末尾取得指定數量的項目

1$array = [0, 1, 2, 3, 4, 5];
2 
3$chunk = Arr::take($array, -2);
4 
5// [4, 5]

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, -2);

// [4, 5]

`Arr::toCssClasses()`

Arr::toCssClasses 方法有條件地編譯 CSS 類別字串。此方法接受類別陣列，其中陣列鍵包含您想要新增的類別或多個類別，而值是布林運算式。如果陣列元素具有數字鍵，則它將始終包含在呈現的類別列表中

 1use Illuminate\Support\Arr;
 2 
 3$isActive = false;
 4$hasError = true;
 5 
 6$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
 7 
 8$classes = Arr::toCssClasses($array);
 9 
10/*
11    'p-4 bg-red'
12*/

use Illuminate\Support\Arr;

$isActive = false;
$hasError = true;

$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];

$classes = Arr::toCssClasses($array);

/*
    'p-4 bg-red'
*/

`Arr::toCssStyles()`

Arr::toCssStyles 有條件地編譯 CSS 樣式字串。此方法接受類別陣列，其中陣列鍵包含您想要新增的類別或多個類別，而值是布林運算式。如果陣列元素具有數字鍵，則它將始終包含在呈現的類別列表中

 1use Illuminate\Support\Arr;
 2 
 3$hasColor = true;
 4 
 5$array = ['background-color: blue', 'color: blue' => $hasColor];
 6 
 7$classes = Arr::toCssStyles($array);
 8 
 9/*
10    'background-color: blue; color: blue;'
11*/

use Illuminate\Support\Arr;

$hasColor = true;

$array = ['background-color: blue', 'color: blue' => $hasColor];

$classes = Arr::toCssStyles($array);

/*
    'background-color: blue; color: blue;'
*/

此方法支援 Laravel 的功能，允許與 Blade 元件的屬性包合併類別以及 @class Blade 指令。

`Arr::undot()`

Arr::undot 方法將使用「點」表示法的單維陣列展開為多維陣列

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'user.name' => 'Kevin Malone',
 5    'user.occupation' => 'Accountant',
 6];
 7 
 8$array = Arr::undot($array);
 9 
10// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

use Illuminate\Support\Arr;

$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];

$array = Arr::undot($array);

// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

`Arr::where()`

Arr::where 方法使用給定的閉包篩選陣列

1use Illuminate\Support\Arr;
2 
3$array = [100, '200', 300, '400', 500];
4 
5$filtered = Arr::where($array, function (string|int $value, int $key) {
6    return is_string($value);
7});
8 
9// [1 => '200', 3 => '400']

use Illuminate\Support\Arr;

$array = [100, '200', 300, '400', 500];

$filtered = Arr::where($array, function (string|int $value, int $key) {
    return is_string($value);
});

// [1 => '200', 3 => '400']

`Arr::whereNotNull()`

Arr::whereNotNull 方法從給定的陣列中移除所有 null 值

1use Illuminate\Support\Arr;
2 
3$array = [0, null];
4 
5$filtered = Arr::whereNotNull($array);
6 
7// [0 => 0]

use Illuminate\Support\Arr;

$array = [0, null];

$filtered = Arr::whereNotNull($array);

// [0 => 0]

`Arr::wrap()`

Arr::wrap 方法將給定的值包裝在陣列中。如果給定的值已經是陣列，則會不經修改地傳回

1use Illuminate\Support\Arr;
2 
3$string = 'Laravel';
4 
5$array = Arr::wrap($string);
6 
7// ['Laravel']

use Illuminate\Support\Arr;

$string = 'Laravel';

$array = Arr::wrap($string);

// ['Laravel']

如果給定的值為 null，則會傳回空陣列

1use Illuminate\Support\Arr;
2 
3$array = Arr::wrap(null);
4 
5// []

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

data_fill 函式使用「點」表示法在巢狀陣列或物件中設定遺失的值

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_fill($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 100]]]
6 
7data_fill($data, 'products.desk.discount', 10);
8 
9// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

$data = ['products' => ['desk' => ['price' => 100]]];

data_fill($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 100]]]

data_fill($data, 'products.desk.discount', 10);

// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

此函式也接受星號作為萬用字元，並會相應地填入目標

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2'],
 5    ],
 6];
 7 
 8data_fill($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 100],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2'],
    ],
];

data_fill($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 100],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

`data_get()`

data_get 函式使用「點」表示法從巢狀陣列或物件中檢索值

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3$price = data_get($data, 'products.desk.price');
4 
5// 100

$data = ['products' => ['desk' => ['price' => 100]]];

$price = data_get($data, 'products.desk.price');

// 100

如果找不到指定的鍵，data_get 函式也接受預設值，並會傳回該值

1$discount = data_get($data, 'products.desk.discount', 0);
2 
3// 0

$discount = data_get($data, 'products.desk.discount', 0);

// 0

此函式也接受使用星號的萬用字元，可以鎖定陣列或物件的任何鍵

1$data = [
2    'product-one' => ['name' => 'Desk 1', 'price' => 100],
3    'product-two' => ['name' => 'Desk 2', 'price' => 150],
4];
5 
6data_get($data, '*.name');
7 
8// ['Desk 1', 'Desk 2'];

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];

data_get($data, '*.name');

// ['Desk 1', 'Desk 2'];

可以使用 {first} 和 {last} 佔位符來檢索陣列中的第一個或最後一個項目

 1$flight = [
 2    'segments' => [
 3        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
 4        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
 5    ],
 6];
 7 
 8data_get($flight, 'segments.{first}.arrival');
 9 
10// 15:00

$flight = [
    'segments' => [
        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
    ],
];

data_get($flight, 'segments.{first}.arrival');

// 15:00

`data_set()`

data_set 函式使用「點」表示法在巢狀陣列或物件中設定值

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 200]]]

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

此函式也接受使用星號的萬用字元，並會相應地在目標上設定值

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_set($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 200],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_set($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 200],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

預設情況下，任何現有值都會被覆寫。如果您只想在值不存在時才設定值，您可以將 false 作為第四個引數傳遞給函式

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200, overwrite: false);
4 
5// ['products' => ['desk' => ['price' => 100]]]

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200, overwrite: false);

// ['products' => ['desk' => ['price' => 100]]]

`data_forget()`

data_forget 函式使用「點」表示法移除巢狀陣列或物件中的值

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_forget($data, 'products.desk.price');
4 
5// ['products' => ['desk' => []]]

$data = ['products' => ['desk' => ['price' => 100]]];

data_forget($data, 'products.desk.price');

// ['products' => ['desk' => []]]

此函式也接受使用星號的萬用字元，並會相應地移除目標上的值

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_forget($data, 'products.*.price');
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1'],
14            ['name' => 'Desk 2'],
15        ],
16    ]
17*/

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_forget($data, 'products.*.price');

/*
    [
        'products' => [
            ['name' => 'Desk 1'],
            ['name' => 'Desk 2'],
        ],
    ]
*/

`head()`

head 函式傳回給定陣列中的第一個元素

1$array = [100, 200, 300];
2 
3$first = head($array);
4 
5// 100

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

last 函式傳回給定陣列中的最後一個元素

1$array = [100, 200, 300];
2 
3$last = last($array);
4 
5// 300

$array = [100, 200, 300];

$last = last($array);

// 300

數字

`Number::abbreviate()`

Number::abbreviate 方法傳回所提供數值的易讀格式，並帶有單位縮寫

 1use Illuminate\Support\Number;
 2 
 3$number = Number::abbreviate(1000);
 4 
 5// 1K
 6 
 7$number = Number::abbreviate(489939);
 8 
 9// 490K
10 
11$number = Number::abbreviate(1230000, precision: 2);
12 
13// 1.23M

use Illuminate\Support\Number;

$number = Number::abbreviate(1000);

// 1K

$number = Number::abbreviate(489939);

// 490K

$number = Number::abbreviate(1230000, precision: 2);

// 1.23M

`Number::clamp()`

Number::clamp 方法確保給定的數字保持在指定的範圍內。如果數字低於最小值，則傳回最小值。如果數字高於最大值，則傳回最大值

 1use Illuminate\Support\Number;
 2 
 3$number = Number::clamp(105, min: 10, max: 100);
 4 
 5// 100
 6 
 7$number = Number::clamp(5, min: 10, max: 100);
 8 
 9// 10
10 
11$number = Number::clamp(10, min: 10, max: 100);
12 
13// 10
14 
15$number = Number::clamp(20, min: 10, max: 100);
16 
17// 20

use Illuminate\Support\Number;

$number = Number::clamp(105, min: 10, max: 100);

// 100

$number = Number::clamp(5, min: 10, max: 100);

// 10

$number = Number::clamp(10, min: 10, max: 100);

// 10

$number = Number::clamp(20, min: 10, max: 100);

// 20

`Number::currency()`

Number::currency 方法以字串形式傳回給定值的貨幣表示法

 1use Illuminate\Support\Number;
 2 
 3$currency = Number::currency(1000);
 4 
 5// $1,000.00
 6 
 7$currency = Number::currency(1000, in: 'EUR');
 8 
 9// €1,000.00
10 
11$currency = Number::currency(1000, in: 'EUR', locale: 'de');
12 
13// 1.000,00 €

use Illuminate\Support\Number;

$currency = Number::currency(1000);

// $1,000.00

$currency = Number::currency(1000, in: 'EUR');

// €1,000.00

$currency = Number::currency(1000, in: 'EUR', locale: 'de');

// 1.000,00 €

`Number::defaultCurrency()`

Number::defaultCurrency 方法傳回 Number 類別正在使用的預設貨幣

1use Illuminate\Support\Number;
2 
3$currency = Number::defaultCurrency();
4 
5// USD

use Illuminate\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

Number::defaultLocale 方法傳回 Number 類別正在使用的預設地區設定

1use Illuminate\Support\Number;
2 
3$locale = Number::defaultLocale();
4 
5// en

use Illuminate\Support\Number;

$locale = Number::defaultLocale();

// en

`Number::fileSize()`

Number::fileSize 方法以字串形式傳回給定位元組值的文件大小表示法

 1use Illuminate\Support\Number;
 2 
 3$size = Number::fileSize(1024);
 4 
 5// 1 KB
 6 
 7$size = Number::fileSize(1024 * 1024);
 8 
 9// 1 MB
10 
11$size = Number::fileSize(1024, precision: 2);
12 
13// 1.00 KB

use Illuminate\Support\Number;

$size = Number::fileSize(1024);

// 1 KB

$size = Number::fileSize(1024 * 1024);

// 1 MB

$size = Number::fileSize(1024, precision: 2);

// 1.00 KB

`Number::forHumans()`

Number::forHumans 方法傳回所提供數值的易讀格式

 1use Illuminate\Support\Number;
 2 
 3$number = Number::forHumans(1000);
 4 
 5// 1 thousand
 6 
 7$number = Number::forHumans(489939);
 8 
 9// 490 thousand
10 
11$number = Number::forHumans(1230000, precision: 2);
12 
13// 1.23 million

use Illuminate\Support\Number;

$number = Number::forHumans(1000);

// 1 thousand

$number = Number::forHumans(489939);

// 490 thousand

$number = Number::forHumans(1230000, precision: 2);

// 1.23 million

`Number::format()`

Number::format 方法將給定的數字格式化為特定於地區設定的字串

 1use Illuminate\Support\Number;
 2 
 3$number = Number::format(100000);
 4 
 5// 100,000
 6 
 7$number = Number::format(100000, precision: 2);
 8 
 9// 100,000.00
10 
11$number = Number::format(100000.123, maxPrecision: 2);
12 
13// 100,000.12
14 
15$number = Number::format(100000, locale: 'de');
16 
17// 100.000

use Illuminate\Support\Number;

$number = Number::format(100000);

// 100,000

$number = Number::format(100000, precision: 2);

// 100,000.00

$number = Number::format(100000.123, maxPrecision: 2);

// 100,000.12

$number = Number::format(100000, locale: 'de');

// 100.000

`Number::ordinal()`

Number::ordinal 方法傳回數字的序數表示法

 1use Illuminate\Support\Number;
 2 
 3$number = Number::ordinal(1);
 4 
 5// 1st
 6 
 7$number = Number::ordinal(2);
 8 
 9// 2nd
10 
11$number = Number::ordinal(21);
12 
13// 21st

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::pairs()`

Number::pairs 方法根據指定的範圍和步階值產生數字對（子範圍）的陣列。此方法可用於將較大的數字範圍劃分為較小的、可管理的子範圍，用於分頁或批次處理任務等。pairs 方法傳回陣列的陣列，其中每個內部陣列代表一對（子範圍）數字

1use Illuminate\Support\Number;
2 
3$result = Number::pairs(25, 10);
4 
5// [[1, 10], [11, 20], [21, 25]]
6 
7$result = Number::pairs(25, 10, offset: 0);
8 
9// [[0, 10], [10, 20], [20, 25]]

use Illuminate\Support\Number;

$result = Number::pairs(25, 10);

// [[1, 10], [11, 20], [21, 25]]

$result = Number::pairs(25, 10, offset: 0);

// [[0, 10], [10, 20], [20, 25]]

`Number::percentage()`

Number::percentage 方法以字串形式傳回給定值的百分比表示法

 1use Illuminate\Support\Number;
 2 
 3$percentage = Number::percentage(10);
 4 
 5// 10%
 6 
 7$percentage = Number::percentage(10, precision: 2);
 8 
 9// 10.00%
10 
11$percentage = Number::percentage(10.123, maxPrecision: 2);
12 
13// 10.12%
14 
15$percentage = Number::percentage(10, precision: 2, locale: 'de');
16 
17// 10,00%

use Illuminate\Support\Number;

$percentage = Number::percentage(10);

// 10%

$percentage = Number::percentage(10, precision: 2);

// 10.00%

$percentage = Number::percentage(10.123, maxPrecision: 2);

// 10.12%

$percentage = Number::percentage(10, precision: 2, locale: 'de');

// 10,00%

`Number::spell()`

Number::spell 方法將給定的數字轉換為文字字串

1use Illuminate\Support\Number;
2 
3$number = Number::spell(102);
4 
5// one hundred and two
6 
7$number = Number::spell(88, locale: 'fr');
8 
9// quatre-vingt-huit

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

$number = Number::spell(88, locale: 'fr');

// quatre-vingt-huit

after 引數可讓您指定一個值，在此值之後應拼出所有數字

1$number = Number::spell(10, after: 10);
2 
3// 10
4 
5$number = Number::spell(11, after: 10);
6 
7// eleven

$number = Number::spell(10, after: 10);

// 10

$number = Number::spell(11, after: 10);

// eleven

until 引數可讓您指定一個值，在此值之前應拼出所有數字

1$number = Number::spell(5, until: 10);
2 
3// five
4 
5$number = Number::spell(10, until: 10);
6 
7// 10

$number = Number::spell(5, until: 10);

// five

$number = Number::spell(10, until: 10);

// 10

`Number::trim()`

Number::trim 方法移除給定數字小數點後的任何尾隨零位數

1use Illuminate\Support\Number;
2 
3$number = Number::trim(12.0);
4 
5// 12
6 
7$number = Number::trim(12.30);
8 
9// 12.3

use Illuminate\Support\Number;

$number = Number::trim(12.0);

// 12

$number = Number::trim(12.30);

// 12.3

`Number::useLocale()`

Number::useLocale 方法全域設定預設數字地區設定，這會影響後續呼叫 Number 類別方法時數字和貨幣的格式化方式

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Number::useLocale('de');
9}

use Illuminate\Support\Number;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useLocale('de');
}

`Number::withLocale()`

Number::withLocale 方法使用指定的地區設定執行給定的閉包，然後在回呼函式執行後還原原始地區設定

1use Illuminate\Support\Number;
2 
3$number = Number::withLocale('de', function () {
4    return Number::format(1500);
5});

use Illuminate\Support\Number;

$number = Number::withLocale('de', function () {
    return Number::format(1500);
});

`Number::useCurrency()`

Number::useCurrency 方法全域設定預設數字貨幣，這會影響後續呼叫 Number 類別方法時貨幣的格式化方式

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Number::useCurrency('GBP');
9}

use Illuminate\Support\Number;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useCurrency('GBP');
}

`Number::withCurrency()`

Number::withCurrency 方法使用指定的貨幣執行給定的閉包，然後在回呼函式執行後還原原始貨幣

1use Illuminate\Support\Number;
2 
3$number = Number::withCurrency('GBP', function () {
4    // ...
5});

use Illuminate\Support\Number;

$number = Number::withCurrency('GBP', function () {
    // ...
});

路徑

`app_path()`

app_path 函式傳回應用程式 app 目錄的完整合格路徑。您也可以使用 app_path 函式產生相對於應用程式目錄的檔案的完整合格路徑

1$path = app_path();
2 
3$path = app_path('Http/Controllers/Controller.php');

$path = app_path();

$path = app_path('Http/Controllers/Controller.php');

`base_path()`

base_path 函式傳回應用程式根目錄的完整合格路徑。您也可以使用 base_path 函式產生相對於專案根目錄的給定檔案的完整合格路徑

1$path = base_path();
2 
3$path = base_path('vendor/bin');

$path = base_path();

$path = base_path('vendor/bin');

`config_path()`

config_path 函式傳回應用程式 config 目錄的完整合格路徑。您也可以使用 config_path 函式產生應用程式設定目錄中給定檔案的完整合格路徑

1$path = config_path();
2 
3$path = config_path('app.php');

$path = config_path();

$path = config_path('app.php');

`database_path()`

database_path 函式傳回應用程式 database 目錄的完整合格路徑。您也可以使用 database_path 函式產生資料庫目錄中給定檔案的完整合格路徑

1$path = database_path();
2 
3$path = database_path('factories/UserFactory.php');

$path = database_path();

$path = database_path('factories/UserFactory.php');

`lang_path()`

lang_path 函式傳回應用程式 lang 目錄的完整合格路徑。您也可以使用 lang_path 函式產生目錄中給定檔案的完整合格路徑

1$path = lang_path();
2 
3$path = lang_path('en/messages.php');

$path = lang_path();

$path = lang_path('en/messages.php');

預設情況下，Laravel 應用程式骨架不包含 lang 目錄。如果您想要自訂 Laravel 的語言檔案，您可以透過 lang:publish Artisan 命令發佈它們。

`mix()`

mix 函式傳回版本化的 Mix 檔案的路徑

1$path = mix('css/app.css');

$path = mix('css/app.css');

`public_path()`

public_path 函式傳回應用程式 public 目錄的完整合格路徑。您也可以使用 public_path 函式產生 public 目錄中給定檔案的完整合格路徑

1$path = public_path();
2 
3$path = public_path('css/app.css');

$path = public_path();

$path = public_path('css/app.css');

`resource_path()`

resource_path 函式傳回應用程式 resources 目錄的完整合格路徑。您也可以使用 resource_path 函式產生 resources 目錄中給定檔案的完整合格路徑

1$path = resource_path();
2 
3$path = resource_path('sass/app.scss');

$path = resource_path();

$path = resource_path('sass/app.scss');

`storage_path()`

storage_path 函式傳回應用程式 storage 目錄的完整合格路徑。您也可以使用 storage_path 函式產生 storage 目錄中給定檔案的完整合格路徑

1$path = storage_path();
2 
3$path = storage_path('app/file.txt');

$path = storage_path();

$path = storage_path('app/file.txt');

URL

`action()`

action 函式為給定的控制器動作產生 URL

1use App\Http\Controllers\HomeController;
2 
3$url = action([HomeController::class, 'index']);

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

如果方法接受路由參數，您可以將它們作為第二個引數傳遞給方法

1$url = action([UserController::class, 'profile'], ['id' => 1]);

$url = action([UserController::class, 'profile'], ['id' => 1]);

`asset()`

asset 函式使用請求的當前方案 (HTTP 或 HTTPS) 為資源產生 URL

1$url = asset('img/photo.jpg');

$url = asset('img/photo.jpg');

您可以透過在 .env 檔案中設定 ASSET_URL 變數來設定資源 URL 主機。如果您將資源託管在 Amazon S3 或另一個 CDN 等外部服務上，這會很有用

1// ASSET_URL=http://example.com/assets
2 
3$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg

// ASSET_URL=http://example.com/assets

$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg

`route()`

route 函式為給定的具名路由產生 URL

1$url = route('route.name');

$url = route('route.name');

如果路由接受參數，您可以將它們作為第二個引數傳遞給函式

1$url = route('route.name', ['id' => 1]);

$url = route('route.name', ['id' => 1]);

預設情況下，route 函式會產生絕對 URL。如果您想要產生相對 URL，您可以將 false 作為函式的第三個引數傳遞

1$url = route('route.name', ['id' => 1], false);

$url = route('route.name', ['id' => 1], false);

`secure_asset()`

secure_asset 函式使用 HTTPS 為資源產生 URL

1$url = secure_asset('img/photo.jpg');

$url = secure_asset('img/photo.jpg');

`secure_url()`

secure_url 函式產生給定路徑的完整合格 HTTPS URL。其他 URL 段可以作為函式的第二個引數傳遞

1$url = secure_url('user/profile');
2 
3$url = secure_url('user/profile', [1]);

$url = secure_url('user/profile');

$url = secure_url('user/profile', [1]);

`to_route()`

to_route 函式為給定的具名路由產生重新導向 HTTP 回應

1return to_route('users.show', ['user' => 1]);

return to_route('users.show', ['user' => 1]);

如有必要，您可以將應指派給重新導向的 HTTP 狀態碼和任何其他回應標頭作為 to_route 方法的第三個和第四個引數傳遞

1return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);

return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);

`url()`

url 函式產生給定路徑的完整合格 URL

1$url = url('user/profile');
2 
3$url = url('user/profile', [1]);

$url = url('user/profile');

$url = url('user/profile', [1]);

如果未提供路徑，則會傳回 Illuminate\Routing\UrlGenerator 實例

1$current = url()->current();
2 
3$full = url()->full();
4 
5$previous = url()->previous();

$current = url()->current();

$full = url()->full();

$previous = url()->previous();

雜項

`abort()`

abort 函式擲回 HTTP 例外，該例外將由例外處理常式呈現

1abort(403);

abort(403);

您也可以提供例外的訊息和應傳送至瀏覽器的自訂 HTTP 回應標頭

1abort(403, 'Unauthorized.', $headers);

abort(403, 'Unauthorized.', $headers);

`abort_if()`

如果給定的布林運算式評估為 true，則 abort_if 函式會擲回 HTTP 例外

1abort_if(! Auth::user()->isAdmin(), 403);

abort_if(! Auth::user()->isAdmin(), 403);

與 abort 方法類似，您也可以提供例外的回應文字作為第三個引數，並提供自訂回應標頭陣列作為函式的第四個引數。

`abort_unless()`

如果給定的布林運算式評估為 false，則 abort_unless 函式會擲回 HTTP 例外

1abort_unless(Auth::user()->isAdmin(), 403);

abort_unless(Auth::user()->isAdmin(), 403);

與 abort 方法類似，您也可以提供例外的回應文字作為第三個引數，並提供自訂回應標頭陣列作為函式的第四個引數。

`app()`

app 函式傳回服務容器實例

1$container = app();

$container = app();

您可以傳遞類別或介面名稱以從容器中解析它

1$api = app('HelpSpot\API');

$api = app('HelpSpot\API');

`auth()`

auth 函式傳回驗證器實例。您可以將其用作 Auth facade 的替代方案

1$user = auth()->user();

$user = auth()->user();

如果需要，您可以指定要存取的守衛實例

1$user = auth('admin')->user();

$user = auth('admin')->user();

`back()`

back 函式產生重新導向 HTTP 回應到使用者先前的位置

1return back($status = 302, $headers = [], $fallback = '/');
2 
3return back();

return back($status = 302, $headers = [], $fallback = '/');

return back();

`bcrypt()`

bcrypt 函式使用 Bcrypt 雜湊給定的值。您可以將此函式用作 Hash facade 的替代方案

1$password = bcrypt('my-secret-password');

$password = bcrypt('my-secret-password');

`blank()`

blank 函式判斷給定的值是否為「空白」

 1blank('');
 2blank('   ');
 3blank(null);
 4blank(collect());
 5 
 6// true
 7 
 8blank(0);
 9blank(true);
10blank(false);
11 
12// false

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

對於 blank 的反義詞，請參閱 filled 方法。

`broadcast()`

broadcast 函式廣播給定的事件到其監聽器

1broadcast(new UserRegistered($user));
2 
3broadcast(new UserRegistered($user))->toOthers();

broadcast(new UserRegistered($user));

broadcast(new UserRegistered($user))->toOthers();

`cache()`

cache 函式可用於從快取中取得值。如果給定的鍵在快取中不存在，則會傳回可選的預設值

1$value = cache('key');
2 
3$value = cache('key', 'default');

$value = cache('key');

$value = cache('key', 'default');

您可以透過將鍵 / 值對陣列傳遞給函式，將項目新增到快取中。您也應該傳遞快取值應被視為有效的秒數或持續時間

1cache(['key' => 'value'], 300);
2 
3cache(['key' => 'value'], now()->addSeconds(10));

cache(['key' => 'value'], 300);

cache(['key' => 'value'], now()->addSeconds(10));

`class_uses_recursive()`

class_uses_recursive 函式傳回類別使用的所有 traits，包括其所有父類別使用的 traits

1$traits = class_uses_recursive(App\Models\User::class);

$traits = class_uses_recursive(App\Models\User::class);

`collect()`

collect 函式從給定的值建立集合實例

1$collection = collect(['taylor', 'abigail']);

$collection = collect(['taylor', 'abigail']);

`config()`

config 函式取得設定變數的值。可以使用「點」語法存取設定值，其中包含檔案名稱和您想要存取的選項。可以指定預設值，如果設定選項不存在，則會傳回該值

1$value = config('app.timezone');
2 
3$value = config('app.timezone', $default);

$value = config('app.timezone');

$value = config('app.timezone', $default);

您可以透過傳遞鍵 / 值對陣列在執行階段設定設定變數。但是，請注意，此函式僅影響目前請求的設定值，不會更新您的實際設定值

1config(['app.debug' => true]);

config(['app.debug' => true]);

`context()`

context 函式從目前 context 中取得值。可以指定預設值，如果 context 鍵不存在，則會傳回該值

1$value = context('trace_id');
2 
3$value = context('trace_id', $default);

$value = context('trace_id');

$value = context('trace_id', $default);

您可以透過傳遞鍵 / 值對陣列來設定 context 值

1use Illuminate\Support\Str;
2 
3context(['trace_id' => Str::uuid()->toString()]);

use Illuminate\Support\Str;

context(['trace_id' => Str::uuid()->toString()]);

cookie 函式建立新的cookie 實例

1$cookie = cookie('name', 'value', $minutes);

$cookie = cookie('name', 'value', $minutes);

`csrf_field()`

csrf_field 函式產生包含 CSRF 權杖值的 HTML hidden 輸入欄位。例如，使用 Blade 語法

1{{ csrf_field() }}

{{ csrf_field() }}

`csrf_token()`

csrf_token 函式檢索目前 CSRF 權杖的值

1$token = csrf_token();

$token = csrf_token();

`decrypt()`

decrypt 函式解密給定的值。您可以將此函式用作 Crypt facade 的替代方案

1$password = decrypt($value);

$password = decrypt($value);

`dd()`

dd 函式傾印給定的變數並結束指令碼的執行

1dd($value);
2 
3dd($value1, $value2, $value3, ...);

dd($value);

dd($value1, $value2, $value3, ...);

如果您不想停止指令碼的執行，請改用 dump 函式。

`dispatch()`

dispatch 函式將給定的任務推送到 Laravel 任務佇列

1dispatch(new App\Jobs\SendEmails);

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

dispatch_sync 函數將給定的任務推送到同步佇列，以便立即處理

1dispatch_sync(new App\Jobs\SendEmails);

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

dump 函數傾印給定的變數

1dump($value);
2 
3dump($value1, $value2, $value3, ...);

dump($value);

dump($value1, $value2, $value3, ...);

如果您想在傾印變數後停止執行腳本，請改用 dd 函數。

`encrypt()`

encrypt 函數加密給定的值。您可以將此函數作為 Crypt facade 的替代方案

1$secret = encrypt('my-secret-value');

$secret = encrypt('my-secret-value');

`env()`

env 函數檢索環境變數的值，或傳回預設值

1$env = env('APP_ENV');
2 
3$env = env('APP_ENV', 'production');

$env = env('APP_ENV');

$env = env('APP_ENV', 'production');

如果您在部署過程中執行 config:cache 命令，則應確保僅從您的設定檔中呼叫 env 函數。一旦設定被快取，.env 檔案將不會被載入，所有對 env 函數的呼叫都將傳回 null。

`event()`

event 函數將給定的事件分派到其監聽器

1event(new UserRegistered($user));

event(new UserRegistered($user));

`fake()`

fake 函數從容器中解析 Faker 單例，這在模型工廠、資料庫填充、測試和原型視圖中建立假資料時非常有用

1@for($i = 0; $i < 10; $i++)
2    <dl>
3        <dt>Name</dt>
4        <dd>{{ fake()->name() }}</dd>
5 
6        <dt>Email</dt>
7        <dd>{{ fake()->unique()->safeEmail() }}</dd>
8    </dl>
9@endfor

@for($i = 0; $i < 10; $i++)
    <dl>
        <dt>Name</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>Email</dt>
        <dd>{{ fake()->unique()->safeEmail() }}</dd>
    </dl>
@endfor

預設情況下，fake 函數將使用您的 config/app.php 設定中的 app.faker_locale 設定選項。通常，此設定選項是透過 APP_FAKER_LOCALE 環境變數設定的。您也可以透過將語系傳遞給 fake 函數來指定語系。每個語系都將解析一個單獨的單例

1fake('nl_NL')->name()

fake('nl_NL')->name()

`filled()`

filled 函數判斷給定的值是否不是「空白」

 1filled(0);
 2filled(true);
 3filled(false);
 4 
 5// true
 6 
 7filled('');
 8filled('   ');
 9filled(null);
10filled(collect());
11 
12// false

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

對於 filled 的相反情況，請參閱 blank 方法。

`info()`

info 函數會將資訊寫入您的應用程式日誌

1info('Some helpful information!');

info('Some helpful information!');

關聯資料的陣列也可以傳遞給此函數

1info('User login attempt failed.', ['id' => $user->id]);

info('User login attempt failed.', ['id' => $user->id]);

`literal()`

literal 函數使用給定的具名參數作為屬性建立新的 stdClass 實例

1$obj = literal(
2    name: 'Joe',
3    languages: ['PHP', 'Ruby'],
4);
5 
6$obj->name; // 'Joe'
7$obj->languages; // ['PHP', 'Ruby']

$obj = literal(
    name: 'Joe',
    languages: ['PHP', 'Ruby'],
);

$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']

`logger()`

logger 函數可用於將 debug 層級訊息寫入日誌

1logger('Debug message');

logger('Debug message');

關聯資料的陣列也可以傳遞給此函數

1logger('User has logged in.', ['id' => $user->id]);

logger('User has logged in.', ['id' => $user->id]);

如果沒有值傳遞給此函數，則會傳回 logger 實例

1logger()->error('You are not allowed here.');

logger()->error('You are not allowed here.');

`method_field()`

method_field 函數產生一個 HTML hidden 輸入欄位，其中包含表單 HTTP 動詞的偽造值。例如，使用 Blade 語法

1<form method="POST">
2    {{ method_field('DELETE') }}
3</form>

<form method="POST">
    {{ method_field('DELETE') }}
</form>

`now()`

now 函數為目前時間建立新的 Illuminate\Support\Carbon 實例

1$now = now();

$now = now();

`old()`

old 函數檢索閃存到 session 中的舊輸入值

1$value = old('value');
2 
3$value = old('value', 'default');

$value = old('value');

$value = old('value', 'default');

由於作為第二個參數提供給 old 函數的「預設值」通常是 Eloquent 模型的屬性，因此 Laravel 允許您直接將整個 Eloquent 模型作為第二個參數傳遞給 old 函數。這樣做時，Laravel 會假設提供給 old 函數的第一個參數是應被視為「預設值」的 Eloquent 屬性的名稱

1{{ old('name', $user->name) }}
2 
3// Is equivalent to...
4 
5{{ old('name', $user) }}

{{ old('name', $user->name) }}

// Is equivalent to...

{{ old('name', $user) }}

`once()`

once 函數執行給定的回呼，並在請求期間將結果快取在記憶體中。任何後續使用相同回呼呼叫 once 函數都會傳回先前快取的結果

 1function random(): int
 2{
 3    return once(function () {
 4        return random_int(1, 1000);
 5    });
 6}
 7 
 8random(); // 123
 9random(); // 123 (cached result)
10random(); // 123 (cached result)

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}

random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)

當從物件實例中執行 once 函數時，快取的結果對於該物件實例將是獨特的

 1<?php
 2 
 3class NumberService
 4{
 5    public function all(): array
 6    {
 7        return once(fn () => [1, 2, 3]);
 8    }
 9}
10 
11$service = new NumberService;
12 
13$service->all();
14$service->all(); // (cached result)
15 
16$secondService = new NumberService;
17 
18$secondService->all();
19$secondService->all(); // (cached result)

<?php

class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}

$service = new NumberService;

$service->all();
$service->all(); // (cached result)

$secondService = new NumberService;

$secondService->all();
$secondService->all(); // (cached result)

`optional()`

optional 函數接受任何引數，並允許您存取該物件的屬性或呼叫方法。如果給定的物件為 null，則屬性和方法將傳回 null 而不是導致錯誤

1return optional($user->address)->street;
2 
3{!! old('name', optional($user)->name) !!}

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

optional 函數也接受閉包作為其第二個引數。如果作為第一個引數提供的值不是 null，則將調用該閉包

1return optional(User::find($id), function (User $user) {
2    return $user->name;
3});

return optional(User::find($id), function (User $user) {
    return $user->name;
});

`policy()`

policy 方法檢索給定類別的 policy 實例

1$policy = policy(App\Models\User::class);

$policy = policy(App\Models\User::class);

`redirect()`

redirect 函數傳回重新導向 HTTP 回應，或者在不帶引數呼叫時傳回 redirector 實例

1return redirect($to = null, $status = 302, $headers = [], $https = null);
2 
3return redirect('/home');
4 
5return redirect()->route('route.name');

return redirect($to = null, $status = 302, $headers = [], $https = null);

return redirect('/home');

return redirect()->route('route.name');

`report()`

report 函數將使用您的例外處理器報告例外

1report($e);

report($e);

report 函數也接受字串作為引數。當給函數一個字串時，函數將建立一個以給定字串作為其訊息的例外

1report('Something went wrong.');

report('Something went wrong.');

`report_if()`

如果給定的條件為 true，report_if 函數將使用您的例外處理器報告例外

1report_if($shouldReport, $e);
2 
3report_if($shouldReport, 'Something went wrong.');

report_if($shouldReport, $e);

report_if($shouldReport, 'Something went wrong.');

`report_unless()`

如果給定的條件為 false，report_unless 函數將使用您的例外處理器報告例外

1report_unless($reportingDisabled, $e);
2 
3report_unless($reportingDisabled, 'Something went wrong.');

report_unless($reportingDisabled, $e);

report_unless($reportingDisabled, 'Something went wrong.');

`request()`

request 函數傳回目前的請求實例，或從目前的請求中取得輸入欄位的值

1$request = request();
2 
3$value = request('key', $default);

$request = request();

$value = request('key', $default);

`rescue()`

rescue 函數執行給定的閉包，並捕獲其執行期間發生的任何例外。所有捕獲的例外都將發送到您的例外處理器；但是，請求將繼續處理

1return rescue(function () {
2    return $this->method();
3});

return rescue(function () {
    return $this->method();
});

您也可以將第二個引數傳遞給 rescue 函數。此引數將是在執行閉包時發生例外情況時應傳回的「預設」值

1return rescue(function () {
2    return $this->method();
3}, false);
4 
5return rescue(function () {
6    return $this->method();
7}, function () {
8    return $this->failure();
9});

return rescue(function () {
    return $this->method();
}, false);

return rescue(function () {
    return $this->method();
}, function () {
    return $this->failure();
});

可以將 report 引數提供給 rescue 函數，以判斷是否應透過 report 函數報告例外

1return rescue(function () {
2    return $this->method();
3}, report: function (Throwable $throwable) {
4    return $throwable instanceof InvalidArgumentException;
5});

return rescue(function () {
    return $this->method();
}, report: function (Throwable $throwable) {
    return $throwable instanceof InvalidArgumentException;
});

`resolve()`

resolve 函數使用服務容器將給定的類別或介面名稱解析為實例

1$api = resolve('HelpSpot\API');

$api = resolve('HelpSpot\API');

`response()`

response 函數建立回應實例，或取得回應工廠的實例

1return response('Hello World', 200, $headers);
2 
3return response()->json(['foo' => 'bar'], 200, $headers);

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

`retry()`

retry 函數嘗試執行給定的回呼，直到達到給定的最大嘗試次數上限。如果回呼未拋出例外，則將傳回其傳回值。如果回呼拋出例外，它將自動重試。如果超過最大嘗試次數，則將拋出例外

1return retry(5, function () {
2    // Attempt 5 times while resting 100ms between attempts...
3}, 100);

return retry(5, function () {
    // Attempt 5 times while resting 100ms between attempts...
}, 100);

如果您想手動計算嘗試之間休眠的毫秒數，您可以將閉包作為第三個引數傳遞給 retry 函數

1use Exception;
2 
3return retry(5, function () {
4    // ...
5}, function (int $attempt, Exception $exception) {
6    return $attempt * 100;
7});

use Exception;

return retry(5, function () {
    // ...
}, function (int $attempt, Exception $exception) {
    return $attempt * 100;
});

為方便起見，您可以提供陣列作為 retry 函數的第一個引數。此陣列將用於判斷後續嘗試之間休眠的毫秒數

1return retry([100, 200], function () {
2    // Sleep for 100ms on first retry, 200ms on second retry...
3});

return retry([100, 200], function () {
    // Sleep for 100ms on first retry, 200ms on second retry...
});

若要僅在特定條件下重試，您可以將閉包作為第四個引數傳遞給 retry 函數

1use Exception;
2 
3return retry(5, function () {
4    // ...
5}, 100, function (Exception $exception) {
6    return $exception instanceof RetryException;
7});

use Exception;

return retry(5, function () {
    // ...
}, 100, function (Exception $exception) {
    return $exception instanceof RetryException;
});

`session()`

session 函數可用於取得或設定 session 值

1$value = session('key');

$value = session('key');

您可以透過將鍵 / 值對的陣列傳遞給函數來設定值

1session(['chairs' => 7, 'instruments' => 3]);

session(['chairs' => 7, 'instruments' => 3]);

如果沒有值傳遞給此函數，則會傳回 session 儲存區

1$value = session()->get('key');
2 
3session()->put('key', $value);

$value = session()->get('key');

session()->put('key', $value);

`tap()`

tap 函數接受兩個引數：任意 $value 和一個閉包。$value 將傳遞給閉包，然後由 tap 函數傳回。閉包的回傳值無關緊要

1$user = tap(User::first(), function (User $user) {
2    $user->name = 'taylor';
3 
4    $user->save();
5});

$user = tap(User::first(), function (User $user) {
    $user->name = 'taylor';

    $user->save();
});

如果沒有閉包傳遞給 tap 函數，您可以呼叫給定 $value 上的任何方法。您呼叫的方法的傳回值將始終為 $value，無論該方法在其定義中實際傳回什麼。例如，Eloquent update 方法通常傳回整數。但是，我們可以透過鏈式調用 tap 函數的 update 方法呼叫，強制該方法傳回模型本身

1$user = tap($user)->update([
2    'name' => $name,
3    'email' => $email,
4]);

$user = tap($user)->update([
    'name' => $name,
    'email' => $email,
]);

若要將 tap 方法新增到類別，您可以將 Illuminate\Support\Traits\Tappable 特性新增到類別。此特性的 tap 方法僅接受一個閉包作為其引數。物件實例本身將傳遞給閉包，然後由 tap 方法傳回

1return $user->tap(function (User $user) {
2    // ...
3});

return $user->tap(function (User $user) {
    // ...
});

`throw_if()`

如果給定的布林運算式評估為 true，throw_if 函數會拋出給定的例外

1throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
2 
3throw_if(
4    ! Auth::user()->isAdmin(),
5    AuthorizationException::class,
6    'You are not allowed to access this page.'
7);

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`throw_unless()`

如果給定的布林運算式評估為 false，throw_unless 函數會拋出給定的例外

1throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
2 
3throw_unless(
4    Auth::user()->isAdmin(),
5    AuthorizationException::class,
6    'You are not allowed to access this page.'
7);

throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`today()`

today 函數為目前日期建立新的 Illuminate\Support\Carbon 實例

1$today = today();

$today = today();

`trait_uses_recursive()`

trait_uses_recursive 函數傳回特性使用的所有特性

1$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);

$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);

`transform()`

如果值不是空白，transform 函數會在給定的值上執行閉包，然後傳回閉包的傳回值

1$callback = function (int $value) {
2    return $value * 2;
3};
4 
5$result = transform(5, $callback);
6 
7// 10

$callback = function (int $value) {
    return $value * 2;
};

$result = transform(5, $callback);

// 10

預設值或閉包可以作為函數的第三個引數傳遞。如果給定的值為空白，則將傳回此值

1$result = transform(null, $callback, 'The value is blank');
2 
3// The value is blank

$result = transform(null, $callback, 'The value is blank');

// The value is blank

`validator()`

validator 函數使用給定的引數建立新的驗證器實例。您可以將其作為 Validator facade 的替代方案使用

1$validator = validator($data, $rules, $messages);

$validator = validator($data, $rules, $messages);

`value()`

value 函數傳回給定的值。但是，如果您將閉包傳遞給此函數，則將執行該閉包並傳回其傳回值

1$result = value(true);
2 
3// true
4 
5$result = value(function () {
6    return false;
7});
8 
9// false

$result = value(true);

// true

$result = value(function () {
    return false;
});

// false

其他引數可以傳遞給 value 函數。如果第一個引數是閉包，則其他參數將作為引數傳遞給閉包，否則它們將被忽略

1$result = value(function (string $name) {
2    return $name;
3}, 'Taylor');
4 
5// 'Taylor'

$result = value(function (string $name) {
    return $name;
}, 'Taylor');

// 'Taylor'

`view()`

view 函數檢索視圖實例

1return view('auth.login');

return view('auth.login');

`with()`

with 函數傳回給定的值。如果閉包作為函數的第二個引數傳遞，則將執行該閉包並傳回其傳回值

 1$callback = function (mixed $value) {
 2    return is_numeric($value) ? $value * 2 : 0;
 3};
 4 
 5$result = with(5, $callback);
 6 
 7// 10
 8 
 9$result = with(null, $callback);
10 
11// 0
12 
13$result = with(5, null);
14 
15// 5

$callback = function (mixed $value) {
    return is_numeric($value) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5

`when()`

如果給定的條件評估為 true，when 函數會傳回給定的值。否則，傳回 null。如果閉包作為函數的第二個引數傳遞，則將執行該閉包並傳回其傳回值

1$value = when(true, 'Hello World');
2 
3$value = when(true, fn () => 'Hello World');

$value = when(true, 'Hello World');

$value = when(true, fn () => 'Hello World');

when 函數主要用於條件式渲染 HTML 屬性

1<div {!! when($condition, 'wire:poll="calculate"') !!}>
2    ...
3</div>

<div {!! when($condition, 'wire:poll="calculate"') !!}>
    ...
</div>

其他工具

效能評測

有時您可能希望快速測試應用程式某些部分的效能。在這些情況下，您可以利用 Benchmark 支援類別來測量給定回呼完成所需的毫秒數

 1<?php
 2 
 3use App\Models\User;
 4use Illuminate\Support\Benchmark;
 5 
 6Benchmark::dd(fn () => User::find(1)); // 0.1 ms
 7 
 8Benchmark::dd([
 9    'Scenario 1' => fn () => User::count(), // 0.5 ms
10    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
11]);

<?php

use App\Models\User;
use Illuminate\Support\Benchmark;

Benchmark::dd(fn () => User::find(1)); // 0.1 ms

Benchmark::dd([
    'Scenario 1' => fn () => User::count(), // 0.5 ms
    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);

預設情況下，給定的回呼將執行一次（一次迭代），並且它們的持續時間將顯示在瀏覽器/控制台中。

若要多次調用回呼，您可以將回呼應調用的迭代次數指定為方法的第二個引數。多次執行回呼時，Benchmark 類別將傳回執行所有迭代的回呼所花費的平均毫秒數

1Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms

Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms

有時，您可能想要在基準測試回呼的執行時，仍然取得回呼傳回的值。value 方法將傳回一個元組，其中包含回呼傳回的值以及執行回呼所花費的毫秒數

1[$count, $duration] = Benchmark::value(fn () => User::count());

[$count, $duration] = Benchmark::value(fn () => User::count());

日期

Laravel 包含 Carbon，這是一個強大的日期和時間處理函式庫。若要建立新的 Carbon 實例，您可以調用 now 函數。此函數在您的 Laravel 應用程式中全域可用

1$now = now();

$now = now();

或者，您可以使用 Illuminate\Support\Carbon 類別建立新的 Carbon 實例

1use Illuminate\Support\Carbon;
2 
3$now = Carbon::now();

use Illuminate\Support\Carbon;

$now = Carbon::now();

有關 Carbon 及其功能的深入討論，請參閱官方 Carbon 文件。

延遲函式

延遲函數目前處於 beta 測試階段，我們正在收集社群回饋。

雖然 Laravel 的佇列任務允許您將任務排入佇列以進行背景處理，但有時您可能只想延遲簡單的任務，而無需設定或維護長時間運行的佇列 worker。

延遲函數允許您延遲閉包的執行，直到 HTTP 回應已發送給使用者之後，從而使您的應用程式感覺快速且響應靈敏。若要延遲閉包的執行，只需將閉包傳遞給 Illuminate\Support\defer 函數

 1use App\Services\Metrics;
 2use Illuminate\Http\Request;
 3use Illuminate\Support\Facades\Route;
 4use function Illuminate\Support\defer;
 5 
 6Route::post('/orders', function (Request $request) {
 7    // Create order...
 8 
 9    defer(fn () => Metrics::reportOrder($order));
10 
11    return $order;
12});

use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;

Route::post('/orders', function (Request $request) {
    // Create order...

    defer(fn () => Metrics::reportOrder($order));

    return $order;
});

預設情況下，延遲函數僅在從中調用 Illuminate\Support\defer 的 HTTP 回應、Artisan 命令或佇列任務成功完成時才會執行。這表示如果請求導致 4xx 或 5xx HTTP 回應，則不會執行延遲函數。如果您希望延遲函數始終執行，您可以將 always 方法鏈式調用到您的延遲函數

1defer(fn () => Metrics::reportOrder($order))->always();

defer(fn () => Metrics::reportOrder($order))->always();

取消延遲函數

如果您需要在執行延遲函數之前取消它，您可以使用 forget 方法依其名稱取消函數。若要命名延遲函數，請將第二個引數提供給 Illuminate\Support\defer 函數

1defer(fn () => Metrics::report(), 'reportMetrics');
2 
3defer()->forget('reportMetrics');

defer(fn () => Metrics::report(), 'reportMetrics');

defer()->forget('reportMetrics');

延遲函數相容性

如果您從 Laravel 10.x 應用程式升級到 Laravel 11.x，並且您應用程式的骨架仍然包含 app/Http/Kernel.php 檔案，則應將 InvokeDeferredCallbacks middleware 新增到 kernel 的 $middleware 屬性的開頭

1protected $middleware = [
2    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class, 
3    \App\Http\Middleware\TrustProxies::class,
4    // ...
5];

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class,
    \App\Http\Middleware\TrustProxies::class,
    // ...
];

在測試中禁用延遲函數

在編寫測試時，禁用延遲函數可能很有用。您可以在測試中呼叫 withoutDefer，以指示 Laravel 立即調用所有延遲函數

1test('without defer', function () {
2    $this->withoutDefer();
3 
4    // ...
5});

test('without defer', function () {
    $this->withoutDefer();

    // ...
});

 1use Tests\TestCase;
 2 
 3class ExampleTest extends TestCase
 4{
 5    public function test_without_defer(): void
 6    {
 7        $this->withoutDefer();
 8 
 9        // ...
10    }
11}

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_without_defer(): void
    {
        $this->withoutDefer();

        // ...
    }
}

如果您想為測試案例中的所有測試禁用延遲函數，您可以從基礎 TestCase 類別上的 setUp 方法呼叫 withoutDefer 方法

 1<?php
 2 
 3namespace Tests;
 4 
 5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 6 
 7abstract class TestCase extends BaseTestCase
 8{
 9    protected function setUp(): void
10    {
11        parent::setUp();
12 
13        $this->withoutDefer();
14    }
15}

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        $this->withoutDefer();
    }
}

Lottery

Laravel 的 lottery 類別可用於根據一組給定的機率執行回呼。當您只想為一部分傳入請求執行程式碼時，這可能特別有用

1use Illuminate\Support\Lottery;
2 
3Lottery::odds(1, 20)
4    ->winner(fn () => $user->won())
5    ->loser(fn () => $user->lost())
6    ->choose();

use Illuminate\Support\Lottery;

Lottery::odds(1, 20)
    ->winner(fn () => $user->won())
    ->loser(fn () => $user->lost())
    ->choose();

您可以將 Laravel 的 lottery 類別與其他 Laravel 功能結合使用。例如，您可能希望僅向您的例外處理器報告一小部分慢查詢。而且，由於 lottery 類別是可呼叫的，因此我們可以將類別的實例傳遞到任何接受可呼叫物件的方法中

1use Carbon\CarbonInterval;
2use Illuminate\Support\Facades\DB;
3use Illuminate\Support\Lottery;
4 
5DB::whenQueryingForLongerThan(
6    CarbonInterval::seconds(2),
7    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
8);

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;

DB::whenQueryingForLongerThan(
    CarbonInterval::seconds(2),
    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);

測試 lottery

Laravel 提供了一些簡單的方法，讓您可以輕鬆測試應用程式的 lottery 調用

 1// Lottery will always win...
 2Lottery::alwaysWin();
 3 
 4// Lottery will always lose...
 5Lottery::alwaysLose();
 6 
 7// Lottery will win then lose, and finally return to normal behavior...
 8Lottery::fix([true, false]);
 9 
10// Lottery will return to normal behavior...
11Lottery::determineResultsNormally();

// Lottery will always win...
Lottery::alwaysWin();

// Lottery will always lose...
Lottery::alwaysLose();

// Lottery will win then lose, and finally return to normal behavior...
Lottery::fix([true, false]);

// Lottery will return to normal behavior...
Lottery::determineResultsNormally();

Pipeline

Laravel 的 Pipeline facade 提供了一種方便的方式，可將給定的輸入透過一系列可調用類別、閉包或可呼叫物件「管道化」，讓每個類別都有機會檢查或修改輸入，並調用管道中的下一個可呼叫物件

 1use Closure;
 2use App\Models\User;
 3use Illuminate\Support\Facades\Pipeline;
 4 
 5$user = Pipeline::send($user)
 6    ->through([
 7        function (User $user, Closure $next) {
 8            // ...
 9 
10            return $next($user);
11        },
12        function (User $user, Closure $next) {
13            // ...
14 
15            return $next($user);
16        },
17    ])
18    ->then(fn (User $user) => $user);

use Closure;
use App\Models\User;
use Illuminate\Support\Facades\Pipeline;

$user = Pipeline::send($user)
    ->through([
        function (User $user, Closure $next) {
            // ...

            return $next($user);
        },
        function (User $user, Closure $next) {
            // ...

            return $next($user);
        },
    ])
    ->then(fn (User $user) => $user);

如您所見，管道中的每個可調用類別或閉包都提供了輸入和 $next 閉包。調用 $next 閉包將調用管道中的下一個可呼叫物件。您可能已經注意到，這與middleware 非常相似。

當管道中的最後一個可呼叫物件調用 $next 閉包時，將調用提供給 then 方法的可呼叫物件。通常，此可呼叫物件只會傳回給定的輸入。

當然，如先前討論的，您不限於將閉包提供給您的管道。您也可以提供可調用類別。如果提供類別名稱，則將透過 Laravel 的服務容器實例化該類別，從而允許將依賴項注入到可調用類別中

1$user = Pipeline::send($user)
2    ->through([
3        GenerateProfilePhoto::class,
4        ActivateSubscription::class,
5        SendWelcomeEmail::class,
6    ])
7    ->then(fn (User $user) => $user);

$user = Pipeline::send($user)
    ->through([
        GenerateProfilePhoto::class,
        ActivateSubscription::class,
        SendWelcomeEmail::class,
    ])
    ->then(fn (User $user) => $user);

Sleep

Laravel 的 Sleep 類別是 PHP 原生 sleep 和 usleep 函數的輕量級封裝器，在提供更佳可測試性的同時，也公開了開發人員友善的 API 以處理時間

1use Illuminate\Support\Sleep;
2 
3$waiting = true;
4 
5while ($waiting) {
6    Sleep::for(1)->second();
7 
8    $waiting = /* ... */;
9}

use Illuminate\Support\Sleep;

$waiting = true;

while ($waiting) {
    Sleep::for(1)->second();

    $waiting = /* ... */;
}

Sleep 類別提供了多種方法，可讓您處理不同的時間單位

 1// Return a value after sleeping...
 2$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
 3 
 4// Sleep while a given value is true...
 5Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
 6 
 7// Pause execution for 90 seconds...
 8Sleep::for(1.5)->minutes();
 9 
10// Pause execution for 2 seconds...
11Sleep::for(2)->seconds();
12 
13// Pause execution for 500 milliseconds...
14Sleep::for(500)->milliseconds();
15 
16// Pause execution for 5,000 microseconds...
17Sleep::for(5000)->microseconds();
18 
19// Pause execution until a given time...
20Sleep::until(now()->addMinute());
21 
22// Alias of PHP's native "sleep" function...
23Sleep::sleep(2);
24 
25// Alias of PHP's native "usleep" function...
26Sleep::usleep(5000);

// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);

// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());

// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();

// Pause execution for 2 seconds...
Sleep::for(2)->seconds();

// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();

// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();

// Pause execution until a given time...
Sleep::until(now()->addMinute());

// Alias of PHP's native "sleep" function...
Sleep::sleep(2);

// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);

若要輕鬆組合時間單位，您可以使用 and 方法

1Sleep::for(1)->second()->and(10)->milliseconds();

Sleep::for(1)->second()->and(10)->milliseconds();

測試 Sleep

在測試使用 Sleep 類別或 PHP 原生 sleep 函數的程式碼時，您的測試將暫停執行。正如您可能預期的那樣，這會使您的測試套件明顯變慢。例如，假設您正在測試以下程式碼

1$waiting = /* ... */;
2 
3$seconds = 1;
4 
5while ($waiting) {
6    Sleep::for($seconds++)->seconds();
7 
8    $waiting = /* ... */;
9}

$waiting = /* ... */;

$seconds = 1;

while ($waiting) {
    Sleep::for($seconds++)->seconds();

    $waiting = /* ... */;
}

通常，測試此程式碼至少需要一秒鐘。幸運的是，Sleep 類別允許我們「偽造」休眠，以便我們的測試套件保持快速

1it('waits until ready', function () {
2    Sleep::fake();
3 
4    // ...
5});

it('waits until ready', function () {
    Sleep::fake();

    // ...
});

1public function test_it_waits_until_ready()
2{
3    Sleep::fake();
4 
5    // ...
6}

public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

當偽造 Sleep 類別時，實際執行暫停會被繞過，從而產生速度快很多的測試。

一旦 Sleep 類別被偽造，就可以對應發生的預期「休眠」進行斷言。為了說明這一點，讓我們想像一下，我們正在測試暫停執行三次的程式碼，每次暫停增加一秒。使用 assertSequence 方法，我們可以斷言我們的程式碼「休眠」了適當的時間量，同時保持測試快速

 1it('checks if ready three times', function () {
 2    Sleep::fake();
 3 
 4    // ...
 5 
 6    Sleep::assertSequence([
 7        Sleep::for(1)->second(),
 8        Sleep::for(2)->seconds(),
 9        Sleep::for(3)->seconds(),
10    ]);
11}

it('checks if ready three times', function () {
    Sleep::fake();

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}

 1public function test_it_checks_if_ready_three_times()
 2{
 3    Sleep::fake();
 4 
 5    // ...
 6 
 7    Sleep::assertSequence([
 8        Sleep::for(1)->second(),
 9        Sleep::for(2)->seconds(),
10        Sleep::for(3)->seconds(),
11    ]);
12}

public function test_it_checks_if_ready_three_times()
{
    Sleep::fake();

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}

當然，Sleep 類別提供了您在測試時可以使用的各種其他斷言

 1use Carbon\CarbonInterval as Duration;
 2use Illuminate\Support\Sleep;
 3 
 4// Assert that sleep was called 3 times...
 5Sleep::assertSleptTimes(3);
 6 
 7// Assert against the duration of sleep...
 8Sleep::assertSlept(function (Duration $duration): bool {
 9    return /* ... */;
10}, times: 1);
11 
12// Assert that the Sleep class was never invoked...
13Sleep::assertNeverSlept();
14 
15// Assert that, even if Sleep was called, no execution paused occurred...
16Sleep::assertInsomniac();

use Carbon\CarbonInterval as Duration;
use Illuminate\Support\Sleep;

// Assert that sleep was called 3 times...
Sleep::assertSleptTimes(3);

// Assert against the duration of sleep...
Sleep::assertSlept(function (Duration $duration): bool {
    return /* ... */;
}, times: 1);

// Assert that the Sleep class was never invoked...
Sleep::assertNeverSlept();

// Assert that, even if Sleep was called, no execution paused occurred...
Sleep::assertInsomniac();

有時，每當您的應用程式碼中發生偽造休眠時執行操作可能會很有用。若要實現此目的，您可以將回呼提供給 whenFakingSleep 方法。在以下範例中，我們使用 Laravel 的時間操作輔助函數來立即將時間推進每次休眠的持續時間

 1use Carbon\CarbonInterval as Duration;
 2 
 3$this->freezeTime();
 4 
 5Sleep::fake();
 6 
 7Sleep::whenFakingSleep(function (Duration $duration) {
 8    // Progress time when faking sleep...
 9    $this->travel($duration->totalMilliseconds)->milliseconds();
10});

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

Sleep::whenFakingSleep(function (Duration $duration) {
    // Progress time when faking sleep...
    $this->travel($duration->totalMilliseconds)->milliseconds();
});

由於推進時間是常見的需求，因此 fake 方法接受 syncWithCarbon 參數，以便在測試中休眠時保持 Carbon 同步

1Sleep::fake(syncWithCarbon: true);
2 
3$start = now();
4 
5Sleep::for(1)->second();
6 
7$start->diffForHumans(); // 1 second ago

Sleep::fake(syncWithCarbon: true);

$start = now();

Sleep::for(1)->second();

$start->diffForHumans(); // 1 second ago

每當 Laravel 暫停執行時，都會在內部使用 Sleep 類別。例如，retry 輔助函數在休眠時使用 Sleep 類別，從而在使用該輔助函數時提高了可測試性。

Timebox

Laravel 的 Timebox 類別確保給定的回呼始終花費固定的時間量來執行，即使其實際執行完成得更快。這對於密碼學操作和使用者身份驗證檢查特別有用，在這些情況下，攻擊者可能會利用執行時間的變化來推斷敏感資訊。

如果執行時間超過固定持續時間，Timebox 無效。開發人員有責任選擇足夠長的時間作為固定持續時間，以考慮最壞情況。

call 方法接受閉包和以微秒為單位的時間限制，然後執行閉包並等待直到達到時間限制

1use Illuminate\Support\Timebox;
2 
3(new Timebox)->call(function ($timebox) {
4    // ...
5}, microseconds: 10000);

use Illuminate\Support\Timebox;

(new Timebox)->call(function ($timebox) {
    // ...
}, microseconds: 10000);

如果在閉包內拋出例外，則此類別將尊重定義的延遲，並在延遲後重新拋出例外。

前言

開始使用

架構概念

基礎知識

深入探討

安全性

資料庫

Eloquent ORM

測試

套件

Helpers