輔助函式
簡介
Laravel 包含各種全域性“輔助” PHP 函式。許多函式都被框架本身使用;當然,如果你覺得方便,也可以在自己的應用程式中使用它們。
可用方法
陣列和物件
Arr::accessible Arr::add Arr::array Arr::boolean Arr::collapse Arr::crossJoin Arr::divide Arr::dot Arr::every Arr::except Arr::exceptValues Arr::exists Arr::first Arr::flatten Arr::float Arr::forget Arr::from Arr::get Arr::has Arr::hasAll Arr::hasAny Arr::integer Arr::isAssoc Arr::isList Arr::join Arr::keyBy Arr::last Arr::map Arr::mapSpread Arr::mapWithKeys Arr::only Arr::onlyValues Arr::partition Arr::pluck Arr::prepend Arr::prependKeysWith Arr::pull Arr::push Arr::query Arr::random Arr::reject Arr::select Arr::set Arr::shuffle Arr::sole Arr::some Arr::sort Arr::sortDesc Arr::sortRecursive Arr::string Arr::take Arr::toCssClasses Arr::toCssStyles Arr::undot Arr::where Arr::whereNotNull Arr::wrap data_fill data_get data_set data_forget head last
數字
Number::abbreviate Number::clamp Number::currency Number::defaultCurrency Number::defaultLocale Number::fileSize Number::forHumans Number::format Number::ordinal Number::pairs Number::parseInt Number::parseFloat Number::percentage Number::spell Number::spellOrdinal Number::trim Number::useLocale Number::withLocale Number::useCurrency Number::withCurrency
路徑
URLs
雜項
abort abort_if abort_unless app auth back bcrypt blank broadcast broadcast_if broadcast_unless cache class_uses_recursive collect config context cookie csrf_field csrf_token decrypt dd dispatch dispatch_sync dump encrypt env event fake filled info literal logger method_field now old once optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with when
陣列和物件
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// true11 12$isAccessible = Arr::accessible('abc');13 14// false15 16$isAccessible = Arr::accessible(new stdClass);17 18// false
Arr::add()
Arr::add 方法向陣列新增給定的鍵值對(如果鍵不存在或設定為 null)。
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]
Arr::array()
Arr::array 方法使用“點”符號從深度巢狀的陣列中檢索值(與 Arr::get() 相同),但如果請求的值不是 array,則會丟擲 InvalidArgumentException 異常。
1use Illuminate\Support\Arr; 2 3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']]; 4 5$value = Arr::array($array, 'languages'); 6 7// ['PHP', 'Ruby'] 8 9$value = Arr::array($array, 'name');10 11// throws InvalidArgumentException
Arr::boolean()
Arr::boolean 方法使用“點”符號從深度巢狀的陣列中檢索值,但如果請求的值不是 boolean,則會丟擲 InvalidArgumentException 異常。
1use Illuminate\Support\Arr; 2 3$array = ['name' => 'Joe', 'available' => true]; 4 5$value = Arr::boolean($array, 'available'); 6 7// true 8 9$value = Arr::boolean($array, 'name');10 11// throws InvalidArgumentException
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]
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*/
Arr::divide()
Arr::divide 方法返回兩個陣列:一個包含給定陣列的鍵,另一個包含給定陣列的值。
1use Illuminate\Support\Arr;2 3[$keys, $values] = Arr::divide(['name' => 'Desk']);4 5// $keys: ['name']6 7// $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]
Arr::every()
Arr::every 方法確保陣列中的所有值都透過給定的真值測試。
1use Illuminate\Support\Arr; 2 3$array = [1, 2, 3]; 4 5Arr::every($array, fn ($i) => $i > 0); 6 7// true 8 9Arr::every($array, fn ($i) => $i > 2);10 11// false
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']
Arr::exceptValues()
Arr::exceptValues 方法從陣列中移除指定的值。
1use Illuminate\Support\Arr;2 3$array = ['foo', 'bar', 'baz', 'qux'];4 5$filtered = Arr::exceptValues($array, ['foo', 'baz']);6 7// ['bar', 'qux']
你也可以將 strict 引數設為 true,以在過濾時使用嚴格型別比較。
1use Illuminate\Support\Arr;2 3$array = [1, '1', 2, '2'];4 5$filtered = Arr::exceptValues($array, [1, 2], strict: true);6 7// ['1', '2']
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
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
可以將預設值作為第三個引數傳遞給該方法。如果沒有任何值透過真值測試,則返回該預設值。
1use Illuminate\Support\Arr;2 3$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']
Arr::float()
Arr::float 方法使用“點”符號從深度巢狀的陣列中檢索值,但如果請求的值不是 float,則會丟擲 InvalidArgumentException 異常。
1use Illuminate\Support\Arr; 2 3$array = ['name' => 'Joe', 'balance' => 123.45]; 4 5$value = Arr::float($array, 'balance'); 6 7// 123.45 8 9$value = Arr::float($array, 'name');10 11// throws InvalidArgumentException
Arr::forget()
Arr::forget 方法使用“點”符號從深度巢狀的陣列中移除給定的鍵值對。
1use Illuminate\Support\Arr;2 3$array = ['products' => ['desk' => ['price' => 100]]];4 5Arr::forget($array, 'products.desk');6 7// ['products' => []]
Arr::from()
Arr::from 方法將各種輸入型別轉換為普通 PHP 陣列。它支援多種輸入型別,包括陣列、物件和一些常見的 Laravel 介面,如 Arrayable、Enumerable、Jsonable 和 JsonSerializable。此外,它還能處理 Traversable 和 WeakMap 例項。
1use Illuminate\Support\Arr; 2 3Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar'] 4 5class TestJsonableObject implements Jsonable 6{ 7 public function toJson($options = 0) 8 { 9 return json_encode(['foo' => 'bar']);10 }11}12 13Arr::from(new TestJsonableObject); // ['foo' => 'bar']
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
Arr::get 方法還接受一個預設值,如果指定的鍵不存在於陣列中,則返回該值。
1use Illuminate\Support\Arr;2 3$discount = Arr::get($array, 'products.desk.discount', 0);4 5// 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
Arr::hasAll()
Arr::hasAll 方法確定所有指定鍵是否使用“點”符號存在於給定陣列中。
1use Illuminate\Support\Arr;2 3$array = ['name' => 'Taylor', 'language' => 'PHP'];4 5Arr::hasAll($array, ['name']); // true6Arr::hasAll($array, ['name', 'language']); // true7Arr::hasAll($array, ['name', 'IDE']); // 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// true12 13$contains = Arr::hasAny($array, ['category', 'product.discount']);14 15// false
Arr::integer()
Arr::integer 方法使用“點”符號從深度巢狀的陣列中檢索值,但如果請求的值不是 int,則會丟擲 InvalidArgumentException 異常。
1use Illuminate\Support\Arr; 2 3$array = ['name' => 'Joe', 'age' => 42]; 4 5$value = Arr::integer($array, 'age'); 6 7// 42 8 9$value = Arr::integer($array, 'name');10 11// throws InvalidArgumentException
Arr::isAssoc()
如果給定的陣列是關聯陣列,Arr::isAssoc 方法返回 true。如果陣列沒有從零開始的連續數字鍵,則認為該陣列是“關聯”的。
1use Illuminate\Support\Arr;2 3$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);4 5// true6 7$isAssoc = Arr::isAssoc([1, 2, 3]);8 9// false
Arr::isList()
如果給定陣列的鍵是從零開始的連續整數,Arr::isList 方法返回 true。
1use Illuminate\Support\Arr;2 3$isList = Arr::isList(['foo', 'bar', 'baz']);4 5// true6 7$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);8 9// 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
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*/
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
可以將預設值作為第三個引數傳遞給該方法。如果沒有任何值透過真值測試,則返回該預設值。
1use Illuminate\Support\Arr;2 3$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']
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*/
Arr::mapWithKeys()
Arr::mapWithKeys 方法遍歷陣列並將每個值傳遞給給定的回撥。回撥應返回一個包含單個鍵值對的關聯陣列。
1use Illuminate\Support\Arr; 2 3$array = [ 4 [ 5 'name' => 'John', 6 'department' => 'Sales', 8 ], 9 [10 'name' => 'Jane',11 'department' => 'Marketing',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*/
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]
Arr::onlyValues()
Arr::onlyValues 方法僅從陣列中返回指定的值。
1use Illuminate\Support\Arr;2 3$array = ['foo', 'bar', 'baz', 'qux'];4 5$filtered = Arr::onlyValues($array, ['foo', 'baz']);6 7// ['foo', 'baz']
你也可以將 strict 引數設為 true,以在過濾時使用嚴格型別比較。
1use Illuminate\Support\Arr;2 3$array = [1, '1', 2, '2'];4 5$filtered = Arr::onlyValues($array, [1, 2], strict: true);6 7// [1, 2]
Arr::partition()
Arr::partition 方法可以與 PHP 陣列解構相結合,將透過給定真值測試的元素與未透過的元素分離開來。
1<?php 2 3use Illuminate\Support\Arr; 4 5$numbers = [1, 2, 3, 4, 5, 6]; 6 7[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) { 8 return $i < 3; 9});10 11dump($underThree);12 13// [1, 2]14 15dump($equalOrAboveThree);16 17// [3, 4, 5, 6]
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']
你也可以指定希望如何對結果列表進行鍵控。
1use Illuminate\Support\Arr;2 3$names = Arr::pluck($array, 'developer.name', 'developer.id');4 5// [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']
如果需要,可以指定用於該值的鍵。
1use Illuminate\Support\Arr;2 3$array = ['price' => 100];4 5$array = Arr::prepend($array, 'Desk', 'name');6 7// ['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*/
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: Desk8 9// $array: ['price' => 100]
可以將預設值作為第三個引數傳遞給該方法。如果鍵不存在,則返回該預設值。
1use Illuminate\Support\Arr;2 3$value = Arr::pull($array, $key, $default);
Arr::push()
Arr::push 方法使用“點”符號將項推入陣列。如果給定鍵處不存在陣列,則會建立一個。
1use Illuminate\Support\Arr;2 3$array = [];4 5Arr::push($array, 'office.furniture', 'Desk');6 7// $array: ['office' => ['furniture' => ['Desk']]]
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
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)
你也可以將希望返回的項數作為可選的第二個引數指定。請注意,提供此引數將返回一個數組,即使只想返回一個項。
1use Illuminate\Support\Arr;2 3$items = Arr::random($array, 2);4 5// [2, 5] - (retrieved randomly)
Arr::reject()
Arr::reject 方法使用給定的閉包從陣列中移除項。
1use Illuminate\Support\Arr;2 3$array = [100, '200', 300, '400', 500];4 5$filtered = Arr::reject($array, function (string|int $value, int $key) {6 return is_string($value);7});8 9// [0 => 100, 2 => 300, 4 => 500]
Arr::select()
Arr::select 方法從陣列中選擇一個值陣列。
1use Illuminate\Support\Arr; 2 3$array = [ 4 ['id' => 1, 'name' => 'Desk', 'price' => 200], 5 ['id' => 2, 'name' => 'Table', 'price' => 150], 6 ['id' => 3, 'name' => 'Chair', 'price' => 300], 7]; 8 9Arr::select($array, ['name', 'price']);10 11// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]
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]]]
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)
Arr::sole()
Arr::sole 方法使用給定的閉包從陣列中檢索單個值。如果陣列中有多個值匹配給定的真值測試,則丟擲 Illuminate\Support\MultipleItemsFoundException 異常。如果沒有匹配的值,則丟擲 Illuminate\Support\ItemNotFoundException 異常。
1use Illuminate\Support\Arr;2 3$array = ['Desk', 'Table', 'Chair'];4 5$value = Arr::sole($array, fn (string $value) => $value === 'Desk');6 7// 'Desk'
Arr::some()
Arr::some 方法確保陣列中至少有一個值透過給定的真值測試。
1use Illuminate\Support\Arr;2 3$array = [1, 2, 3];4 5Arr::some($array, fn ($i) => $i > 2);6 7// true
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']
你也可以根據給定閉包的結果對陣列進行排序。
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*/
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']
你也可以根據給定閉包的結果對陣列進行排序。
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*/
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*/
如果你想以倒序對結果進行排序,可以使用 Arr::sortRecursiveDesc 方法。
1$sorted = Arr::sortRecursiveDesc($array);
Arr::string()
Arr::string 方法使用“點”符號從深度巢狀的陣列中檢索值,但如果請求的值不是 string,則丟擲 InvalidArgumentException 異常。
1use Illuminate\Support\Arr; 2 3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']]; 4 5$value = Arr::string($array, 'name'); 6 7// Joe 8 9$value = Arr::string($array, 'languages');10 11// throws InvalidArgumentException
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]
你也可以傳遞一個負整數,從陣列末尾獲取指定數量的項。
1$array = [0, 1, 2, 3, 4, 5];2 3$chunk = Arr::take($array, -2);4 5// [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*/
Arr::toCssStyles()
Arr::toCssStyles 方法有條件地編譯 CSS 樣式字串。該方法接受一個 CSS 宣告陣列,其中陣列鍵包含你希望新增的 CSS 宣告,而值是布林表示式。如果陣列元素具有數字鍵,它將始終包含在編譯後的 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*/
此方法支援 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']]
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']
Arr::whereNotNull()
Arr::whereNotNull 方法從給定陣列中移除所有 null 值。
1use Illuminate\Support\Arr;2 3$array = [0, null];4 5$filtered = Arr::whereNotNull($array);6 7// [0 => 0]
Arr::wrap()
Arr::wrap 方法將給定值包裝在陣列中。如果給定值已經是陣列,則原樣返回。
1use Illuminate\Support\Arr;2 3$string = 'Laravel';4 5$array = Arr::wrap($string);6 7// ['Laravel']
如果給定值為 null,則返回空陣列。
1use Illuminate\Support\Arr;2 3$array = Arr::wrap(null);4 5// []
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]]]
該函式還接受星號作為萬用字元,並將相應地填充目標。
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_get()
data_get 函式使用“點”符號從巢狀陣列或物件中檢索值。
1$data = ['products' => ['desk' => ['price' => 100]]];2 3$price = data_get($data, 'products.desk.price');4 5// 100
data_get 函式還接受一個預設值,如果未找到指定鍵,則返回該值。
1$discount = data_get($data, 'products.desk.discount', 0);2 3// 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'];
{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
data_set()
data_set 函式使用“點”符號在巢狀陣列或物件中設定值。
1$data = ['products' => ['desk' => ['price' => 100]]];2 3data_set($data, 'products.desk.price', 200);4 5// ['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*/
預設情況下,任何現有值都會被覆蓋。如果你只想在值不存在時設定它,可以將 false 作為第四個引數傳遞給該函式。
1$data = ['products' => ['desk' => ['price' => 100]]];2 3data_set($data, 'products.desk.price', 200, overwrite: false);4 5// ['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' => []]]
該函式還接受使用星號的萬用字元,並將相應地移除目標上的值。
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*/
head()
head 函式返回給定陣列中的第一個元素。如果陣列為空,則返回 false。
1$array = [100, 200, 300];2 3$first = head($array);4 5// 100
last()
last 函式返回給定陣列中的最後一個元素。如果陣列為空,則返回 false。
1$array = [100, 200, 300];2 3$last = last($array);4 5// 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// 490K10 11$number = Number::abbreviate(1230000, precision: 2);12 13// 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// 1010 11$number = Number::clamp(10, min: 10, max: 100);12 13// 1014 15$number = Number::clamp(20, min: 10, max: 100);16 17// 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.0010 11$currency = Number::currency(1000, in: 'EUR', locale: 'de');12 13// 1.000,00 €14 15$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);16 17// 1.000 €
Number::defaultCurrency()
Number::defaultCurrency 方法返回 Number 類使用的預設貨幣。
1use Illuminate\Support\Number;2 3$currency = Number::defaultCurrency();4 5// USD
Number::defaultLocale()
Number::defaultLocale 方法返回 Number 類使用的預設語言環境。
1use Illuminate\Support\Number;2 3$locale = Number::defaultLocale();4 5// 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 MB10 11$size = Number::fileSize(1024, precision: 2);12 13// 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 thousand10 11$number = Number::forHumans(1230000, precision: 2);12 13// 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.0010 11$number = Number::format(100000.123, maxPrecision: 2);12 13// 100,000.1214 15$number = Number::format(100000, locale: 'de');16 17// 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// 2nd10 11$number = Number::ordinal(21);12 13// 21st
Number::pairs()
Number::pairs 方法根據指定的範圍和步長值生成數字對(子範圍)陣列。此方法有助於將較大的數字範圍劃分為較小、易於管理的子範圍,以用於分頁或批次處理任務。pairs 方法返回陣列的陣列,其中每個內部陣列代表一個數字對(子範圍)。
1use Illuminate\Support\Number;2 3$result = Number::pairs(25, 10);4 5// [[0, 9], [10, 19], [20, 25]]6 7$result = Number::pairs(25, 10, offset: 0);8 9// [[0, 10], [10, 20], [20, 25]]
Number::parseInt()
Number::parseInt 方法根據指定的語言環境將字串解析為整數。
1use Illuminate\Support\Number;2 3$result = Number::parseInt('10.123');4 5// (int) 106 7$result = Number::parseInt('10,123', locale: 'fr');8 9// (int) 10
Number::parseFloat()
Number::parseFloat 方法根據指定的語言環境將字串解析為浮點數。
1use Illuminate\Support\Number;2 3$result = Number::parseFloat('10');4 5// (float) 10.06 7$result = Number::parseFloat('10', locale: 'fr');8 9// (float) 10.0
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%
Number::spell()
Number::spell 方法將給定數字轉換為單詞字串。
1use Illuminate\Support\Number;2 3$number = Number::spell(102);4 5// one hundred and two6 7$number = Number::spell(88, locale: 'fr');8 9// quatre-vingt-huit
after 引數允許你指定一個值,在此值之後所有數字都應拼寫出來。
1$number = Number::spell(10, after: 10);2 3// 104 5$number = Number::spell(11, after: 10);6 7// eleven
until 引數允許你指定一個值,在此值之前所有數字都應拼寫出來。
1$number = Number::spell(5, until: 10);2 3// five4 5$number = Number::spell(10, until: 10);6 7// 10
Number::spellOrdinal()
Number::spellOrdinal 方法將數字的序數表示形式作為單詞字串返回。
1use Illuminate\Support\Number; 2 3$number = Number::spellOrdinal(1); 4 5// first 6 7$number = Number::spellOrdinal(2); 8 9// second10 11$number = Number::spellOrdinal(21);12 13// twenty-first
Number::trim()
Number::trim 方法移除給定數字小數點後任何多餘的零。
1use Illuminate\Support\Number;2 3$number = Number::trim(12.0);4 5// 126 7$number = Number::trim(12.30);8 9// 12.3
Number::useLocale()
Number::useLocale 方法全域性設定預設數字語言環境,這會影響後續呼叫 Number 類方法時數字和貨幣的格式化方式。
1use Illuminate\Support\Number;2 3/**4 * Bootstrap any application services.5 */6public function boot(): void7{8 Number::useLocale('de');9}
Number::withLocale()
Number::withLocale 方法使用指定的語言環境執行給定的閉包,並在回撥執行後恢復原始語言環境。
1use Illuminate\Support\Number;2 3$number = Number::withLocale('de', function () {4 return Number::format(1500);5});
Number::useCurrency()
Number::useCurrency 方法全域性設定預設數字貨幣,這會影響後續呼叫 Number 類方法時貨幣的格式化方式。
1use Illuminate\Support\Number;2 3/**4 * Bootstrap any application services.5 */6public function boot(): void7{8 Number::useCurrency('GBP');9}
Number::withCurrency()
Number::withCurrency 方法使用指定的貨幣執行給定的閉包,並在回撥執行後恢復原始貨幣。
1use Illuminate\Support\Number;2 3$number = Number::withCurrency('GBP', function () {4 // ...5});
路徑
app_path()
app_path 函式返回應用程式 app 目錄的完全限定路徑。你也可以使用 app_path 函式生成相對於應用程式目錄的檔案的完全限定路徑。
1$path = app_path();2 3$path = app_path('Http/Controllers/Controller.php');
base_path()
base_path 函式返回應用程式根目錄的完全限定路徑。你也可以使用 base_path 函式生成相對於專案根目錄的給定檔案的完全限定路徑。
1$path = base_path();2 3$path = base_path('vendor/bin');
config_path()
config_path 函式返回應用程式 config 目錄的完全限定路徑。你也可以使用 config_path 函式生成應用程式配置目錄中給定檔案的完全限定路徑。
1$path = config_path();2 3$path = config_path('app.php');
database_path()
database_path 函式返回應用程式 database 目錄的完全限定路徑。你也可以使用 database_path 函式生成資料庫目錄中給定檔案的完全限定路徑。
1$path = database_path();2 3$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');
預設情況下,Laravel 應用程式骨架不包含 lang 目錄。如果您想自定義 Laravel 的語言檔案,可以透過 lang:publish Artisan 命令釋出它們。
public_path()
public_path 函式返回應用程式 public 目錄的完全限定路徑。你也可以使用 public_path 函式生成公共目錄內給定檔案的完全限定路徑。
1$path = public_path();2 3$path = public_path('css/app.css');
resource_path()
resource_path 函式返回應用程式 resources 目錄的完全限定路徑。你也可以使用 resource_path 函式生成資源目錄內給定檔案的完全限定路徑。
1$path = resource_path();2 3$path = resource_path('sass/app.scss');
storage_path()
storage_path 函式返回應用程式 storage 目錄的完全限定路徑。你也可以使用 storage_path 函式生成儲存目錄內給定檔案的完全限定路徑。
1$path = storage_path();2 3$path = storage_path('app/file.txt');
URLs
action()
action 函式為給定的控制器動作生成 URL。
1use App\Http\Controllers\HomeController;2 3$url = action([HomeController::class, 'index']);
如果該方法接受路由引數,可以將它們作為第二個引數傳遞給該方法。
1$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
asset 函式使用當前請求的方案(HTTP 或 HTTPS)為資產生成 URL。
1$url = asset('img/photo.jpg');
你可以透過在 .env 檔案中設定 ASSET_URL 變數來配置資產 URL 主機。如果你將資產託管在 Amazon S3 或其他 CDN 等外部服務上,這會很有用。
1// ASSET_URL=http://example.com/assets2 3$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
route 函式為給定的 命名路由 生成 URL。
1$url = route('route.name');
如果路由接受引數,可以將它們作為第二個引數傳遞給函式。
1$url = route('route.name', ['id' => 1]);
預設情況下,route 函式生成絕對 URL。如果你想生成相對 URL,可以將 false 作為第三個引數傳遞給函式。
1$url = route('route.name', ['id' => 1], false);
secure_asset()
secure_asset 函式使用 HTTPS 為資產生成 URL。
1$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]);
to_action()
to_action 函式為給定的控制器動作生成 重定向 HTTP 響應。
1use App\Http\Controllers\UserController;2 3return to_action([UserController::class, 'show'], ['user' => 1]);
如果需要,你可以將應分配給重定向的 HTTP 狀態程式碼以及任何額外的響應頭作為第三和第四個引數傳遞給 to_action 方法。
1return to_action(2 [UserController::class, 'show'],3 ['user' => 1],4 302,5 ['X-Framework' => 'Laravel']6);
to_route()
to_route 函式為給定的 命名路由 生成 重定向 HTTP 響應。
1return to_route('users.show', ['user' => 1]);
如果需要,你可以將應分配給重定向的 HTTP 狀態程式碼以及任何額外的響應頭作為第三和第四個引數傳遞給 to_route 方法。
1return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
uri()
uri 函式為給定 URI 生成一個 流式 URI 例項。
1$uri = uri('https://example.com')2 ->withPath('/users')3 ->withQuery(['page' => 1]);
如果 uri 函式接收到一個包含可呼叫控制器和方法對的陣列,該函式將為控制器方法的路由路徑建立一個 Uri 例項。
1use App\Http\Controllers\UserController;2 3$uri = uri([UserController::class, 'show'], ['user' => $user]);
如果控制器是可呼叫的,你只需提供控制器類名即可。
1use App\Http\Controllers\UserIndexController;2 3$uri = uri(UserIndexController::class);
如果傳遞給 uri 函式的值匹配 命名路由 的名稱,則會為該路由的路徑生成一個 Uri 例項。
1$uri = uri('users.show', ['user' => $user]);
url()
url 函式為給定路徑生成完全限定的 URL。
1$url = url('user/profile');2 3$url = url('user/profile', [1]);
如果沒有提供路徑,則返回 Illuminate\Routing\UrlGenerator 例項。
1$current = url()->current();2 3$full = url()->full();4 5$previous = url()->previous();
有關使用 url 函式的更多資訊,請查閱 URL 生成文件。
雜項
abort()
abort 函式丟擲 一個 HTTP 異常,該異常將由 異常處理器 渲染。
1abort(403);
你還可以提供異常訊息和應傳送到瀏覽器的自定義 HTTP 響應頭。
1abort(403, 'Unauthorized.', $headers);
abort_if()
如果給定的布林表示式計算結果為 true,abort_if 函式將丟擲 HTTP 異常。
1abort_if(! Auth::user()->isAdmin(), 403);
與 abort 方法一樣,你也可以提供異常的響應文字作為第三個引數,並將自定義響應頭的陣列作為第四個引數傳遞給函式。
abort_unless()
如果給定的布林表示式計算結果為 false,abort_unless 函式將丟擲 HTTP 異常。
1abort_unless(Auth::user()->isAdmin(), 403);
與 abort 方法一樣,你也可以提供異常的響應文字作為第三個引數,並將自定義響應頭的陣列作為第四個引數傳遞給函式。
app()
app 函式返回 服務容器 例項。
1$container = app();
你可以傳遞類或介面名稱以從容器中解析它。
1$api = app('HelpSpot\API');
auth()
auth 函式返回一個 身份驗證器 例項。你可以將其用作 Auth 門面的替代方案。
1$user = auth()->user();
如果需要,你可以指定想要訪問的守衛例項。
1$user = auth('admin')->user();
back()
back 函式生成一個 重定向 HTTP 響應 到使用者的前一個位置。
1return back($status = 302, $headers = [], $fallback = '/');2 3return back();
bcrypt()
bcrypt 函式使用 Bcrypt 對給定值進行 雜湊處理。你可以將此函式用作 Hash 門面的替代方案。
1$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 的反向函式,請參見 filled 函式。
broadcast()
broadcast 函式將給定的 事件 廣播 給它的監聽器。
1broadcast(new UserRegistered($user));2 3broadcast(new UserRegistered($user))->toOthers();
broadcast_if()
如果給定的布林表示式計算結果為 true,broadcast_if 函式將 廣播 給定的 事件 給它的監聽器。
1broadcast_if($user->isActive(), new UserRegistered($user));2 3broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();
broadcast_unless()
如果給定的布林表示式計算結果為 false,broadcast_unless 函式將 廣播 給定的 事件 給它的監聽器。
1broadcast_unless($user->isBanned(), new UserRegistered($user));2 3broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();
cache()
cache 函式可用於從 快取 中獲取值。如果給定鍵不存在於快取中,則返回可選的預設值。
1$value = cache('key');2 3$value = cache('key', 'default');
你可以透過將鍵值對陣列傳遞給函式來將項新增到快取中。你還應該傳遞快取值被視為有效的秒數或持續時間。
1cache(['key' => 'value'], 300);2 3cache(['key' => 'value'], now()->plus(seconds: 10));
class_uses_recursive()
class_uses_recursive 函式返回類使用的所有 trait,包括其所有父類使用的 trait。
1$traits = class_uses_recursive(App\Models\User::class);
collect()
collect 函式從給定值建立一個 集合 例項。
1$collection = collect(['Taylor', 'Abigail']);
config()
config 函式獲取 配置 變數的值。配置值可以使用“點”語法訪問,其中包括檔名和你想訪問的選項。你也可以提供預設值,如果配置選項不存在,則返回該值。
1$value = config('app.timezone');2 3$value = config('app.timezone', $default);
你可以透過傳遞鍵值對陣列在執行時設定配置變數。但是,請注意,此函式僅影響當前請求的配置值,並不會更新你的實際配置值。
1config(['app.debug' => true]);
context()
context 函式從當前 上下文 獲取值。你也可以提供一個預設值,如果上下文鍵不存在,則返回該值。
1$value = context('trace_id');2 3$value = context('trace_id', $default);
你可以透過傳遞鍵值對陣列來設定上下文值。
1use Illuminate\Support\Str;2 3context(['trace_id' => Str::uuid()->toString()]);
cookie()
cookie 函式建立一個新的 Cookie 例項。
1$cookie = cookie('name', 'value', $minutes);
csrf_field()
csrf_field 函式生成一個包含 CSRF 令牌值的 HTML hidden 輸入欄位。例如,使用 Blade 語法。
1{{ csrf_field() }}
csrf_token()
csrf_token 函式檢索當前 CSRF 令牌的值。
1$token = csrf_token();
decrypt()
decrypt 函式對給定值進行 解密。你可以將此函式用作 Crypt 門面的替代方案。
1$password = decrypt($value);
關於 decrypt 的反向函式,請參見 encrypt 函式。
dd()
dd 函式轉儲給定的變數並終止指令碼的執行。
1dd($value);2 3dd($value1, $value2, $value3, ...);
如果你不想停止指令碼的執行,請改用 dump 函式。
dispatch()
dispatch 函式將給定的 作業 推送到 Laravel 作業佇列。
1dispatch(new App\Jobs\SendEmails);
dispatch_sync()
dispatch_sync 函式將給定的作業推送到 同步 佇列,以便立即處理。
1dispatch_sync(new App\Jobs\SendEmails);
dump()
dump 函式轉儲給定的變數。
1dump($value);2 3dump($value1, $value2, $value3, ...);
如果你想在轉儲變數後停止執行指令碼,請改用 dd 函式。
encrypt()
encrypt 函式對給定值進行 加密。你可以將此函式用作 Crypt 門面的替代方案。
1$secret = encrypt('my-secret-value');
關於 encrypt 的反向函式,請參見 decrypt 函式。
env()
env 函式檢索 環境變數 的值或返回預設值。
1$env = env('APP_ENV');2 3$env = env('APP_ENV', 'production');
如果你在部署過程中執行了 config:cache 命令,請確保僅從配置內部呼叫 env 函式。一旦配置被快取,將不會載入 .env 檔案,所有對 env 函式的呼叫都將返回外部環境變數(如伺服器級或系統級環境變數)或 null。
event()
event 函式將給定的 事件 分發給它的監聽器。
1event(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
預設情況下,fake 函式將利用 config/app.php 配置中的 app.faker_locale 配置選項。通常,此配置選項透過 APP_FAKER_LOCALE 環境變數設定。你也可以透過將語言環境傳遞給 fake 函式來指定它。每個語言環境都將解析一個單獨的單例。
1fake('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 的反向函式,請參見 blank 函式。
info()
info 函式將資訊寫入應用程式的 日誌。
1info('Some helpful information!');
上下文資料陣列也可以傳遞給該函式。
1info('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']
logger()
logger 函式可用於將 debug 級別訊息寫入 日誌。
1logger('Debug message');
上下文資料陣列也可以傳遞給該函式。
1logger('User has logged in.', ['id' => $user->id]);
如果沒有傳遞值給函式,則返回一個 記錄器 例項。
1logger()->error('You are not allowed here.');
method_field()
method_field 函式生成一個 HTML hidden 輸入欄位,其中包含表單 HTTP 動詞的欺騙值。例如,使用 Blade 語法。
1<form method="POST">2 {{ method_field('DELETE') }}3</form>
now()
now 函式為當前時間建立一個新的 Illuminate\Support\Carbon 例項。
1$now = now();
old()
1$value = old('value');2 3$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) }}
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)
當從物件例項內執行 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)
optional()
optional 函式接受任何引數,並允許你訪問該物件的屬性或呼叫方法。如果給定物件為 null,屬性和方法將返回 null 而不會導致錯誤。
1return optional($user->address)->street;2 3{!! old('name', optional($user)->name) !!}
optional 函式還接受一個閉包作為其第二個引數。如果作為第一個引數提供的值不為 null,則將呼叫該閉包。
1return optional(User::find($id), function (User $user) {2 return $user->name;3});
policy()
policy 方法檢索給定類的 策略 例項。
1$policy = policy(App\Models\User::class);
redirect()
redirect 函式返回一個 重定向 HTTP 響應,或者在沒有引數呼叫的情況下返回重定向器例項。
1return redirect($to = null, $status = 302, $headers = [], $secure = null);2 3return redirect('/home');4 5return redirect()->route('route.name');
report()
report 函式將使用你的 異常處理器 報告異常。
1report($e);
report 函式還接受字串作為引數。當函式接收到字串時,該函式將建立一個以給定字串為訊息的異常。
1report('Something went wrong.');
report_if()
如果給定的布林表示式計算結果為 true,report_if 函式將使用你的 異常處理器 報告異常。
1report_if($shouldReport, $e);2 3report_if($shouldReport, 'Something went wrong.');
report_unless()
如果給定的布林表示式計算結果為 false,report_unless 函式將使用你的 異常處理器 報告異常。
1report_unless($reportingDisabled, $e);2 3report_unless($reportingDisabled, 'Something went wrong.');
request()
request 函式返回當前的 請求 例項或從當前請求中獲取輸入欄位的值。
1$request = request();2 3$value = request('key', $default);
rescue()
rescue 函式執行給定的閉包並捕獲其執行過程中發生的任何異常。所有被捕獲的異常都將被髮送到你的 異常處理器;但是,請求將繼續處理。
1return rescue(function () {2 return $this->method();3});
你也可以將第二個引數傳遞給 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});
report 引數可以提供給 rescue 函式,以確定是否應透過 report 函式報告異常。
1return rescue(function () {2 return $this->method();3}, report: function (Throwable $throwable) {4 return $throwable instanceof InvalidArgumentException;5});
resolve()
resolve 函式使用 服務容器 將給定的類或介面名稱解析為例項。
1$api = resolve('HelpSpot\API');
response()
response 函式建立一個 響應 例項或獲取響應工廠的例項。
1return response('Hello World', 200, $headers);2 3return response()->json(['foo' => 'bar'], 200, $headers);
retry()
retry 函式嘗試執行給定的回撥,直到達到給定的最大嘗試閾值。如果回撥未丟擲異常,則返回其返回值。如果回撥丟擲異常,它將自動重試。如果超過最大嘗試次數,則丟擲異常。
1return retry(5, function () {2 // Attempt 5 times while resting 100ms between attempts...3}, 100);
如果你想手動計算嘗試之間的休眠毫秒數,可以將閉包作為第三個引數傳遞給 retry 函式。
1use Exception;2 3return retry(5, function () {4 // ...5}, function (int $attempt, Exception $exception) {6 return $attempt * 100;7});
為方便起見,你可以提供一個數組作為第一個引數給 retry 函式。此陣列將用於確定後續嘗試之間休眠的毫秒數。
1return retry([100, 200], function () {2 // Sleep for 100ms on first retry, 200ms on second retry...3});
要僅在特定條件下重試,你可以將閉包作為第四個引數傳遞給 retry 函式。
1use App\Exceptions\TemporaryException;2use Exception;3 4return retry(5, function () {5 // ...6}, 100, function (Exception $exception) {7 return $exception instanceof TemporaryException;8});
session()
session 函式可用於獲取或設定 會話 值。
1$value = session('key');
你可以透過將鍵值對陣列傳遞給函式來設定值。
1session(['chairs' => 7, 'instruments' => 3]);
如果沒有傳遞值給函式,則返回會話儲存。
1$value = session()->get('key');2 3session()->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});
如果沒有閉包傳遞給 tap 函式,你可以呼叫給定 $value 上的任何方法。無論方法定義中實際返回什麼,所呼叫方法的返回值都將始終是 $value。例如,Eloquent 的 update 方法通常返回一個整數。但是,我們可以透過將 update 方法呼叫鏈式連線到 tap 函式中,強制該方法返回模型本身。
1$user = tap($user)->update([2 'name' => $name,3 'email' => $email,4]);
要將 tap 方法新增到類中,可以將 Illuminate\Support\Traits\Tappable trait 新增到該類中。此 trait 的 tap 方法接受一個閉包作為其唯一引數。物件例項本身將被傳遞給閉包,然後由 tap 方法返回。
1return $user->tap(function (User $user) {2 // ...3});
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_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);
today()
today 函式為當前日期建立一個新的 Illuminate\Support\Carbon 例項。
1$today = today();
trait_uses_recursive()
trait_uses_recursive 函式返回一個 trait 使用的所有 trait。
1$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
如果值不為 blank,transform 函式將在給定值上執行閉包,然後返回閉包的返回值。
1$callback = function (int $value) {2 return $value * 2;3};4 5$result = transform(5, $callback);6 7// 10
可以將預設值或閉包作為第三個引數傳遞給函式。如果給定值為空白,則返回該值。
1$result = transform(null, $callback, 'The value is blank');2 3// The value is blank
validator()
validator 函式使用給定的引數建立一個新的 驗證器 例項。你可以將其用作 Validator 門面的替代方案。
1$validator = validator($data, $rules, $messages);
value()
value 函式返回它給定的值。但是,如果你傳遞一個閉包給該函式,則會執行該閉包並返回其返回的值。
1$result = value(true);2 3// true4 5$result = value(function () {6 return false;7});8 9// false
額外的引數可以傳遞給 value 函式。如果第一個引數是閉包,則額外的引數將作為引數傳遞給閉包,否則它們將被忽略。
1$result = value(function (string $name) {2 return $name;3}, 'Taylor');4 5// 'Taylor'
view()
view 函式檢索一個 檢視 例項。
1return 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// 012 13$result = with(5, null);14 15// 5
when()
如果給定的條件計算結果為 true,when 函式返回它給定的值。否則,返回 null。如果閉包作為第二個引數傳遞給該函式,則會執行該閉包並返回其返回的值。
1$value = when(true, 'Hello World');2 3$value = when(true, fn () => 'Hello World');
when 函式主要用於有條件地渲染 HTML 屬性。
1<div {!! when($condition, 'wire:poll="calculate"') !!}>2 ...3</div>
其他工具
基準測試 (Benchmarking)
有時你可能希望快速測試應用程式某些部分的效能。在這些情況下,你可以利用 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 ms10 'Scenario 2' => fn () => User::all()->count(), // 20.0 ms11]);
預設情況下,給定的回撥將執行一次(一次迭代),其持續時間將顯示在瀏覽器/控制檯中。
要多次呼叫回撥,你可以將回調應呼叫的迭代次數作為方法的第二個引數指定。多次執行回撥時,Benchmark 類將返回在所有迭代中執行回撥所需的平均毫秒數。
1Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
有時,你可能想對回撥的執行進行基準測試,同時仍獲取回撥返回的值。value 方法將返回一個元組,其中包含回撥返回的值以及執行回撥所需的毫秒數。
1[$count, $duration] = Benchmark::value(fn () => User::count());
日期和時間
Laravel 包含 Carbon,這是一個強大的日期和時間操作庫。要建立新的 Carbon 例項,可以呼叫 now 函式。此函式在你的 Laravel 應用程式中是全域性可用的。
1$now = now();
或者,你可以使用 Illuminate\Support\Carbon 類建立新的 Carbon 例項。
1use Illuminate\Support\Carbon;2 3$now = Carbon::now();
Laravel 還透過 plus 和 minus 方法增強了 Carbon 例項,允許輕鬆操作例項的日期和時間。
1return now()->plus(minutes: 5);2return now()->plus(hours: 8);3return now()->plus(weeks: 4);4 5return now()->minus(minutes: 5);6return now()->minus(hours: 8);7return now()->minus(weeks: 4);
關於 Carbon 及其功能的深入討論,請查閱 官方 Carbon 文件。
間隔函式
Laravel 還提供了 milliseconds、seconds、minutes、hours、days、weeks、months 和 years 函式,它們返回 CarbonInterval 例項,這些例項擴充套件了 PHP 的 DateInterval 類。這些函式可以在 Laravel 接受 DateInterval 例項的任何地方使用。
1use Illuminate\Support\Facades\Cache;2 3use function Illuminate\Support\{minutes};4 5Cache::put('metrics', $metrics, minutes(10));
延遲函式 (Deferred Functions)
雖然 Laravel 的 佇列作業 允許你將任務排隊以進行後臺處理,但有時你可能有一些簡單的任務想要延遲,而無需配置或維護長時間執行的佇列工作程式。
延遲函式允許你將閉包的執行延遲到 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});
預設情況下,僅當呼叫 Illuminate\Support\defer 的 HTTP 響應、Artisan 命令或排隊作業成功完成時,才會執行延遲函式。這意味著如果請求導致 4xx 或 5xx HTTP 響應,則不會執行延遲函式。如果你希望延遲函式始終執行,可以將 always 方法鏈式連線到你的延遲函式上。
1defer(fn () => Metrics::reportOrder($order))->always();
如果你安裝了 Swoole PHP 擴充套件,Laravel 的 defer 函式可能會與 Swoole 自身的全域性 defer 函式衝突,從而導致 Web 伺服器錯誤。請確保透過顯式名稱空間呼叫 Laravel 的 defer 輔助函式:use function Illuminate\Support\defer;。
取消延遲函式
如果需要在延遲函式執行前取消它,可以使用 forget 方法按名稱取消函式。要命名延遲函式,請為 Illuminate\Support\defer 函式提供第二個引數。
1defer(fn () => Metrics::report(), 'reportMetrics');2 3defer()->forget('reportMetrics');
在測試中停用延遲函式
編寫測試時,停用延遲函式可能很有用。你可以在測試中呼叫 withoutDefer,指示 Laravel 立即呼叫所有延遲函式。
1test('without defer', function () {2 $this->withoutDefer();3 4 // ...5});
1use Tests\TestCase; 2 3class ExampleTest extends TestCase 4{ 5 public function test_without_defer(): void 6 { 7 $this->withoutDefer(); 8 9 // ...10 }11}
如果你想為測試用例中的所有測試停用延遲函式,可以在基本 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(): void10 {11 parent::setUp();12 13 $this->withoutDefer();14 }15}
抽獎 (Lottery)
Laravel 的抽獎類可用於根據一組給定的機率執行回撥。當你只想為部分傳入請求執行程式碼時,這特別有用。
1use Illuminate\Support\Lottery;2 3Lottery::odds(1, 20)4 ->winner(fn () => $user->won())5 ->loser(fn () => $user->lost())6 ->choose();
你可以將 Laravel 的抽獎類與其他 Laravel 功能相結合。例如,你可能只想向異常處理器報告一小部分慢查詢。而且,由於抽獎類是可呼叫的,我們可以將類的例項傳遞給任何接受可呼叫物件的函式。
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);
測試抽獎
Laravel 提供了一些簡單的方法,允許你輕鬆測試應用程式的抽獎呼叫。
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();
管道 (Pipeline)
Laravel 的 Pipeline 門面提供了一種方便的方法,將給定的輸入“管道化”透過一系列可呼叫類、閉包或可呼叫物件,使每個類都有機會檢查或修改輸入並呼叫管道中的下一個可呼叫物件。
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);
如你所見,管道中的每個可呼叫類或閉包都會獲得輸入和一個 $next 閉包。呼叫 $next 閉包將呼叫管道中的下一個可呼叫物件。如你所注意到的,這與 中介軟體 非常相似。
當管道中的最後一個可呼叫物件呼叫 $next 閉包時,將呼叫提供給 then 方法的可呼叫物件。通常,此可呼叫物件將簡單地返回給定的輸入。為方便起見,如果你只想在處理後返回輸入,可以使用 thenReturn 方法。
當然,如前所述,你並不侷限於為管道提供閉包。你也可以提供可呼叫類。如果提供了類名,則該類將透過 Laravel 的 服務容器 進行例項化,從而允許將依賴項注入到可呼叫類中。
1$user = Pipeline::send($user)2 ->through([3 GenerateProfilePhoto::class,4 ActivateSubscription::class,5 SendWelcomeEmail::class,6 ])7 ->thenReturn();
可以在管道上呼叫 withinTransaction 方法,以自動將管道的所有步驟包裝在單個數據庫事務中。
1$user = Pipeline::send($user)2 ->withinTransaction()3 ->through([4 ProcessOrder::class,5 TransferFunds::class,6 UpdateInventory::class,7 ])8 ->thenReturn();
休眠 (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}
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()->plus(minutes: 1));21 22// Alias of PHP's native "sleep" function...23Sleep::sleep(2);24 25// Alias of PHP's native "usleep" function...26Sleep::usleep(5000);
要輕鬆組合時間單位,可以使用 and 方法。
1Sleep::for(1)->second()->and(10)->milliseconds();
測試休眠
在測試使用 Sleep 類或 PHP 原生休眠函式的程式碼時,你的測試將暫停執行。如你所料,這會使你的測試套件變慢很多。例如,假設你正在測試以下程式碼:
1$waiting = /* ... */;2 3$seconds = 1;4 5while ($waiting) {6 Sleep::for($seconds++)->seconds();7 8 $waiting = /* ... */;9}
通常,測試此程式碼至少需要一秒鐘。幸運的是,Sleep 類允許我們“偽造”休眠,從而使我們的測試套件保持快速。
1it('waits until ready', function () {2 Sleep::fake();3 4 // ...5});
1public function test_it_waits_until_ready()2{3 Sleep::fake();4 5 // ...6}
偽造 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}
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}
當然,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();
有時,每當發生偽造休眠時執行操作可能會很有用。為實現這一點,你可以為 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});
由於推進時間是常見需求,fake 方法接受一個 syncWithCarbon 引數,以便在測試中休眠時保持 Carbon 同步。
1Sleep::fake(syncWithCarbon: true);2 3$start = now();4 5Sleep::for(1)->second();6 7$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);
如果在閉包內丟擲異常,此類將遵循定義的延遲,並在延遲後重新丟擲異常。
URI
Laravel 的 Uri 類提供了用於建立和操作 URI 的便捷且流式的介面。此類封裝了底層 League URI 包提供的功能,並與 Laravel 的路由系統無縫整合。
你可以使用靜態方法輕鬆建立 Uri 例項。
1use App\Http\Controllers\UserController; 2use App\Http\Controllers\InvokableController; 3use Illuminate\Support\Uri; 4 5// Generate a URI instance from the given string... 6$uri = Uri::of('https://example.com/path'); 7 8// Generate URI instances to paths, named routes, or controller actions... 9$uri = Uri::to('/dashboard');10$uri = Uri::route('users.show', ['user' => 1]);11$uri = Uri::signedRoute('users.show', ['user' => 1]);12$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));13$uri = Uri::action([UserController::class, 'index']);14$uri = Uri::action(InvokableController::class);15 16// Generate a URI instance from the current request URL...17$uri = $request->uri();
一旦有了 URI 例項,就可以流暢地修改它。
1$uri = Uri::of('https://example.com')2 ->withScheme('http')3 ->withHost('test.com')4 ->withPort(8000)5 ->withPath('/users')6 ->withQuery(['page' => 2])7 ->withFragment('section-1');
檢查 URI
Uri 類還允許你輕鬆檢查底層 URI 的各種元件。
1$scheme = $uri->scheme();2$authority = $uri->authority();3$host = $uri->host();4$port = $uri->port();5$path = $uri->path();6$segments = $uri->pathSegments();7$query = $uri->query();8$fragment = $uri->fragment();
操作查詢字串
Uri 類提供了幾種可用於操作 URI 查詢字串的方法。withQuery 方法可用於將額外的查詢字串引數合併到現有查詢字串中。
1$uri = $uri->withQuery(['sort' => 'name']);
如果給定鍵在查詢字串中尚不存在,則 withQueryIfMissing 方法可用於將額外的查詢字串引數合併到現有查詢字串中。
1$uri = $uri->withQueryIfMissing(['page' => 1]);
replaceQuery 方法可用於用新查詢字串完全替換現有查詢字串。
1$uri = $uri->replaceQuery(['page' => 1]);
pushOntoQuery 方法可用於將額外引數推送到具有陣列值的查詢字串引數上。
1$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);
withoutQuery 方法可用於從查詢字串中移除引數。
1$uri = $uri->withoutQuery(['page']);
從 URI 生成響應
redirect 方法可用於生成到給定 URI 的 RedirectResponse 例項。
1$uri = Uri::of('https://example.com');2 3return $uri->redirect();
或者,你可以簡單地從路由或控制器動作返回 Uri 例項,這將自動生成到返回 URI 的重定向響應。
1use Illuminate\Support\Facades\Route;2use Illuminate\Support\Uri;3 4Route::get('/redirect', function () {5 return Uri::to('/index')6 ->withQuery(['sort' => 'name']);7});