輔助函式

• 簡介
• 可用方法
• 其他工具
  • 效能基準測試
  • 日期
  • 延遲函式
  • 彩券
  • 管道
  • 睡眠

簡介

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

可用方法

陣列 & 物件

數字

路徑

URL

其他

陣列 & 物件

Arr::accessible()

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

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 方法會將給定的鍵/值對新增至陣列。

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 方法會將陣列的陣列摺疊為單一陣列。

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 方法會交叉聯結給定的陣列，並傳回包含所有可能排列的笛卡爾積。

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 方法會傳回兩個陣列：一個包含鍵，另一個包含給定陣列的值。

use Illuminate\Support\Arr;
 
[$keys, $values] = Arr::divide(['name' => 'Desk']);
 
// $keys: ['name']
 
// $values: ['Desk']

Arr::dot()

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

use Illuminate\Support\Arr;
 
$array = ['products' => ['desk' => ['price' => 100]]];
 
$flattened = Arr::dot($array);
 
// ['products.desk.price' => 100]

Arr::except()

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

use Illuminate\Support\Arr;
 
$array = ['name' => 'Desk', 'price' => 100];
 
$filtered = Arr::except($array, ['price']);
 
// ['name' => 'Desk']

Arr::exists()

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

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 方法會傳回通過給定真值測試的陣列的第一個元素。

use Illuminate\Support\Arr;
 
$array = [100, 200, 300];
 
$first = Arr::first($array, function (int $value, int $key) {
    return $value >= 150;
});
 
// 200

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

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

Arr::flatten()

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

use Illuminate\Support\Arr;
 
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
 
$flattened = Arr::flatten($array);
 
// ['Joe', 'PHP', 'Ruby']

Arr::forget()

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

use Illuminate\Support\Arr;
 
$array = ['products' => ['desk' => ['price' => 100]]];
 
Arr::forget($array, 'products.desk');
 
// ['products' => []]

Arr::get()

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

use Illuminate\Support\Arr;
 
$array = ['products' => ['desk' => ['price' => 100]]];
 
$price = Arr::get($array, 'products.desk.price');
 
// 100

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

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

Arr::has()

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

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 方法會使用「點」表示法檢查給定集合中的任何項目是否存在於陣列中。

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。如果陣列沒有從零開始的連續數字鍵，則會被視為「關聯」陣列。

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。

use Illuminate\Support\Arr;
 
$isList = Arr::isList(['foo', 'bar', 'baz']);
 
// true
 
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
 
// false

Arr::join()

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

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 方法會使用給定的鍵值來為陣列建立索引。如果多個項目具有相同的鍵值，則只有最後一個項目會出現在新的陣列中。

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 方法會傳回通過給定真值測試的陣列的最後一個元素。

use Illuminate\Support\Arr;
 
$array = [100, 200, 300, 110];
 
$last = Arr::last($array, function (int $value, int $key) {
    return $value >= 150;
});
 
// 300

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

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

Arr::map()

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

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 方法會迭代陣列，並將每個巢狀項目值傳遞到給定的閉包中。閉包可以自由修改項目並傳回它，從而形成一個修改後的項目新陣列。

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 方法會迭代陣列，並將每個值傳遞給給定的回呼函式。回呼函式應傳回一個包含單一鍵/值對的關聯陣列。

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 方法只從給定的陣列傳回指定的鍵/值對。

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 方法會從陣列中檢索給定鍵的所有值。

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

您也可以指定如何為產生的清單建立索引。

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

Arr::prepend()

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

use Illuminate\Support\Arr;
 
$array = ['one', 'two', 'three', 'four'];
 
$array = Arr::prepend($array, 'zero');
 
// ['zero', 'one', 'two', 'three', 'four']

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

use Illuminate\Support\Arr;
 
$array = ['price' => 100];
 
$array = Arr::prepend($array, 'Desk', 'name');
 
// ['name' => 'Desk', 'price' => 100]

Arr::prependKeysWith()

Arr::prependKeysWith 會在關聯陣列的所有鍵名稱前加上給定的前綴。

use Illuminate\Support\Arr;
 
$array = [
    'name' => 'Desk',
    'price' => 100,
];
 
$keyed = Arr::prependKeysWith($array, 'product.');
 
/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

Arr::pull()

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

use Illuminate\Support\Arr;
 
$array = ['name' => 'Desk', 'price' => 100];
 
$name = Arr::pull($array, 'name');
 
// $name: Desk
 
// $array: ['price' => 100]

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

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

Arr::query()

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

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 方法會從陣列中傳回一個隨機值。

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

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

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

Arr::set()

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

use Illuminate\Support\Arr;
 
$array = ['products' => ['desk' => ['price' => 100]]];
 
Arr::set($array, 'products.desk.price', 200);
 
// ['products' => ['desk' => ['price' => 200]]]

Arr::shuffle()

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

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

Arr::sort()

Arr::sort 方法會依值排序陣列。

use Illuminate\Support\Arr;
 
$array = ['Desk', 'Table', 'Chair'];
 
$sorted = Arr::sort($array);
 
// ['Chair', 'Desk', 'Table']

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

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 方法會依值降冪排序陣列。

use Illuminate\Support\Arr;
 
$array = ['Desk', 'Table', 'Chair'];
 
$sorted = Arr::sortDesc($array);
 
// ['Table', 'Desk', 'Chair']

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

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 函式對關聯子陣列進行排序。

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 方法。

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

Arr::take()

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

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

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

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

Arr::toCssClasses()

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

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 樣式字串。此方法接受一個類別陣列，其中陣列鍵包含您想要新增的類別或多個類別，而值則是一個布林運算式。如果陣列元素具有數字鍵，它將始終包含在呈現的類別清單中。

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 方法會將使用「點」表示法的單維陣列展開為多維陣列。

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 方法會使用給定的閉包篩選陣列。

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 值。

use Illuminate\Support\Arr;
 
$array = [0, null];
 
$filtered = Arr::whereNotNull($array);
 
// [0 => 0]

Arr::wrap()

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

use Illuminate\Support\Arr;
 
$string = 'Laravel';
 
$array = Arr::wrap($string);
 
// ['Laravel']

如果給定的值是 null，則會傳回一個空陣列。

use Illuminate\Support\Arr;
 
$array = Arr::wrap(null);
 
// []

data_fill()

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

$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]]]

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

$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 函式會使用「點」表示法，從巢狀陣列或物件中檢索值。

$data = ['products' => ['desk' => ['price' => 100]]];
 
$price = data_get($data, 'products.desk.price');
 
// 100

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

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

此函式也接受使用星號的萬用字元，這些萬用字元可以針對陣列或物件的任何鍵。

$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} 佔位符來檢索陣列中的第一個或最後一個項目。

$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 函式會使用「點」表示法，在巢狀陣列或物件中設定值。

$data = ['products' => ['desk' => ['price' => 100]]];
 
data_set($data, 'products.desk.price', 200);
 
// ['products' => ['desk' => ['price' => 200]]]

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

$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 作為函式的第四個參數傳遞。

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

data_forget()

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

$data = ['products' => ['desk' => ['price' => 100]]];
 
data_forget($data, 'products.desk.price');
 
// ['products' => ['desk' => []]]

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

$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 函式會傳回給定陣列中的第一個元素。

$array = [100, 200, 300];
 
$first = head($array);
 
// 100

last()

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

$array = [100, 200, 300];
 
$last = last($array);
 
// 300

數字

Number::abbreviate()

Number::abbreviate 方法會傳回所提供數值的可讀格式，並附帶單位縮寫。

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 方法會確保給定的數字保持在指定的範圍內。如果數字低於最小值，則會傳回最小值。如果數字高於最大值，則會傳回最大值。

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 方法會以字串形式傳回給定值的貨幣表示形式。

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 類別正在使用的預設貨幣。

use Illuminate\Support\Number;
 
$currency = Number::defaultCurrency();
 
// USD

Number::defaultLocale()

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

use Illuminate\Support\Number;
 
$locale = Number::defaultLocale();
 
// en

Number::fileSize()

Number::fileSize 方法會以字串形式傳回給定位元組值的檔案大小表示形式。

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 方法會傳回所提供數值的可讀格式。

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 方法會將給定的數字格式化為特定地區設定的字串。

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 方法會傳回數字的序數表示形式。

use Illuminate\Support\Number;
 
$number = Number::ordinal(1);
 
// 1st
 
$number = Number::ordinal(2);
 
// 2nd
 
$number = Number::ordinal(21);
 
// 21st

Number::pairs()

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

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 方法會以字串形式傳回給定值的百分比表示形式。

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 方法會將給定的數字轉換為文字字串。

use Illuminate\Support\Number;
 
$number = Number::spell(102);
 
// one hundred and two
 
$number = Number::spell(88, locale: 'fr');
 
// quatre-vingt-huit

after 參數可讓您指定一個值，在此值之後，所有數字都應以文字形式拼寫出來。

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

until 參數可讓您指定一個值，在此值之前，所有數字都應以文字形式拼寫出來。

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

Number::trim()

Number::trim 方法會移除給定數字的小數點後的所有尾隨零。

use Illuminate\Support\Number;
 
$number = Number::trim(12.0);
 
// 12
 
$number = Number::trim(12.30);
 
// 12.3

Number::useLocale()

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

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

Number::withLocale()

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

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

Number::useCurrency()

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

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

Number::withCurrency()

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

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

路徑

app_path()

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

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

base_path()

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

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

config_path()

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

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

database_path()

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

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

lang_path()

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

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

mix()

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

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

public_path()

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

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

resource_path()

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

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

storage_path()

storage_path 函式會回傳你應用程式 storage 目錄的完整路徑。你也可以使用 storage_path 函式來產生 storage 目錄內指定檔案的完整路徑。

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

URL

action()

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

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

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

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

asset()

asset 函式會使用請求的目前方案（HTTP 或 HTTPS）為資源產生 URL。

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

你可以透過在你的 .env 檔案中設定 ASSET_URL 變數來設定資源 URL 主機。如果你將資源託管在像是 Amazon S3 或其他 CDN 的外部服務上，這會很有用。

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

route()

route 函式會為給定的命名路由產生 URL。

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

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

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

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

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

secure_asset()

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

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

secure_url()

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

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

to_route()

to_route 函式會為給定的命名路由產生一個重新導向 HTTP 回應。

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

如有必要，你可以將應分配給重新導向的 HTTP 狀態碼，以及任何額外的回應標頭作為 to_route 方法的第三和第四個引數傳遞。

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

url()

url 函式會為給定的路徑產生完整的 URL。

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

如果沒有提供路徑，則會回傳一個 Illuminate\Routing\UrlGenerator 實例。

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

其他

abort()

abort 函式會拋出一個HTTP 例外，該例外將由例外處理程式呈現。

abort(403);

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

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

abort_if()

如果給定的布林值運算式評估為 true，abort_if 函式會拋出一個 HTTP 例外。

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

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

abort_unless()

如果給定的布林值運算式評估為 false，abort_unless 函式會拋出一個 HTTP 例外。

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

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

app()

app 函式會回傳服務容器實例。

$container = app();

你可以傳遞類別或介面名稱，以便從容器解析它。

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

auth()

auth 函式會回傳一個驗證器實例。你可以使用它來替代 Auth Facade。

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

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

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

back()

back 函式會產生一個重新導向 HTTP 回應，將使用者重新導向到他們之前的位置。

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

bcrypt()

bcrypt 函式使用 Bcrypt 雜湊給定的值。你可以使用此函式來替代 Hash Facade。

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

blank()

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

blank('');
blank('   ');
blank(null);
blank(collect());
 
// true
 
blank(0);
blank(true);
blank(false);
 
// false

如需 blank 的反向操作，請參閱filled 方法。

broadcast()

broadcast 函式會將給定的事件廣播給其監聽器。

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

cache()

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

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

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

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

class_uses_recursive()

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

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

collect()

collect 函式會從給定的值建立一個集合實例。

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

config()

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

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

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

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

context()

context 函式會從目前的內容取得值。如果內容鍵不存在，可以指定並回傳預設值。

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

你可以透過傳遞鍵 / 值對的陣列來設定內容值。

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

cookie()

cookie 函式會建立一個新的Cookie 實例。

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

csrf_field()

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

{{ csrf_field() }}

csrf_token()

csrf_token 函式會擷取目前 CSRF 權杖的值。

$token = csrf_token();

decrypt()

decrypt 函式會解密給定的值。你可以使用此函式來替代 Crypt Facade。

$password = decrypt($value);

dd()

dd 函式會傾印給定的變數，並結束腳本的執行。

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

如果你不想停止腳本的執行，請改用dump 函式。

dispatch()

dispatch 函式會將給定的工作推送至 Laravel 工作佇列。

dispatch(new App\Jobs\SendEmails);

dispatch_sync()

dispatch_sync 函式會將給定的工作推送至同步佇列，以便立即處理。

dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函式會傾印給定的變數。

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

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

encrypt()

encrypt 函式會加密給定的值。你可以使用此函式來替代 Crypt Facade。

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

env()

env 函式會擷取環境變數的值，或回傳預設值。

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

event()

event 函式會將給定的事件分派給其監聽器。

event(new UserRegistered($user));

fake()

fake 函式會從容器解析一個Faker單例，這在模型工廠、資料庫播種、測試和原型檢視中建立假資料時很有用。

@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 函式來指定地區設定。每個地區設定都會解析一個單獨的單例。

fake('nl_NL')->name()

filled()

filled 函式會判斷給定的值是否不是「空白」。

filled(0);
filled(true);
filled(false);
 
// true
 
filled('');
filled('   ');
filled(null);
filled(collect());
 
// false

如需 filled 的反向操作，請參閱blank 方法。

info()

info 函式會將資訊寫入你應用程式的日誌。

info('Some helpful information!');

也可以將上下文資料的陣列傳遞給函式。

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

literal()

literal 函式會建立一個新的stdClass 實例，並將給定的命名引數作為屬性。

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

logger()

logger 函式可用於將 debug 層級的訊息寫入日誌。

logger('Debug message');

也可以將上下文資料的陣列傳遞給函式。

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

如果沒有將任何值傳遞給函式，則會回傳一個記錄器實例。

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

method_field()

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

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

now()

now 函式會為目前時間建立一個新的 Illuminate\Support\Carbon 實例。

$now = now();

old()

old 函式會擷取快閃到 Session 中的舊輸入值。

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

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

{{ old('name', $user->name) }}
 
// Is equivalent to...
 
{{ old('name', $user) }}

once()

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

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}
 
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)

當從物件實例中執行 once 函式時，快取的結果將會對該物件實例來說是唯一的。

<?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，而不會導致錯誤。

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

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

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

policy()

policy 方法會為給定的類別擷取Policy實例。

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

redirect()

redirect 函式會回傳一個重新導向 HTTP 回應，如果沒有使用任何引數呼叫，則會回傳重新導向器實例。

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

report()

report 函式會使用你的例外處理器回報例外狀況。

report($e);

report 函式也接受字串作為引數。當將字串傳遞給此函式時，函式會建立一個例外狀況，並將給定的字串作為其訊息。

report('Something went wrong.');

report_if()

如果給定的條件為 true，report_if 函式會使用你的例外處理器回報例外狀況。

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

report_unless()

如果給定的條件為 false，report_unless 函式會使用你的例外處理器回報例外狀況。

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

request()

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

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

rescue()

rescue 函式會執行給定的閉包，並捕獲執行期間發生的任何例外狀況。所有捕獲的例外狀況都會被傳送到你的例外處理器；但是，請求將繼續處理。

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

你也可以傳遞第二個引數給 rescue 函式。如果執行閉包時發生例外狀況，此引數將會是應該回傳的「預設」值。

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

可以提供一個 report 引數給 rescue 函式，以決定是否應該透過 report 函式回報例外狀況。

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

resolve()

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

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

response()

response 函式會建立一個回應實例，或取得回應工廠的實例。

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

retry()

retry 函式會嘗試執行給定的回呼，直到達到給定的最大嘗試次數閾值。如果回呼沒有拋出例外狀況，將會回傳其回傳值。如果回呼拋出例外狀況，將會自動重試。如果超過最大嘗試次數，將會拋出例外狀況。

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

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

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