简介
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::parse Number::parseInt Number::parseFloat Number::percentage Number::spell Number::spellOrdinal Number::trim Number::useLocale Number::withLocale Number::useCurrency Number::withCurrency
路径
app_path base_path config_path database_path lang_path public_path resource_path storage_path
URL
action asset route secure_asset secure_url to_action to_route uri url
其他
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 方法用于判断给定的值是否可作为数组访问:
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()
Arr::add 方法会在给定的键不存在于数组中,或者其值被设置为 null 时,将该键 / 值对添加到数组中:
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 方法会使用“点”表示法(与 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 方法会使用“点”表示法(与 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 方法会对给定的数组执行交叉连接,返回包含所有可能排列的笛卡尔积:
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/Arr::divide()
Arr::divide 方法会返回两个数组:一个包含给定数组的键,另一个包含该数组的值:
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']Arr::dot()
Arr::dot 方法会将多维数组展开为单层数组,并使用“点”表示法来表示层级深度:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]Arr::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']您还可以向 strict 参数传入 true,以便在过滤时使用严格类型比较:
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 方法会使用“点”表示法(与 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 方法会使用“点”表示法从深度嵌套的数组中移除指定的键 / 值对:
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。如果数组没有以 0 开头的连续数字键,则被视为“关联数组”:
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// falseArr::isList()
Arr::isList 方法在给定数组的键是从 0 开始的连续整数时返回 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%5Bcolumn%5D=created_at&order%5Bdirection%5D=descArr::random()
Arr::random 方法用于从数组中返回一个随机值:
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (随机获取)你也可以指定要返回的项数,作为可选的第二个参数。请注意,提供该参数时,即使只需要一项,也会返回一个数组:
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (随机获取)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] - (随机生成)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 类字符串。该方法接收一个类数组,其中数组的键包含要添加的类,而值是一个布尔表达式。如果数组元素具有数字键,则该元素将始终包含在渲染的类列表中:
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 组件的属性包中,也支持 @class Blade 指令。
Arr::undot()
Arr::undot 方法可将使用“点”号表示法的单维数组展开为多维数组:
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]Arr::where()
Arr::where 方法使用给定的闭包对数组进行过滤:
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function (string|int $value, int $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']Arr::whereNotNull()
Arr::whereNotNull 方法会从给定数组中移除所有 null 值:
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]Arr::wrap()
Arr::wrap 方法会将给定值包装到数组中。如果给定值已经是数组,则原样返回,不做修改:
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']如果给定值为 null,将返回空数组:
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []data_fill()
data_fill 函数使用“点”号表示法,在嵌套数组或对象中为缺失的值进行填充:
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]此函数还接受星号作为通配符,并会相应地填充目标位置:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/data_get()
data_get 函数使用“点”号表示法,从嵌套数组或对象中获取值:
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 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数字
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 类当前使用的默认语言环境:
use Illuminate\Support\Number;
$locale = Number::defaultLocale();
// enNumber::fileSize()
Number::fileSize 方法将给定字节值以字符串形式返回对应的文件大小表示:
use Illuminate\Support\Number;
$size = Number::fileSize(1024);
// 1 KB
$size = Number::fileSize(1024 * 1024);
// 1 MB
$size = Number::fileSize(1024, precision: 2);
// 1.00 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 方法返回数字的序数表示:
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21stNumber::pairs()
Number::pairs 方法根据指定的范围和步长值生成数字对(子范围)的数组。此方法可用于将较大的数字范围划分为更小、更易管理的子范围,以便用于分页或批处理任务等场景。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::parse()
Number::parse 方法使用 PHP 的 NumberFormatter 解析本地化的数字字符串:
use Illuminate\Support\Number;
$result = Number::parse('10,123', locale: 'en');
// 10123.0
$result = Number::parse('10,123', locale: 'fr');
// 10.123Number::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 方法使用指定的区域设置执行给定的闭包,并在回调执行完成后恢复原始区域设置:
use Illuminate\Support\Number;
$number = Number::withLocale('de', function () {
return Number::format(1500);
});Number::useCurrency()
Number::useCurrency 方法在全局范围内设置默认的数字货币,这会影响后续调用 Number 类方法时货币的格式化方式:
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useCurrency('GBP');
}Number::withCurrency()
Number::withCurrency 方法使用指定的货币执行给定的闭包,并在回调执行完成后恢复原始货币:
use Illuminate\Support\Number;
$number = Number::withCurrency('GBP', function () {
// ...
});路径
app_path()
app_path 函数返回应用程序 app 目录的完全限定路径。您也可以使用 app_path 函数生成应用程序目录下某个文件的完全限定路径:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');base_path()
base_path 函数返回应用程序根目录的完全限定路径。您也可以使用 base_path 函数生成项目根目录下某个文件的完全限定路径:
$path = base_path();
$path = base_path('vendor/bin');config_path()
config_path 函数返回应用程序 config 目录的完全限定路径。您也可以使用 config_path 函数生成应用程序配置目录下某个文件的完全限定路径:
$path = config_path();
$path = config_path('app.php');database_path()
database_path 函数返回应用程序 database 目录的完全限定路径。您也可以使用 database_path 函数生成数据库目录下某个文件的完全限定路径:
$path = database_path();
$path = database_path('factories/UserFactory.php');lang_path()
lang_path 函数返回应用程序 lang 目录的完全限定路径。您也可以使用 lang_path 函数生成该目录下某个文件的完全限定路径:
$path = lang_path();
$path = lang_path('en/messages.php'); 默认情况下,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 函数会为指定的控制器动作生成一个 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]);如果控制器可调用,你只需提供控制器类名即可:
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 函数会抛出一个 HTTP 异常,该异常将由异常处理器渲染:
abort(403);你也可以提供异常的消息以及应发送到浏览器的自定义 HTTP 响应头:
abort(403, 'Unauthorized.', $headers);abort_if()
当给定的布尔表达式求值为 true 时,abort_if 函数会抛出一个 HTTP 异常:
abort_if(! Auth::user()->isAdmin(), 403);与 abort 方法一样,你也可以将异常的响应文本作为第三个参数、一组自定义响应头作为第四个参数传入该函数。
abort_unless()
当给定的布尔表达式求值为 false 时,abort_unless 函数会抛出一个 HTTP 异常:
abort_unless(Auth::user()->isAdmin(), 403);与 abort 方法一样,你也可以将异常的响应文本作为第三个参数、一组自定义响应头作为第四个参数传入该函数。
app()
app 函数会返回服务容器实例:
$container = app();你可以传入一个类名或接口名,以从容器中解析出该实例:
$api = app('HelpSpot\API');auth()
auth 函数会返回一个认证器实例。你可以将其作为 Auth 门面的替代方案使用:
$user = auth()->user();如有需要,你可以指定要访问的守卫实例:
$user = auth('admin')->user();back()
back 函数会生成一个指向用户上一个位置的重定向 HTTP 响应:
return back($status = 302, $headers = [], $fallback = '/');
return back();bcrypt()
bcrypt 函数会使用 Bcrypt 算法对给定值进行哈希处理。你可以使用此函数作为 Hash 门面的替代方案:
$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(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();broadcast_if()
当给定的布尔表达式求值为 true 时,broadcast_if 函数会将给定的事件广播给其监听器:
broadcast_if($user->isActive(), new UserRegistered($user));
broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();broadcast_unless()
当给定的布尔表达式求值为 false 时,broadcast_unless 函数会将给定的事件广播给其监听器:
broadcast_unless($user->isBanned(), new UserRegistered($user));
broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();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 = collect(['Taylor', 'Abigail']);config()
config 函数用于获取 配置 变量的值。可以通过“点”语法访问配置值,即包含文件名和您要访问的选项。您还可以提供一个默认值,当配置选项不存在时将返回该默认值:
$value = config('app.timezone');
$value = config('app.timezone', $default);您可以通过传入键 / 值对数组在运行时设置配置变量。但是请注意,该函数只会影响当前请求的配置值,不会更新实际的配置值:
config(['app.debug' => true]);context()
context 函数用于从当前 上下文 中获取值。您还可以提供一个默认值,当上下文键不存在时将返回该默认值:
$value = context('trace_id');
$value = context('trace_id', $default);您可以通过传入键 / 值对数组来设置上下文值:
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);cookie()
cookie 函数用于创建一个新的 Cookie 实例:
$cookie = cookie('name', 'value', $minutes);csrf_field()
csrf_field 函数生成一个包含 CSRF 令牌值的 HTML hidden 输入字段。例如,使用 Blade 语法:
{{ csrf_field() }}csrf_token()
csrf_token 函数用于获取当前 CSRF 令牌的值:
$token = csrf_token();decrypt()
decrypt 函数用于对给定的值进行 解密。您可以将此函数作为 Crypt 门面的替代方案:
$password = decrypt($value);如需了解 decrypt 的反向操作,请参阅 encrypt 函数。
dd()
dd 函数用于输出给定的变量,并终止脚本的执行:
dd($value);
dd($value1, $value2, $value3, ...);如果您不想中断脚本的执行,请改用 dump 函数。
dispatch()
dispatch 函数将给定的 作业推送到 Laravel 的 作业队列 中:
dispatch(new App\Jobs\SendEmails);dispatch_sync()
dispatch_sync 函数将给定的作业推送到 同步 队列中,以便立即进行处理:
dispatch_sync(new App\Jobs\SendEmails);dump()
dump 函数用于输出给定的变量:
dump($value);
dump($value1, $value2, $value3, ...);如果您想在输出变量后停止执行脚本,请改用 dd 函数。
encrypt()
encrypt 函数用于对给定的值进行 加密。您可以将此函数作为 Crypt 门面的替代方案:
$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(new UserRegistered($user));fake()
fake 函数从容器中解析出一个 Faker 单例,在模型工厂、数据库填充、测试以及视图原型设计中创建模拟数据时,该函数非常实用:
@for ($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor默认情况下,fake 函数将使用您 config/app.php 配置文件中的 app.faker_locale 配置选项。通常,该配置选项是通过 APP_FAKER_LOCALE 环境变量设置的。您也可以通过向 fake 函数传参的方式指定语言环境。每种语言环境都会解析出独立的单例:
fake('nl_NL')->name();filled()
filled 函数用于判断给定的值是否不为“空白”:
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false如需了解 filled 的反向操作,请参阅 blank 函数。
info()
info 函数会将信息写入应用程序的 日志 中:
info('Some helpful information!');还可以向该函数传入一组上下文数据数组:
info('User login attempt failed.', ['id' => $user->id]);literal()
literal 函数会创建一个新的 stdClass 实例,并将给定的具名参数作为属性:
$obj = literal(
name: 'Joe',
languages: ['PHP', 'Ruby'],
);
$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']logger()
logger 函数可用于将一条 debug 级别的消息写入 日志 中:
logger('Debug message');还可以向该函数传入一组上下文数据数组:
logger('User has logged in.', ['id' => $user->id]);如果未向该函数传入值,则会返回一个 logger 实例:
logger()->error('You are not allowed here.');method_field()
method_field 函数生成一个 HTML hidden 输入字段,其中包含表单 HTTP 动词的伪造值。例如,使用 Blade 语法:
<form method="POST">
{{ method_field('DELETE') }}
</form>now()
now 函数会为当前时间创建一个新的 Illuminate\Support\Carbon 实例:
$now = now();old()
$value = old('value');
$value = old('value', 'default');由于作为第二个参数传递给 old 函数的“默认值”通常是 Eloquent 模型的一个属性,Laravel 允许你直接将整个 Eloquent 模型作为第二个参数传递给 old 函数。这样做时,Laravel 会假定传递给 old 函数的第一个参数应被视为“默认值”的 Eloquent 属性名称:
{{ old('name', $user->name) }}
// Is equivalent to...
{{ old('name', $user) }}once()
once 函数会执行给定的回调,并在内存中缓存该结果,缓存时间持续整个请求周期。之后对 once 函数的任意多次调用,只要使用同一个回调,都会返回此前缓存的结果:
function random(): int
{
return once(function () {
return random_int(1, 1000);
});
}
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)当在对象实例内部执行 once 函数时,缓存的结果对该对象实例来说是唯一的:
<?php
class NumberService
{
public function all(): array
{
return once(fn () => [1, 2, 3]);
}
}
$service = new NumberService;
$service->all();
$service->all(); // (cached result)
$secondService = new NumberService;
$secondService->all();
$secondService->all(); // (cached result)optional()
optional 函数接受任意参数,并允许你访问该对象的属性或调用该对象的方法。如果传入的对象为 null,属性和方法将返回 null,而不会抛出错误:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}optional 函数也接受闭包作为其第二个参数。如果作为第一个参数传入的值不是 null,则将调用该闭包:
return optional(User::find($id), function (User $user) {
return $user->name;
});policy()
policy 方法会检索给定类的策略实例:
$policy = policy(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()
若给定的布尔表达式求值结果为 true,report_if 函数会通过你的异常处理器来报告异常:
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');report_unless()
若给定的布尔表达式求值结果为 false,report_unless 函数会通过你的异常处理器来报告异常:
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');request()
request 函数返回当前的请求实例,或从当前请求中获取输入字段的值:
$request = request();
$value = request('key', $default);rescue()
rescue 函数会执行给定的闭包,并捕获执行期间发生的任何异常。所有被捕获的异常都会被发送到你的异常处理器;不过请求会继续处理:
return rescue(function () {
return $this->method();
});你也可以向 rescue 函数传入第二个参数。当闭包执行过程中发生异常时,该参数就是应返回的“默认”值:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});可以为 rescue 函数提供一个 report 参数,用以决定是否通过 report 函数报告异常:
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});resolve()
resolve 函数使用服务容器将给定的类名或接口名解析为实例:
$api = resolve('HelpSpot\API');response()
response 函数用于创建响应实例,或获取响应工厂的实例:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);retry()
retry 函数会尝试执行给定的闭包,直到达到给定的最大尝试次数阈值。如果闭包未抛出异常,则返回其返回值。如果闭包抛出异常,将自动重试。如果超过最大尝试次数,将抛出异常:
return retry(5, function () {
// Attempt 5 times while resting 100ms between attempts...
}, 100);休眠时长也接受 CarbonInterval 实例:
use function Illuminate\Support\seconds;
return retry(5, function () {
// Attempt 5 times while resting 5 seconds between attempts...
}, seconds(5));如果你想手动计算每次尝试之间需要休眠的毫秒数,可以将闭包作为 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 函数可用于获取或设置会话值:
$value = session('key');你可以传入键/值对数组来设置值:
session(['chairs' => 7, 'instruments' => 3]);如果未向该函数传入值,则会返回会话存储:
$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 方法通常返回整数。然而,我们可以通过 tap 函数链式调用 update 方法,强制该方法返回模型本身:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);若要为类添加 tap 方法,可以向该类添加 Illuminate\Support\Traits\Tappable trait。该 trait 的 tap 方法仅接收一个 Closure 作为参数。对象实例本身会传递给该闭包,然后由 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()
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 门面(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()
when 函数会在给定条件计算结果为 true 时返回传入的值。否则,返回 null。如果将闭包作为该函数的第二个参数传入,则会执行该闭包并返回其返回值:
$value = when(true, 'Hello World');
$value = when(true, fn () => 'Hello World');when 函数主要用于有条件地渲染 HTML 属性:
<div {!! when($condition, 'wire:poll="calculate"') !!}>
...
</div>其他实用工具
性能基准测试
有时你可能希望快速测试应用程序中某些部分的性能。此时,你可以使用 Benchmark 支持类,来测量给定回调完成所需的毫秒数:
<?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 方法会返回一个元组,其中包含回调返回的值以及执行回调所花费的毫秒数:
[$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 官方文档。
间隔函数
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 的队列任务允许你将任务排队以便后台处理,但有时你可能有一些简单任务,希望在不配置或维护长期运行的队列工作进程的情况下进行延迟处理。
延迟函数允许你把闭包的执行推迟到向用户发送 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 函数冲突,从而导致 Web 服务器错误。请确保通过显式指定命名空间来调用 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
{
parent::setUp();
$this->withoutDefer();
}
}Lottery
Laravel 的 lottery 类可用于根据一组给定的概率来执行回调。当你只想为传入请求中的一部分请求执行代码时,这特别有用:
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();你可以将 Laravel 的 lottery 类与其他 Laravel 特性结合使用。例如,你可能希望仅将一小部分慢查询报告给异常处理器。而且,由于 lottery 类是可调用的,我们可以将该类的实例传入任何接受可调用对象的方法:
use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;
DB::whenQueryingForLongerThan(
CarbonInterval::seconds(2),
Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);测试 Lottery
Laravel 提供了一些简单的方法,让你能轻松测试应用中 lottery 的调用:
// Lottery 将始终获胜...
Lottery::alwaysWin();
// Lottery 将始终失败...
Lottery::alwaysLose();
// Lottery 将先获胜再失败,最后恢复正常行为...
Lottery::fix([true, false]);
// Lottery 将恢复正常行为...
Lottery::determineResultsNormally();Pipeline
Laravel 的 Pipeline 门面提供了一种便捷的方式,可将给定输入“管道化”通过一系列可调用类、闭包或可调用对象,让每个类都能有机会检查或修改输入,并调用管道中的下一个可调用对象:
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 闭包会调用管道中的下一个可调用对象。你可能已经注意到,这与 中间件非常相似。
当管道中的最后一个可调用对象调用 $next 闭包时,提供给 then 方法的可调用对象将被调用。通常,这个可调用对象只是返回给定的输入。为方便起见,如果你只是想在输入被处理后直接返回输入,可以使用 thenReturn 方法。
当然,正如前面所讨论的,你不必只向管道提供闭包。你也可以提供可调用类。如果提供了类名,该类将通过 Laravel 的 服务容器实例化,从而允许将依赖项注入到可调用类中:
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->thenReturn();可以在管道上调用 withinTransaction 方法,以自动将管道的所有步骤封装在单个数据库事务中:
$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 类提供了多种方法,可用于处理不同的时间单位:
// 睡眠后返回一个值...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
// 在给定值为 true 时持续睡眠...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
// 暂停执行 90 秒...
Sleep::for(1.5)->minutes();
// 暂停执行 2 秒...
Sleep::for(2)->seconds();
// 暂停执行 500 毫秒...
Sleep::for(500)->milliseconds();
// 暂停执行 5000 微秒...
Sleep::for(5000)->microseconds();
// 暂停执行直到给定时间...
Sleep::until(now()->plus(minutes: 1));
// PHP 原生 “sleep” 函数的别名...
Sleep::sleep(2);
// PHP 原生 “usleep” 函数的别名...
Sleep::usleep(5000);为了轻松组合时间单位,可以使用 and 方法:
Sleep::for(1)->second()->and(10)->milliseconds();测试 Sleep
在测试使用 Sleep 类或 PHP 原生睡眠函数的代码时,你的测试会暂停执行。正如你所预料的,这会让测试套件的运行速度显著变慢。例如,假设你正在测试以下代码:
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}通常情况下,测试这段代码至少需要一秒时间。幸运的是,Sleep 类允许我们“伪造”睡眠,从而保持测试套件的快速运行:
it('waits until ready', function () {
Sleep::fake();
// ...
});public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}当伪造 Sleep 类时,实际的执行暂停会被绕过,从而让测试速度大幅提升。
一旦 Sleep 类被伪造,就可以针对预期应当发生的“睡眠”进行断言。为了说明这一点,假设我们正在测试一段会暂停执行三次的代码,且每次暂停的时间依次增加一秒。使用 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;
// 断言 sleep 被调用了 3 次...
Sleep::assertSleptTimes(3);
// 针对休眠时长进行断言...
Sleep::assertSlept(function (Duration $duration): bool {
return /* ... */;
}, times: 1);
// 断言 Sleep 类从未被调用...
Sleep::assertNeverSlept();
// 断言即使调用了 Sleep,也没有发生执行暂停...
Sleep::assertInsomniac();有时,在发生模拟休眠时执行某个操作可能会很有用。要实现这一点,您可以向 whenFakingSleep 方法提供回调函数。在下面的示例中,我们使用 Laravel 的时间操作辅助函数,根据每次休眠的时长瞬间推进时间:
use Carbon\CarbonInterval as Duration;
$this->freezeTime();
Sleep::fake();
Sleep::whenFakingSleep(function (Duration $duration) {
// 在模拟休眠时推进时间...
$this->travel($duration->totalMilliseconds)->milliseconds();
});由于推进时间是常见需求,fake 方法接受一个 syncWithCarbon 参数,以便在测试中休眠时保持与 Carbon 同步:
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second agoLaravel 在暂停执行时会在内部使用 Sleep 类。例如,重试辅助函数在休眠时会使用 Sleep 类,这样在使用该辅助函数时可提高可测试性。
Timebox
Laravel 的 Timebox 类可确保给定回调函数的执行始终耗费固定的时长,即便其实际执行完成得更早。这在加密操作和用户身份验证检查等场景中尤为有用,因为攻击者可能会利用执行时间的差异来推断敏感信息。
如果执行时长超过了固定时长,Timebox 不会产生任何作用。开发者需要选择一个足够长的时长作为固定时长,以应对最坏的情况。
call 方法接收一个闭包和以微秒为单位的时间限制,随后执行该闭包并等待直至达到时间限制:
use Illuminate\Support\Timebox;
(new Timebox)->call(function ($timebox) {
// ...
}, microseconds: 10000);如果闭包内抛出了异常,该类将遵循设定的延迟,并在延迟结束后重新抛出异常。
URI
Laravel 的 Uri 类为创建和操作 URI 提供了一个便捷且流畅的接口。该类封装了底层 League URI 包所提供的功能,并能与 Laravel 的路由系统无缝集成。
您可以使用静态方法轻松创建 Uri 实例:
use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;
// 根据给定字符串生成 URI 实例...
$uri = Uri::of('https://example.com/path');
// 针对路径、具名路由或控制器动作生成 URI 实例...
$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);
// 根据当前请求 URL 生成 URI 实例...
$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();操作查询字符串
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']);
});