輔助函式 (Helpers)
簡介
Laravel 包含了多種全域的「輔助 (helper)」PHP 函式。這些函式中有許多是被框架本身所使用;然而,如果你覺得方便,也可以在自己的應用程式中自由地使用它們。
可用方法
陣列與物件 (Arrays & Objects)
Arr::accessibleArr::addArr::arrayArr::booleanArr::collapseArr::crossJoinArr::divideArr::dotArr::everyArr::exceptArr::exceptValuesArr::existsArr::firstArr::flattenArr::floatArr::forgetArr::fromArr::getArr::hasArr::hasAllArr::hasAnyArr::integerArr::isAssocArr::isListArr::joinArr::keyByArr::lastArr::mapArr::mapSpreadArr::mapWithKeysArr::onlyArr::onlyValuesArr::partitionArr::pluckArr::prependArr::prependKeysWithArr::pullArr::pushArr::queryArr::randomArr::rejectArr::selectArr::setArr::shuffleArr::soleArr::someArr::sortArr::sortDescArr::sortRecursiveArr::stringArr::takeArr::toCssClassesArr::toCssStylesArr::undotArr::whereArr::whereNotNullArr::wrapdata_filldata_getdata_setdata_forgetheadlast
數值 (Numbers)
Number::abbreviateNumber::clampNumber::currencyNumber::defaultCurrencyNumber::defaultLocaleNumber::fileSizeNumber::forHumansNumber::formatNumber::ordinalNumber::pairsNumber::parseIntNumber::parseFloatNumber::percentageNumber::spellNumber::spellOrdinalNumber::trimNumber::useLocaleNumber::withLocaleNumber::useCurrencyNumber::withCurrency
路徑 (Paths)
URL (URLs)
其他 (Miscellaneous)
abortabort_ifabort_unlessappauthbackbcryptblankbroadcastbroadcast_ifbroadcast_unlesscacheclass_uses_recursivecollectconfigcontextcookiecsrf_fieldcsrf_tokendecryptdddispatchdispatch_syncdumpencryptenveventfakefilledinfoliteralloggermethod_fieldnowoldonceoptionalpolicyredirectreportreport_ifreport_unlessrequestrescueresolveresponseretrysessiontapthrow_ifthrow_unlesstodaytrait_uses_recursivetransformvalidatorvalueviewwithwhen
陣列與物件
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);
// falseArr::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::array()
Arr::array 方法使用「點 (dot)」記法從深度嵌套的陣列中取得值(如同 Arr::get()),但若請求的值不是一個 array,則會拋出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::array($array, 'languages');
// ['PHP', 'Ruby']
$value = Arr::array($array, 'name');
// throws InvalidArgumentExceptionArr::boolean()
Arr::boolean 方法使用「點 (dot)」記法從深度嵌套的陣列中取得值(如同 Arr::get()),但若請求的值不是一個 boolean,則會拋出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'available' => true];
$value = Arr::boolean($array, 'available');
// true
$value = Arr::boolean($array, 'name');
// throws InvalidArgumentExceptionArr::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 方法對給定的陣列進行交叉合併,並回傳包含所有可能排列組合的笛卡兒積 (Cartesian product):
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 方法將多維陣列扁平化為單層陣列,並使用「點 (dot)」記法來表示深度:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]Arr::every()
Arr::every 方法確保陣列中的所有值都通過給定的真值測試:
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::every($array, fn ($i) => $i > 0);
// true
Arr::every($array, fn ($i) => $i > 2);
// falseArr::except()
Arr::except 方法從陣列中移除指定的鍵值對:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']Arr::exceptValues()
Arr::exceptValues 方法從陣列中移除指定的值:
use Illuminate\Support\Arr;
$array = ['foo', 'bar', 'baz', 'qux'];
$filtered = Arr::exceptValues($array, ['foo', 'baz']);
// ['bar', 'qux']您也可以將 true 傳遞給 strict 引數,在過濾時使用嚴格類型比較:
use Illuminate\Support\Arr;
$array = [1, '1', 2, '2'];
$filtered = Arr::exceptValues($array, [1, 2], strict: true);
// ['1', '2']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');
// falseArr::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::float()
Arr::float 方法使用「點 (dot)」記法從深度嵌套的陣列中取得值(如同 Arr::get()),但若請求的值不是一個 float,則會拋出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'balance' => 123.45];
$value = Arr::float($array, 'balance');
// 123.45
$value = Arr::float($array, 'name');
// throws InvalidArgumentExceptionArr::forget()
Arr::forget 方法使用「點 (dot)」記法從深度嵌套的陣列中移除指定的鍵值對:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]Arr::from()
Arr::from 方法將各種輸入類型轉換為普通的 PHP 陣列。它支援多種輸入類型,包括陣列、物件,以及數個常見的 Laravel 介面,例如 Arrayable、Enumerable、Jsonable 與 JsonSerializable。此外,它還能處理 Traversable 與 WeakMap 的執行個體:
use Illuminate\Support\Arr;
Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']
class TestJsonableObject implements Jsonable
{
public function toJson($options = 0)
{
return json_encode(['foo' => 'bar']);
}
}
Arr::from(new TestJsonableObject); // ['foo' => 'bar']Arr::get()
Arr::get 方法使用「點」記法從深度巢狀陣列中取得值:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100Arr::get 方法也接受一個預設值,若指定的鍵不存在於陣列中,則會回傳該值:
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0Arr::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']);
// falseArr::hasAll()
Arr::hasAll 方法使用「點」記法判斷指定的鍵是否全部存在於給定的陣列中:
use Illuminate\Support\Arr;
$array = ['name' => 'Taylor', 'language' => 'PHP'];
Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // falseArr::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']);
// falseArr::integer()
Arr::integer 方法使用「點」記法從深度巢狀陣列中取得值(如同 Arr::get() 一樣),但若要求的內容不是 int,則會拋出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'age' => 42];
$value = Arr::integer($array, 'age');
// 42
$value = Arr::integer($array, 'name');
// throws InvalidArgumentExceptionArr::isAssoc()
如果給定的陣列是關聯陣列,Arr::isAssoc 方法會回傳 true。若陣列不具有從零開始的連續數值鍵,則被視為「關聯陣列」:
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// falseArr::isList()
如果給定陣列的鍵是從零開始的連續整數,Arr::isList 方法會回傳 true:
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// falseArr::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 LivewireArr::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::onlyValues()
Arr::onlyValues 方法從陣列中僅回傳指定的值:
use Illuminate\Support\Arr;
$array = ['foo', 'bar', 'baz', 'qux'];
$filtered = Arr::onlyValues($array, ['foo', 'baz']);
// ['foo', 'baz']您也可以將 true 傳遞給 strict 參數,以便在過濾時使用嚴格類型比較:
use Illuminate\Support\Arr;
$array = [1, '1', 2, '2'];
$filtered = Arr::onlyValues($array, [1, 2], strict: true);
// [1, 2]Arr::partition()
Arr::partition 方法可以與 PHP 陣列解構結合使用,將通過指定真值測試的元素與未通過的元素分開:
<?php
use Illuminate\Support\Arr;
$numbers = [1, 2, 3, 4, 5, 6];
[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
return $i < 3;
});
dump($underThree);
// [1, 2]
dump($equalOrAboveThree);
// [3, 4, 5, 6]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::push()
Arr::push 方法使用「點」記法將一個項目推入陣列。如果給定的鍵不存在陣列,則會建立它:
use Illuminate\Support\Arr;
$array = [];
Arr::push($array, 'office.furniture', 'Desk');
// $array: ['office' => ['furniture' => ['Desk']]]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]=descArr::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::reject()
Arr::reject 方法使用給定的閉包從陣列中移除項目:
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::reject($array, function (string|int $value, int $key) {
return is_string($value);
});
// [0 => 100, 2 => 300, 4 => 500]Arr::select()
Arr::select 方法從陣列中選取一個值陣列:
use Illuminate\Support\Arr;
$array = [
['id' => 1, 'name' => 'Desk', 'price' => 200],
['id' => 2, 'name' => 'Table', 'price' => 150],
['id' => 3, 'name' => 'Chair', 'price' => 300],
];
Arr::select($array, ['name', 'price']);
// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]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::sole()
Arr::sole 方法使用給定的閉包從陣列中取得單個值。如果陣列中有超過一個值通過指定的真值測試,則會拋出 Illuminate\Support\MultipleItemsFoundException 例外。如果沒有值通過真值測試,則會拋出 Illuminate\Support\ItemNotFoundException 例外:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
// 'Desk'Arr::some()
Arr::some 方法確保陣列中至少有一個值通過給定的真值測試:
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::some($array, fn ($i) => $i > 2);
// trueArr::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::string()
Arr::string 方法使用「點」記法從深度巢狀陣列中取得一個值(就像 Arr::get() 一樣),但如果要求的內容不是 string,則會拋出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::string($array, 'name');
// Joe
$value = Arr::string($array, 'languages');
// throws InvalidArgumentExceptionArr::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 類別字串。該方法接受一個類別陣列,其中陣列的鍵 (Key) 包含您想要加入的類別,而值 (Value) 則是一個布林運算式。如果陣列元素具有數字鍵,則它將始終包含在渲染後的類別清單中:
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 樣式字串。該方法接受一個 CSS 宣告陣列,其中陣列的鍵包含您想要加入的 CSS 宣告,而值則是一個布林運算式。如果陣列元素具有數字鍵,則它將始終包含在編譯後的 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 元件的屬性袋 (Attribute Bag) 合併,以及 @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 方法使用指定的閉包 (Closure) 過濾陣列:
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');
// 100data_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:00data_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 函式回傳指定陣列中的第一個元素。如果陣列為空,則回傳 false:
$array = [100, 200, 300];
$first = head($array);
// 100last()
last 函式傳回給定陣列中的最後一個元素。若該陣列為空,則傳回 false:
$array = [100, 200, 300];
$last = last($array);
// 300數字 (Numbers)
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.23MNumber::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);
// 20Number::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 €
$currency = Number::currency(1000, in: 'EUR', locale: 'de', precision: 0);
// 1.000 €Number::defaultCurrency()
Number::defaultCurrency 方法傳回 Number 類別目前使用的預設貨幣:
use Illuminate\Support\Number;
$currency = Number::defaultCurrency();
// USDNumber::defaultLocale()
Number::defaultLocale 方法傳回 Number 類別目前使用的預設語系 (Locale):
use Illuminate\Support\Number;
$locale = Number::defaultLocale();
// enNumber::fileSize()
Number::fileSize 方法以字串形式傳回給定位元組 (Byte) 值的檔案大小表示形式:
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 KBNumber::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 millionNumber::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.000Number::ordinal()
Number::ordinal 方法傳回數字的序數 (Ordinal) 表示形式:
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21stNumber::pairs()
Number::pairs 方法根據指定的範圍和間隔值 (Step Value) 生成一個數字對 (子範圍) 陣列。此方法對於將較大的數字範圍劃分為較小、易於管理的子範圍(例如分頁或批次處理任務)非常有用。pairs 方法傳回一個陣列的陣列,其中每個內部陣列代表一對 (子範圍) 數字:
use Illuminate\Support\Number;
$result = Number::pairs(25, 10);
// [[0, 9], [10, 19], [20, 25]]
$result = Number::pairs(25, 10, offset: 0);
// [[0, 10], [10, 20], [20, 25]]Number::parseInt()
Number::parseInt 方法根據指定的語系將字串解析為整數:
use Illuminate\Support\Number;
$result = Number::parseInt('10.123');
// (int) 10
$result = Number::parseInt('10,123', locale: 'fr');
// (int) 10Number::parseFloat()
Number::parseFloat 方法根據指定的語系將字串解析為浮點數:
use Illuminate\Support\Number;
$result = Number::parseFloat('10');
// (float) 10.0
$result = Number::parseFloat('10', locale: 'fr');
// (float) 10.0Number::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-huitafter 參數允許您指定一個數值,超過該值後的數字都將以單字拼寫:
$number = Number::spell(10, after: 10);
// 10
$number = Number::spell(11, after: 10);
// elevenuntil 參數允許您指定一個數值,在該值之前的數字都將以單字拼寫:
$number = Number::spell(5, until: 10);
// five
$number = Number::spell(10, until: 10);
// 10Number::spellOrdinal()
Number::spellOrdinal 方法以單字字串形式傳回數字的序數表示形式:
use Illuminate\Support\Number;
$number = Number::spellOrdinal(1);
// first
$number = Number::spellOrdinal(2);
// second
$number = Number::spellOrdinal(21);
// twenty-firstNumber::trim()
Number::trim 方法移除給定數字小數點後任何多餘的零:
use Illuminate\Support\Number;
$number = Number::trim(12.0);
// 12
$number = Number::trim(12.30);
// 12.3Number::useLocale()
Number::useLocale 方法全域設定預設的數字語系,這會影響後續呼叫 Number 類別方法時數字和貨幣的格式化方式:
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useLocale('de');
}Number::withLocale()
Number::withLocale 方法使用指定的語系執行給定的閉包,並在回呼 (Callback) 執行後恢復原始語系:
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 方法使用指定的貨幣執行給定的閉包,並在回呼 (Callback) 執行完畢後恢復原始貨幣:
use Illuminate\Support\Number;
$number = Number::withCurrency('GBP', function () {
// ...
});路徑 (Paths)
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');📌 備註
預設情況下,Laravel 應用程式骨架不包含 lang 目錄。如果您想要自訂 Laravel 的語言檔案,您可以透過 lang:publish Artisan 指令來發布它們。
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 函式來產生儲存目錄內給定檔案的完整路徑:
$path = storage_path();
$path = storage_path('app/file.txt');URL
action()
action 函式為給定的控制器動作 (Controller 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.jpgroute()
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_action()
to_action 函式為給定的控制器動作產生重新導向 HTTP 回應:
use App\Http\Controllers\UserController;
return to_action([UserController::class, 'show'], ['user' => 1]);如有必要,您可以將應分配給重新導向的 HTTP 狀態碼以及任何額外的回應標頭作為 to_action 方法的第三個和第四個參數傳遞:
return to_action(
[UserController::class, 'show'],
['user' => 1],
302,
['X-Framework' => 'Laravel']
);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']);uri()
uri 函式為給定的 URI 產生一個流暢的 URI 實例:
$uri = uri('https://example.com')
->withPath('/users')
->withQuery(['page' => 1]);如果 uri 函式被給予一個包含可呼叫的控制器與方法對的陣列,該函式將為該控制器方法的路由路徑建立一個 Uri 實例:
use App\Http\Controllers\UserController;
$uri = uri([UserController::class, 'show'], ['user' => $user]);如果控制器是可呼叫的 (Invokable),您可以簡單地提供控制器類別名稱:
use App\Http\Controllers\UserIndexController;
$uri = uri(UserIndexController::class);如果提供給 uri 函式的值與某個具名路由的名稱相符,則會為該路由的路徑產生一個 Uri 實例:
$uri = uri('users.show', ['user' => $user]);url()
url 函式為給定路徑產生完整路徑的 URL:
$url = url('user/profile');
$url = url('user/profile', [1]);如果未提供路徑,則會回傳 Illuminate\Routing\UrlGenerator 實例:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();有關使用 url 函式的更多資訊,請參閱 URL 產生文件。
其他
abort()
abort 函式會拋出一個將由例外處理器 (Exception Handler) 渲染的 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 函式回傳服務容器 (Service Container) 實例:
$container = app();您可以傳遞類別或介面名稱,以便從容器中解析它:
$api = app('HelpSpot\API');auth()
auth 函式回傳一個認證器 (Authenticator) 實例。您可以用它來替代 Auth Facade:
$user = auth()->user();如有需要,您可以指定您想要存取的 Guard 實例:
$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 函式將給定的事件 (Event) 廣播 給它的監聽器:
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();broadcast_if()
當給定的布林運算式評估為 true 時,broadcast_if 函式會將給定的事件 (Event) 廣播 給它的監聽器:
broadcast_if($user->isActive(), new UserRegistered($user));
broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();broadcast_unless()
當給定的布林運算式評估為 false 時,broadcast_unless 函式會將給定的事件 (Event) 廣播 給它的監聽器:
broadcast_unless($user->isBanned(), new UserRegistered($user));
broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();cache()
cache 函式可用於從 快取 (Cache) 中取得值。如果快取中不存在給定的鍵,則會回傳選用的預設值:
$value = cache('key');
$value = cache('key', 'default');您可以透過向函式傳遞鍵值對陣列來將項目新增到快取。您還應該傳遞快取值應被視為有效的秒數或持續時間:
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->plus(seconds: 10));class_uses_recursive()
class_uses_recursive 函式回傳類別使用的所有 Trait,包括其所有父類別使用的 Trait:
$traits = class_uses_recursive(App\Models\User::class);collect()
collect 函式從給定的值建立一個 Collection 實例:
$collection = collect(['Taylor', 'Abigail']);config()
config 函式取得設定 (Configuration) 變數的值。設定值可以使用「點」語法存取,其中包含檔案名稱和您想要存取的選項。您也可以提供一個預設值,如果設定選項不存在,則會回傳該值:
$value = config('app.timezone');
$value = config('app.timezone', $default);您可以在執行期間透過傳遞鍵值對陣列來設定設定變數。但是請注意,此函式僅會影響當前請求的設定值,而不會更新您實際的設定檔:
config(['app.debug' => true]);context()
context 函式從目前的 context 取得值。您也可以提供一個預設值,如果 context 鍵不存在,則會回傳該值:
$value = context('trace_id');
$value = context('trace_id', $default);您可以透過傳遞鍵值對陣列來設定 context 的值:
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);cookie()
cookie 函式建立一個新的 Cookie 實例:
$cookie = cookie('name', 'value', $minutes);csrf_field()
csrf_field 函式產生一個包含 CSRF 權杖 (Token) 值的 HTML hidden 輸入欄位。例如,使用 Blade 語法:
{{ csrf_field() }}csrf_token()
csrf_token 函式取得目前 CSRF 權杖 (Token) 的值:
$token = csrf_token();decrypt()
decrypt 函式對給定的值進行解密。您可以用它來替代 Crypt Facade:
$password = decrypt($value);關於 decrypt 的反向操作,請參閱 encrypt 函式。
dd()
dd 函式傾印 (Dump) 給定的變數並結束腳本的執行:
dd($value);
dd($value1, $value2, $value3, ...);如果您不想要停止腳本的執行,請改用 dump 函式。
dispatch()
dispatch 函式將給定的任務 (Job) 推送到 Laravel 任務隊列 (Job Queue):
dispatch(new App\Jobs\SendEmails);dispatch_sync()
dispatch_sync 函式將指定的任務推送至 sync 佇列,以便立即處理:
dispatch_sync(new App\Jobs\SendEmails);dump()
dump 函式會傾印 (dump) 指定的變數:
dump($value);
dump($value1, $value2, $value3, ...);如果您想在傾印變數後停止執行腳本,請改用 dd 函式。
encrypt()
encrypt 函式會加密給定的值。您可以使用此函式作為 Crypt Facade 的替代方案:
$secret = encrypt('my-secret-value');關於 encrypt 的反向操作,請參閱 decrypt 函式。
env()
env 函式取得環境變數的值,或回傳預設值:
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');⚠️ 警告
如果您在部署過程中執行 config:cache 命令,請確保您只在設定檔中呼叫 env 函式。一旦設定被快取,.env 檔案將不會被載入,所有對 env 函式的呼叫都將回傳外部環境變數(如伺服器級別或系統級別的環境變數)或 null。
event()
event 函式將指定的 event 分派給其監聽器:
event(new UserRegistered($user));fake()
fake 函式從容器中解析一個 Faker 單例 (singleton),這在模型工廠、資料庫填充 (seeding)、測試和原型視圖中建立假資料時非常有用:
@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 函式判斷給定的值是否不為「空白 (blank)」:
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false關於 filled 的反向函式,請參閱 blank 函式。
info()
info 函式會將資訊寫入應用程式的 log:
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 層級的訊息寫入 log:
logger('Debug message');也可以將上下文資料陣列傳遞給該函式:
logger('User has logged in.', ['id' => $user->id]);如果不傳遞任何值給函式,則會回傳 logger 實例:
logger()->error('You are not allowed here.');method_field()
method_field 函式產生一個包含表單 HTTP 動詞偽造值的 HTML hidden 輸入欄位。例如,使用 Blade 語法:
<form method="POST">
{{ method_field('DELETE') }}
</form>now()
now 函式為當前時間建立一個新的 Illuminate\Support\Carbon 實例:
$now = now();old()
old 函式檢索閃存 (flash) 到 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 函式執行給定的回呼 (callback),並在請求期間將結果快取在記憶體中。隨後使用相同回呼對 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 函式也接受一個閉包 (closure) 作為其第二個參數。如果第一個參數提供的值不為 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 = [], $secure = null);
return redirect('/home');
return redirect()->route('route.name');report()
report 函式將使用您的異常處理器回報異常:
report($e);report 函式也接受字串作為參數。當將字串傳遞給函式時,該函式將建立一個以指定字串作為訊息的異常:
report('Something went wrong.');report_if()
report_if 函式會在給定的布林運算式結果為 true 時,使用您的 例外處理器 (Exception Handler) 回報例外:
report_if(! Auth::user()->isAdmin(), 403);report_unless()
report_unless 函式會在給定的布林運算式結果為 false 時,使用您的 例外處理器 (Exception Handler) 回報例外:
report_unless(Auth::user()->isAdmin(), 403);request()
request 函式會回傳目前的 請求 (Request) 實例,或從目前的請求中取得輸入欄位的值:
$request = request();
$value = request('key', $default);rescue()
rescue 函式會執行給定的閉包 (Closure) 並擷取執行過程中發生的任何例外。所有擷取到的例外都會被傳送到您的 例外處理器 (Exception Handler);然而,請求將會繼續處理:
return rescue(function () {
return $this->method();
});您也可以向 rescue 函式傳遞第二個參數。此參數將是執行閉包時若發生例外所應回傳的「預設」值:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});可以向 rescue 函式提供 report 參數,以決定是否應透過 report 函式來回報該例外:
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});resolve()
resolve 函式使用 服務容器 (Service Container) 將給定的類別或介面名稱解析為實例:
$api = resolve('HelpSpot\API');response()
response 函式會建立一個 回應 (Response) 實例,或取得回應工廠 (Response Factory) 的實例:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);retry()
retry 函式會嘗試執行給定的回呼 (Callback),直到達到指定的最高嘗試次數閾值。如果回呼沒有拋出例外,則會回傳其回傳值。如果回呼拋出例外,它將自動重試。如果超過最高嘗試次數,則會拋出該例外:
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;
});為了方便起見,您可以提供一個陣列作為 retry 函式的第一個參數。此陣列將用於決定後續嘗試之間應休眠多少毫秒:
return retry([100, 200], function () {
// Sleep for 100ms on first retry, 200ms on second retry...
});若要僅在特定條件下重試,可以向 retry 函式傳遞一個閉包作為第四個參數:
use App\Exceptions\TemporaryException;
use Exception;
return retry(5, function () {
// ...
}, 100, function (Exception $exception) {
return $exception instanceof TemporaryException;
});session()
session 函式可用於取得或設定 Session 的值:
$value = session('key');您可以透過向該函式傳遞一個鍵值對 (Key / Value Pairs) 陣列來設定值:
session(['chairs' => 7, 'instruments' => 3]);如果沒有向該函式傳遞任何值,則會回傳 Session 儲存庫:
$value = session()->get('key');
session()->put('key', $value);tap()
tap 函式接受兩個參數:一個任意的 $value 和一個閉包。該 $value 將被傳遞給閉包,然後由 tap 函式回傳。閉包的回傳值與此無關:
$user = tap(User::first(), function (User $user) {
$user->name = 'Taylor';
$user->save();
});如果沒有向 tap 函式傳遞閉包,您可以對給定的 $value 呼叫任何方法。無論該方法在其定義中實際回傳什麼,您所呼叫的方法的回傳值將始終是 $value。例如,Eloquent 的 update 方法通常會回傳一個整數。然而,我們可以透過將 update 方法呼叫鏈接到 tap 函式,來強制該方法回傳模型本身:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);要為類別新增 tap 方法,您可以將 Illuminate\Support\Traits\Tappable Trait 新增到類別中。此 Trait 的 tap 方法只接受一個閉包作為參數。物件實例本身將被傳遞給閉包,然後由 tap 方法回傳:
return $user->tap(function (User $user) {
// ...
});throw_if()
throw_if 函式會在給定的布林運算式結果為 true 時拋出指定的例外:
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);throw_unless()
throw_unless 函式會在給定的布林運算式結果為 false 時拋出指定的例外:
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 實例:
$today = today();trait_uses_recursive()
trait_uses_recursive 函式會回傳一個 Trait 所使用的所有 Trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);transform()
如果給定的值不是 空白 (Blank),transform 函式會對該值執行閉包,並回傳該閉包的回傳值:
$callback = function (int $value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10可以將預設值或閉包作為該函式的第三個參數傳遞。如果給定的值為空白,則會回傳此值:
$result = transform(null, $callback, 'The value is blank');
// The value is blankvalidator()
validator 函式使用給定的參數建立一個新的 驗證器 (Validator) 實例。您可以使用它作為 Validator Facade 的替代方案:
$validator = validator($data, $rules, $messages);value()
value 函式返回給它的值。然而,如果你將閉包傳遞給該函式,則該閉包將被執行並返回其回傳值:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false額外的引數可以傳遞給 value 函式。如果第一個引數是閉包,則額外的參數將作為引數傳遞給該閉包,否則它們將被忽略:
$result = value(function (string $name) {
return $name;
}, 'Taylor');
// 'Taylor'view()
view 函式會取得一個 視圖 實例:
return view('auth.login');with()
with 函式返回給它的值。如果將閉包作為第二個引數傳遞給該函式,則該閉包將被執行並返回其回傳值:
$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);
// 5when()
如果給定的條件評估為 true,when 函式會返回給它的值。否則,返回 null。如果將閉包作為第二個引數傳遞給該函式,則該閉包將被執行並返回其回傳值:
$value = when(true, 'Hello World');
$value = when(true, fn () => 'Hello World');when 函式主要用於條件式地渲染 HTML 屬性:
<div {!! when($condition, 'wire:poll="calculate"') !!}>
...
</div>其他公用程式
基準測試
有時您可能希望快速測試應用程式特定部分的效能。在這些情況下,您可以使用 Benchmark 支援類別來測量給定回呼 (Callback) 完成所需的毫秒數:
<?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 類別將返回所有疊代中執行回呼的平均毫秒數:
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms有時,您可能想要在對回呼執行進行基準測試的同時,仍然獲取該回呼返回的值。value 方法將返回一個包含回呼返回值及執行回呼所需毫秒數的元組 (Tuple):
[$count, $duration] = Benchmark::value(fn () => User::count());日期與時間
Laravel 包含了 Carbon,一個強大的日期與時間操作函式庫。要建立一個新的 Carbon 實例,您可以呼叫 now 函式。此函式在您的 Laravel 應用程式中是全域可用的:
$now = now();或者,您也可以使用 Illuminate\Support\Carbon 類別來建立新的 Carbon 實例:
use Illuminate\Support\Carbon;
$now = Carbon::now();Laravel 還為 Carbon 實例增強了 plus 與 minus 方法,以便輕鬆操作實例的日期與時間:
return now()->plus(minutes: 5);
return now()->plus(hours: 8);
return now()->plus(weeks: 4);
return now()->minus(minutes: 5);
return now()->minus(hours: 8);
return now()->minus(weeks: 4);有關 Carbon 及其功能的詳細討論,請參閱 Carbon 官方文件。
間隔函式 (Interval Functions)
Laravel 還提供了 milliseconds、seconds、minutes、hours、days、weeks、months 以及 years 函式,它們會返回 CarbonInterval 實例,這些實例擴充了 PHP 的 DateInterval 類別。這些函式可以用在任何 Laravel 接受 DateInterval 實例的地方:
use Illuminate\Support\Facades\Cache;
use function Illuminate\Support\{minutes};
Cache::put('metrics', $metrics, minutes(10));延遲函式
雖然 Laravel 的 佇列任務 (Queued Jobs) 允許您將任務排入佇列以進行背景處理,但有時您可能有一些簡單的任務想要延後執行,而不需要配置或維護長期執行的佇列工作者 (Worker)。
延遲函式允許您將閉包 (Closure) 的執行延後到 HTTP 回應發送給使用者之後,讓您的應用程式保持快速且反應靈敏。要延後執行閉包,只需將閉包傳遞給 Illuminate\Support\defer 函式即可:
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 方法串接在延遲函式之後:
defer(fn () => Metrics::reportOrder($order))->always();⚠️ 警告
如果您安裝了 Swoole PHP 擴充功能,Laravel 的 defer 函式可能會與 Swoole 自身的全域 defer 函式產生衝突,從而導致網頁伺服器錯誤。請確保您透過明確指定命名空間來呼叫 Laravel 的 defer 輔助函式:use function Illuminate\Support\defer;
取消延遲函式
如果您需要在延遲函式執行前將其取消,您可以使用 forget 方法透過名稱來取消該函式。要為延遲函式命名,請為 Illuminate\Support\defer 函式提供第二個參數:
defer(fn () => Metrics::report(), 'reportMetrics');
defer()->forget('reportMetrics');在測試中停用延遲函式
在編寫測試時,停用延遲函式可能會很有用。您可以在測試中呼叫 withoutDefer,以指示 Laravel 立即執行所有延遲函式:
test('without defer', function () {
$this->withoutDefer();
// ...
});use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_without_defer(): void
{
$this->withoutDefer();
// ...
}
}如果您想為某個測試案例中的所有測試停用延遲函式,您可以在基礎 TestCase 類別的 setUp 方法中呼叫 withoutDefer 方法:
<?php
namespace Tests;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
abstract class TestCase extends BaseTestCase
{
protected function setUp(): void// [tl! add:start]
{
parent::setUp();
$this->withoutDefer();
}// [tl! add:end]
}Lottery
Laravel 的 Lottery 類別可用於根據一組給定的機率來執行回呼。當您只想對一定百分比的傳入請求執行程式碼時,這特別有用:
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();您可以將 Laravel 的 Lottery 類別與其他 Laravel 功能結合使用。例如,您可能希望只向例外處理程式 (Exception Handler) 報告一小部分慢速查詢。而且,由於 Lottery 類別是可呼叫的 (Callable),您可以將類別的實例傳遞給任何接受可呼叫對象的方法:
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.')),
);測試 Lotteries
Laravel 提供了一些簡單的方法,讓您可以輕鬆測試應用程式中的 Lottery 呼叫:
// 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 提供了一種方便的方法,可以將給定的輸入透過一系列可呼叫的類別、閉包 (Closures) 或可呼叫對象 (Callables) 進行「管道 (pipe)」傳遞,讓每個類別都有機會檢查或修改輸入,並調用管道中的下一個可呼叫對象:
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 方法的可呼叫對象將會被執行。通常,此可呼叫對象只會簡單地回傳給定的輸入。為了方便起見,如果您只想在處理完輸入後將其回傳,可以使用 thenReturn 方法。
當然,如前所述,您並不侷限於在管道中提供閉包。您也可以提供可呼叫的類別。如果提供了類別名稱,該類別將透過 Laravel 的服務容器 (service container) 進行實例化,這允許將依賴項注入到該可呼叫類別中:
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->thenReturn();可以在管道上調用 withinTransaction 方法,以自動將管道的所有步驟封裝在單個資料庫交易 (Database Transaction) 中:
$user = Pipeline::send($user)
->withinTransaction()
->through([
ProcessOrder::class,
TransferFunds::class,
UpdateInventory::class,
])
->thenReturn();Sleep
Laravel 的 Sleep 類別是 PHP 原生 sleep 與 usleep 函式的輕量級封裝,提供了更高的可測試性,同時也暴露了對開發者友好的時間處理 API:
use Illuminate\Support\Sleep;
$waiting = true;
while ($waiting) {
Sleep::for(1)->second();
$waiting = /* ... */;
}Sleep 類別提供了多種方法,讓您可以處理不同的時間單位:
// 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()->plus(minutes: 1));
// Alias of PHP's native "sleep" function...
Sleep::sleep(2);
// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);若要輕鬆組合時間單位,可以使用 and 方法:
Sleep::for(1)->second()->and(10)->milliseconds();測試 Sleep
當測試使用了 Sleep 類別或 PHP 原生 sleep 函式的程式碼時,您的測試執行將會暫停。正如您所預期的,這會使您的測試套件顯著變慢。例如,假設您正在測試以下程式碼:
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}通常情況下,測試這段程式碼至少需要一秒鐘。幸運的是,Sleep 類別允許我們「模擬 (fake)」暫停,從而保持測試套件的快速執行:
it('waits until ready', function () {
Sleep::fake();
// ...
});public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}當模擬 Sleep 類別時,實際的執行暫停會被跳過,從而大幅加快測試速度。
一旦模擬了 Sleep 類別,就可以針對預期應該發生的「暫停 (sleeps)」進行斷言。為了說明這一點,讓我們假設我們正在測試一段會暫停執行三次的程式碼,每次暫停的時間都會增加一秒。使用 assertSequence 方法,我們可以斷言我們的程式碼「暫停」了正確的時間,同時保持測試的快速:
it('checks if ready three times', function () {
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}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 類別還提供了多種您在測試時可以使用的其他斷言:
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 方法提供一個回呼 (Callback)。在以下範例中,我們使用 Laravel 的時間操作輔助工具來根據每次暫停的時間長度立即推進時間:
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 的同步:
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second agoLaravel 在內部需要暫停執行時也會使用 Sleep 類別。例如,retry 輔助函式在等待時會使用 Sleep 類別,從而提高了使用該輔助函式時的可測試性。
Timebox
Laravel 的 Timebox 類別確保給定的回呼一律花費固定的時間執行,即使其實際執行完成得更快。這對於加密操作和使用者驗證檢查特別有用,因為攻擊者可能會利用執行時間的差異來推論敏感資訊。
如果執行時間超過了固定時長,Timebox 則不會產生效果。開發者需要自行選擇一個足夠長的時間作為固定時長,以應對最糟的情況。
call 方法接受一個閉包和一個以微秒為單位的時間限制,然後執行該閉包並等待直到達到時間限制:
use Illuminate\Support\Timebox;
(new Timebox)->call(function ($timebox) {
// ...
}, microseconds: 10000);如果在閉包內拋出了例外 (Exception),此類別仍會遵守定義的延遲,並在延遲後重新拋出該例外。
URI
Laravel 的 Uri 類別為建立與操作 URI 提供了一個方便且流暢的介面。該類別封裝了底層 League URI 套件所提供的功能,並與 Laravel 的路由系統無縫整合。
您可以使用靜態方法輕鬆地建立 Uri 執行個體:
use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;
// Generate a URI instance from the given string...
$uri = Uri::of('https://example.com/path');
// Generate URI instances to paths, named routes, or controller actions...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);
// Generate a URI instance from the current request URL...
$uri = $request->uri();一旦您有了 URI 執行個體,您就可以流暢地修改它:
$uri = Uri::of('https://example.com')
->withScheme('http')
->withHost('test.com')
->withPort(8000)
->withPath('/users')
->withQuery(['page' => 2])
->withFragment('section-1');檢查 URI
Uri 類別還允許您輕鬆地檢查底層 URI 的各種元件:
$scheme = $uri->scheme();
$authority = $uri->authority();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$segments = $uri->pathSegments();
$query = $uri->query();
$fragment = $uri->fragment();操作查詢字串 (Query Strings)
Uri 類別提供了數種可用於操作 URI 查詢字串的方法。withQuery 方法可用於將額外的查詢字串參數合併到現有的查詢字串中:
$uri = $uri->withQuery(['sort' => 'name']);withQueryIfMissing 方法可用於在給定的鍵尚不存在於查詢字串中時,將額外的查詢字串參數合併到現有的查詢字串中:
$uri = $uri->withQueryIfMissing(['page' => 1]);replaceQuery 方法可用於將現有的查詢字串完整替換為新的查詢字串:
$uri = $uri->replaceQuery(['page' => 1]);pushOntoQuery 方法可用於將額外參數推送到具有陣列值的查詢字串參數中:
$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);withoutQuery 方法可用於從查詢字串中移除參數:
$uri = $uri->withoutQuery(['page']);從 URI 產生回應
redirect 方法可用於針對給定 URI 產生一個 RedirectResponse 執行個體:
$uri = Uri::of('https://example.com');
return $uri->redirect();或者,您可以簡單地從路由或控制器動作中回傳 Uri 執行個體,這將自動針對回傳的 URI 產生重導回應:
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Uri;
Route::get('/redirect', function () {
return Uri::to('/index')
->withQuery(['sort' => 'name']);
});