跳至内容

Helpers

介绍

Laravel 包含各种全局的 PHP “辅助” 函数。其中许多函数由框架本身使用;但是,如果您觉得方便,也可以在自己的应用程序中自由使用它们。

可用方法

数组和对象

数字

路径

网址

各种各样的

数组和对象

Arr::accessible()

Arr::accessible方法确定给定值是否可由数组访问:

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

Arr::add()

Arr::add如果给定的键在数组中不存在或者设置为,则该方法将给定的键/值对添加到数组中null

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

Arr::array()

该方法使用“点”符号(就像Arr::get()Arr::array一样)从深度嵌套的数组中检索值,但如果请求的值不是,则会抛出InvalidArgumentExceptionarray

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$value = Arr::array($array, 'languages');
6 
7// ['PHP', 'Ruby']
8 
9$value = Arr::array($array, 'name');
10 
11// throws InvalidArgumentException

Arr::boolean()

该方法使用“点”符号(就像Arr::get()Arr::boolean一样)从深度嵌套的数组中检索值,但如果请求的值不是,则会抛出InvalidArgumentExceptionboolean

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'available' => true];
4 
5$value = Arr::boolean($array, 'available');
6 
7// true
8 
9$value = Arr::boolean($array, 'name');
10 
11// throws InvalidArgumentException

Arr::collapse()

Arr::collapse方法将数组数组折叠成单个数组:

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

Arr::crossJoin()

Arr::crossJoin方法交叉连接给定的数组,返回具有所有可能排列的笛卡尔积:

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

Arr::divide()

Arr::divide方法返回两个数组:一个包含给定数组的键,另一个包含给定数组的值:

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

Arr::dot()

Arr::dot方法将多维数组展平为单级数组,使用“点”符号表示深度:

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

Arr::except()

Arr::except方法从数组中删除给定的键/值对:

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

Arr::exists()

Arr::exists方法检查给定的键是否存在于提供的数组中:

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

Arr::first()

Arr::first方法返回通过给定真值测试的数组的第一个元素:

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

也可以将默认值作为第三个参数传递给该方法。如果没有值通过真值测试,则返回此值:

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

Arr::flatten()

Arr::flatten方法将多维数组展平为单级数组:

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

Arr::float()

该方法使用“点”符号(就像Arr::get()Arr::float一样)从深度嵌套的数组中检索值,但如果请求的值不是,则会抛出InvalidArgumentExceptionfloat

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'balance' => 123.45];
4 
5$value = Arr::float($array, 'balance');
6 
7// 123.45
8 
9$value = Arr::float($array, 'name');
10 
11// throws InvalidArgumentException

Arr::forget()

Arr::forget方法使用“点”符号从深度嵌套的数组中删除给定的键/值对:

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

Arr::from()

Arr::from方法将各种输入类型转换为普通的 PHP 数组。它支持多种输入类型,包括数组、对象以及一些常见的 Laravel 接口,例如ArrayableEnumerableJsonableJsonSerializable。此外,它还处理TraversableWeakMap实例:

1use Illuminate\Support\Arr;
2 
3Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']
4 
5class TestJsonableObject implements Jsonable
6{
7 public function toJson($options = 0)
8 {
9 return json_encode(['foo' => 'bar']);
10 }
11}
12 
13Arr::from(new TestJsonableObject); // ['foo' => 'bar']

Arr::get()

Arr::get方法使用“点”符号从深度嵌套的数组中检索值:

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

Arr::get方法还接受一个默认值,如果数组中不存在指定的键,则返回该默认值:

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

Arr::has()

Arr::has方法使用“点”符号检查数组中是否存在给定的项目:

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

Arr::hasAll()

Arr::hasAll方法使用“点”符号确定给定数组中是否存在所有指定的键:

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Taylor', 'language' => 'PHP'];
4 
5Arr::hasAll($array, ['name']); // true
6Arr::hasAll($array, ['name', 'language']); // true
7Arr::hasAll($array, ['name', 'IDE']); // false

Arr::hasAny()

Arr::hasAny方法使用“点”符号检查给定集合中的任何项目是否存在于数组中:

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

Arr::integer()

该方法使用“点”符号(就像Arr::get()Arr::integer一样)从深度嵌套的数组中检索值,但如果请求的值不是,则会抛出InvalidArgumentExceptionint

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'age' => 42];
4 
5$value = Arr::integer($array, 'age');
6 
7// 42
8 
9$value = Arr::integer($array, 'name');
10 
11// throws InvalidArgumentException

Arr::isAssoc()

如果给定数组是关联数组,则该Arr::isAssoc方法返回结果true。如果数组中没有以零开头的连续数字键,则该数组被视为“关联”数组:

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

Arr::isList()

如果给定数组的键是从零开始的连续整数,则Arr::isList方法返回:true

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

Arr::join()

Arr::join方法使用字符串连接数组元素。使用此方法的第二个参数,您还可以指定数组最后一个元素的连接字符串:

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

Arr::keyBy()

Arr::keyBy方法使用给定的键来设置数组的键。如果多个元素具有相同的键,则只有最后一个元素会出现在新数组中:

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

Arr::last()

Arr::last方法返回通过给定真值测试的数组的最后一个元素:

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

可以将默认值作为该方法的第三个参数传递。如果没有值通过真值测试,则返回此值:

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

Arr::map()

Arr::map方法遍历数组,并将每个值和键传递给给定的回调。数组值将被回调返回的值替换:

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

Arr::mapSpread()

Arr::mapSpread方法迭代数组,将每个嵌套项的值传递给给定的闭包。闭包可以自由修改该项并将其返回,从而形成一个包含已修改项的新数组:

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

Arr::mapWithKeys()

Arr::mapWithKeys方法遍历数组并将每个值传递给给定的回调。回调应该返回一个包含单个键/值对的关联数组:

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

Arr::only()

Arr::only方法仅返回给定数组中的指定键/值对:

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

Arr::partition()

Arr::partition方法可以与 PHP 数组解构相结合,将通过给定真值测试的元素与未通过给定真值测试的元素分开:

1<?php
2 
3use Illuminate\Support\Arr;
4 
5$numbers = [1, 2, 3, 4, 5, 6];
6 
7[$underThree, $equalOrAboveThree] = Arr::partition($numbers, function (int $i) {
8 return $i < 3;
9});
10 
11dump($underThree);
12 
13// [1, 2]
14 
15dump($equalOrAboveThree);
16 
17// [3, 4, 5, 6]

Arr::pluck()

Arr::pluck方法从数组中检索给定键的所有值:

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

您还可以指定结果列表的键入方式:

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

Arr::prepend()

Arr::prepend方法将把一个项目推送到数组的开头:

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

如果需要,您可以指定应该用于值的键:

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

Arr::prependKeysWith()

Arr::prependKeysWith将给定的前缀添加到关联数组的所有键名中

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

Arr::pull()

Arr::pull方法返回并从数组中删除一个键/值对:

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

可以将默认值作为该方法的第三个参数传递。如果键不存在,则返回此值:

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

Arr::query()

Arr::query方法将数组转换为查询字符串:

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

Arr::random()

Arr::random方法从数组中返回一个随机值:

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

您还可以将要返回的项目数指定为可选的第二个参数。请注意,即使只需要一个项目,提供此参数也会返回一个数组:

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

Arr::reject()

Arr::reject方法使用给定的闭包从数组中删除项目:

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

Arr::select()

Arr::select方法从数组中选择一个值数组:

1use Illuminate\Support\Arr;
2 
3$array = [
4 ['id' => 1, 'name' => 'Desk', 'price' => 200],
5 ['id' => 2, 'name' => 'Table', 'price' => 150],
6 ['id' => 3, 'name' => 'Chair', 'price' => 300],
7];
8 
9Arr::select($array, ['name', 'price']);
10 
11// [['name' => 'Desk', 'price' => 200], ['name' => 'Table', 'price' => 150], ['name' => 'Chair', 'price' => 300]]

Arr::set()

Arr::set方法使用“点”符号在深度嵌套的数组中设置一个值:

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

Arr::shuffle()

Arr::shuffle方法随机打乱数组中的项目:

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

Arr::sole()

Arr::sole方法使用给定的闭包从数组中检索单个值。如果数组中多个值符合给定的真值测试,Illuminate\Support\MultipleItemsFoundException则会抛出异常。如果没有值符合真值测试,Illuminate\Support\ItemNotFoundException则会抛出异常:

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
6 
7// 'Desk'

Arr::sort()

Arr::sort方法根据数组的值对数组进行排序:

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

您还可以根据给定闭包的结果对数组进行排序:

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

Arr::sortDesc()

Arr::sortDesc方法按数组值的降序对数组进行排序:

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

您还可以根据给定闭包的结果对数组进行排序:

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

Arr::sortRecursive()

该方法使用数字索引子数组函数和关联子数组函数Arr::sortRecursive以递归方式对数组进行排序:sortksort

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

如果您希望结果按降序排列,您可以使用该Arr::sortRecursiveDesc方法。

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

Arr::string()

该方法使用“点”符号(就像Arr::get()Arr::string一样)从深度嵌套的数组中检索值,但如果请求的值不是,则会抛出InvalidArgumentExceptionstring

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$value = Arr::string($array, 'name');
6 
7// Joe
8 
9$value = Arr::string($array, 'languages');
10 
11// throws InvalidArgumentException

Arr::take()

Arr::take方法返回具有指定数量项目的新数组:

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

您还可以传递一个负整数来从数组末尾获取指定数量的项目:

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

Arr::toCssClasses()

Arr::toCssClasses方法会根据条件编译 CSS 类字符串。该方法接受一个类数组作为参数,数组键包含要添加的一个或多个类,值则为布尔表达式。如果数组元素的键为数字,则该元素将始终包含在渲染的类列表中:

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

Arr::toCssStyles()

Arr::toCssStyles方法会根据条件编译 CSS 样式字符串。该方法接受一个类数组作为参数,数组键包含要添加的类,值则为布尔表达式。如果数组元素的键为数字,则该元素将始终包含在渲染的类列表中:

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

此方法增强了 Laravel 的功能,允许将类与 Blade 组件的属性包以及@class Blade 指令合并。

Arr::undot()

Arr::undot方法将使用“点”符号的一维数组扩展为多维数组:

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

Arr::where()

Arr::where方法使用给定的闭包过滤数组:

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

Arr::whereNotNull()

该方法从给定数组中Arr::whereNotNull删除所有值:null

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

Arr::wrap()

Arr::wrap方法将给定值包装到数组中。如果给定值已经是数组,则直接返回原值:

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

如果给定的值为null,则返回一个空数组:

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

data_fill()

data_fill函数使用“点”符号设置嵌套数组或对象中的缺失值:

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

此函数还接受星号作为通配符,并将相应地填充目标:

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

data_get()

data_get函数使用“点”符号从嵌套数组或对象中检索值:

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

data_get函数还接受一个默认值,如果未找到指定的键,则返回该默认值:

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

该函数还接受使用星号的通配符,它​​可以针对数组或对象的任何键:

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

{first}和占位{last}可用于检索数组中的第一个或最后一个项目:

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

data_set()

data_set函数使用“点”符号在嵌套数组或对象中设置一个值:

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

此函数还接受使用星号的通配符,并将相应地在目标上设置值:

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

默认情况下,所有现有值都会被覆盖。如果您希望仅在不存在时设置值,可以将false第四个参数传递给函数:

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

data_forget()

data_forget函数使用“点”符号删除嵌套数组或对象内的值:

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

此函数还接受使用星号的通配符,并将相应地删除目标上的值:

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

head()

head函数返回给定数组中的第一个元素:

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

last()

last函数返回给定数组中的最后一个元素:

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

数字

Number::abbreviate()

Number::abbreviate方法返回所提供的数值的人类可读格式,并带有单位的缩写:

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

Number::clamp()

Number::clamp方法确保给定数字保持在指定范围内。如果数字小于最小值,则返回最小值。如果数字大于最大值,则返回最大值:

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

Number::currency()

Number::currency方法以字符串形式返回给定值的货币表示形式:

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

Number::defaultCurrency()

Number::defaultCurrency方法返回该类正在使用的默认货币Number

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

Number::defaultLocale()

Number::defaultLocale方法返回该类正在使用的默认语言环境Number

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

Number::fileSize()

Number::fileSize方法以字符串形式返回给定字节值的文件大小表示:

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

Number::forHumans()

Number::forHumans方法返回所提供的数值的人类可读格式:

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

Number::format()

Number::format方法将给定的数字格式化为特定于语言环境的字符串:

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

Number::ordinal()

Number::ordinal方法返回数字的序数表示:

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

Number::pairs()

Number::pairs方法根据指定的范围和步长值生成一个数字对(子范围)的数组。此方法可用于将较大的数字范围划分为较小的、易于管理的子范围,例如分页或批处理任务。该方法pairs返回一个数组数组,其中每个内部数组代表一对数字(子范围):

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

Number::percentage()

Number::percentage方法以字符串形式返回给定值的百分比表示:

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

Number::spell()

Number::spell方法将给定的数字转换为一串单词:

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

after参数允许您指定一个值,该值之后的所有数字都应拼写出来:

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

until参数允许您指定一个值,在该值之前应拼写出所有数字:

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

Number::spellOrdinal()

Number::spellOrdinal方法以字符串形式返回数字的序数表示形式:

1use Illuminate\Support\Number;
2 
3$number = Number::spellOrdinal(1);
4 
5// first
6 
7$number = Number::spellOrdinal(2);
8 
9// second
10 
11$number = Number::spellOrdinal(21);
12 
13// twenty-first

Number::trim()

Number::trim方法删除给定数字小数点后的任何尾随零数字:

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

Number::useLocale()

Number::useLocale方法全局设置默认数字语言环境,这会影响后续调用该类的方法时数字和货币的格式Number

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

Number::withLocale()

Number::withLocale方法使用指定的语言环境执行给定的闭包,然后在回调执行后恢复原始语言环境:

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

Number::useCurrency()

Number::useCurrency方法全局设置默认数字货币,这会影响后续调用类的方法时货币的格式化方式Number

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

Number::withCurrency()

Number::withCurrency方法使用指定的货币执行给定的闭包,然后在回调执行后恢复原始货币:

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

路径

app_path()

app_path函数返响应用程序app目录的完整路径。你也可以使用该app_path函数生成相对于应用程序目录的文件的完整路径:

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

base_path()

base_path函数返响应用程序根目录的完整路径。您还可以使用该base_path函数生成相对于项目根目录的给定文件的完全限定路径:

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

config_path()

config_path函数返响应用程序config目录的完整路径。你还可以使用该config_path函数生成应用程序配置目录中给定文件的完整路径:

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

database_path()

database_path函数返响应用程序database目录的完整路径。您还可以使用该database_path函数生成数据库目录中给定文件的完整路径:

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

lang_path()

lang_path函数返响应用程序lang目录的完整路径。您还可以使用该lang_path函数生成目录中给定文件的完整路径:

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

默认情况下,Laravel 应用程序骨架不包含该lang目录。如果您想自定义 Laravel 的语言文件,可以通过lang:publishArtisan 命令发布它们。

mix()

该函数返回版本化 Mix 文件mix的路径

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

public_path()

public_path函数返响应用程序public目录的完整路径。您还可以使用该public_path函数生成公共目录中给定文件的完整路径:

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

resource_path()

resource_path函数返响应用程序resources目录的完整路径。您还可以使用该resource_path函数生成资源目录中给定文件的完整路径:

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

storage_path()

storage_path函数返响应用程序storage目录的完整路径。您还可以使用该storage_path函数生成存储目录中给定文件的完整路径:

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

网址

action()

action函数为给定的控制器操作生成一个 URL:

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

如果该方法接受路由参数,则可以将它们作为第二个参数传递给该方法:

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

asset()

asset函数使用请求的当前方案(HTTP 或 HTTPS)为资产生成 URL:

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

ASSET_URL您可以通过在文件中设置变量来配置资源 URL 主机.env。如果您将资源托管在 Amazon S3 或其他 CDN 等外部服务上,这将非常有用:

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

route()

该函数为给定的命名路由route生成一个 URL

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

如果路由接受参数,您可以将它们作为第二个参数传递给函数:

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

默认情况下,该route函数生成绝对 URL。如果您希望生成相对 URL,可以将false第三个参数传递给该函数:

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

secure_asset()

secure_asset函数使用 HTTPS 为资产生成 URL:

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

secure_url()

secure_url函数生成指向给定路径的完全限定 HTTPS URL。其他 URL 段可以在函数的第二个参数中传递:

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

to_route()

该函数为给定的命名路由to_route生成重定向 HTTP 响应

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

如果有必要,您可以将应分配给重定向的 HTTP 状态代码和任何附加响应标头作为该to_route方法的第三和第四个参数传递:

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

uri()

该函数为给定的 URIuri生成一个流畅的 URI 实例:

1$uri = uri('https://example.com')
2 ->withPath('/users')
3 ->withQuery(['page' => 1])

如果uri给函数一个包含可调用控制器和方法对的数组,则该函数将为Uri控制器方法的路由路径创建一个实例:

1use App\Http\Controllers\UserController;
2 
3$uri = uri([UserController::class, 'show'], ['user' => $user])

如果控制器是可调用的,您可以简单地提供控制器类名:

1use App\Http\Controllers\UserIndexController;
2 
3$uri = uri(UserIndexController::class);

如果赋予函数的值与命名路由uri的名称匹配则会为该路由的路径生成一个实例:Uri

1$uri = uri('users.show', ['user' => $user]);

url()

url函数生成给定路径的完全限定 URL:

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

如果没有提供路径,Illuminate\Routing\UrlGenerator则返回一个实例:

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

各种各样的

abort()

abort函数抛出一个 HTTP 异常,该异常将由异常处理程序呈现

1abort(403);

您还可以提供应发送到浏览器的异常消息和自定义 HTTP 响应标头:

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

abort_if()

如果给定的布尔表达式计算结果为:则该abort_if函数将引发 HTTP 异常:true

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

与方法一样abort,您还可以提供异常的响应文本作为第三个参数,并提供自定义响应标头数组作为函数的第四个参数。

abort_unless()

如果给定的布尔表达式计算结果为:则该abort_unless函数将引发 HTTP 异常:false

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

与方法一样abort,您还可以提供异常的响应文本作为第三个参数,并提供自定义响应标头数组作为函数的第四个参数。

app()

app函数返回服务容器实例:

1$container = app();

您可以传递类或接口名称来从容器中解析它:

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

auth()

auth函数返回一个Authenticator实例。你可以使用它来替代AuthFacade:

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

如果需要,您可以指定要访问哪个保护实例:

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

back()

back函数生成一个重定向 HTTP 响应到用户之前的位置:

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

bcrypt()

bcrypt函数使用 Bcrypt 对给定值进行哈希处理。你可以使用此函数作为 Facade 的替代Hash

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

blank()

blank函数确定给定值是否为“空白”:

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

对于的逆blank,请参阅filled方法。

broadcast()

broadcast函数将给定的事件广播给其监听器:

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

cache()

cache函数可用于从缓存中获取值。如果给定的键在缓存中不存在,则返回可选的默认值:

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

你可以通过向函数传递一个键值对数组来将项目添加到缓存中。你还应该传递缓存值有效的秒数或持续时间:

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

class_uses_recursive()

class_uses_recursive函数返回一个类使用的所有特征,包括其所有父类使用的特征:

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

collect()

该函数根据给定值collect创建一个集合实例:

1$collection = collect(['Taylor', 'Abigail']);

config()

该函数获取配置config变量的值。可以使用“点”语法访问配置值,该语法包含文件名和要访问的选项。可以指定默认值,如果配置选项不存在,则返回默认值:

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

你可以在运行时通过传递键值对数组来设置配置变量。但请注意,此函数仅影响当前请求的配置值,并不会更新你的实际配置值:

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

context()

该函数从当前 contextcontext获取值。可以指定默认值,如果 context 键不存在,则返回默认值:

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

您可以通过传递键/值对数组来设置上下文值:

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

cookie函数创建一个新的cookie实例:

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

csrf_field()

csrf_field函数生成一个hidden包含 CSRF 令牌值的 HTML 输入字段。例如,使用Blade 语法

1{{ csrf_field() }}

csrf_token()

csrf_token函数检索当前 CSRF 令牌的值:

1$token = csrf_token();

decrypt()

decrypt函数解密给定的值。你可以使用这个函数来替代CryptFacade:

1$password = decrypt($value);

dd()

dd函数转储给定的变量并结束脚本的执行:

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

如果您不想停止脚本的执行,请使用dump函数。

dispatch()

dispatch函数将给定的作业推送到 Laravel作业队列

1dispatch(new App\Jobs\SendEmails);

dispatch_sync()

dispatch_sync函数将给定的作业推送到同步队列,以便立即处理:

1dispatch_sync(new App\Jobs\SendEmails);

dump()

dump函数转储给定的变量:

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

如果您想在转储变量后停止执行脚本,请使用dd函数。

encrypt()

encrypt函数加密给定的值。你可以使用此函数作为外观函数的替代Crypt

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

env()

该函数检索环境变量env的值或返回默认值:

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

如果在部署过程中执行该config:cache命令,则应确保仅env在配置文件中调用该函数。一旦配置被缓存,该.env文件将不会被加载,并且所有对该env函数的调用都将返回null

event()

event函数将给定的事件分派给其侦听器:

1event(new UserRegistered($user));

fake()

fake函数从容器中解析一个Faker单例,这在模型Factories、数据库Seeding、测试和原型视图中创建虚假数据时很有用:

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

默认情况下,该fake函数将使用app.faker_localeconfig/app.php配置中的配置选项。通常,此配置选项通过环境变量设置APP_FAKER_LOCALE。你还可以通过将语言环境传递给该fake函数来指定。每个语言环境将解析一个单独的单例:

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

filled()

filled函数确定给定值是否为“空白”:

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

对于的逆filled,请参见空白法。

info()

info函数将把信息写入应用程序的日志

1info('Some helpful information!');

上下文数据数组也可以传递给函数:

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

literal()

该函数使用给定的命名参数作为属性literal创建一个新的stdClass实例:

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

logger()

logger函数可用于将debug级别消息写入日志

1logger('Debug message');

上下文数据数组也可以传递给函数:

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

如果没有向函数传递任何值,则将返回一个记录器实例:

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

method_field()

method_field函数生成一个 HTMLhidden输入字段,其中包含表单 HTTP 动词的欺骗值。例如,使用Blade 语法

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

now()

该函数为当前时间now创建一个新实例:Illuminate\Support\Carbon

1$now = now();

old()

old函数检索闪入会话的旧输入值:

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

由于函数的第二个参数“默认值”old通常是 Eloquent 模型的属性,因此 Laravel 允许你直接将整个 Eloquent 模型作为第二个参数传递给old函数。这样做时,Laravel 会假定传递给函数的第一个参数old是应该被视为“默认值”的 Eloquent 属性的名称:

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

once()

once函数执行给定的回调,并在请求期间将结果缓存在内存中。任何后续once使用相同回调函数的调用都将返回先前缓存的结果:

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

once当从对象实例内部执行该函数时,缓存的结果将是该对象实例唯一的:

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

optional()

optional函数接受任意参数,并允许你访问该对象的属性或调用其方法。如果给定的对象是null,则其属性和方法将返回,null而不会引发错误:

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

optional函数还接受一个闭包作为其第二个参数。如果第一个参数的值不为 null,则将调用该闭包:

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

policy()

policy方法检索给定类的策略实例:

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

redirect()

redirect函数返回重定向 HTTP 响应,或者在没有参数的情况下调用时返回重定向器实例:

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

report()

该函数将使用您的异常处理程序report报告异常

1report($e);

report函数还接受一个字符串作为参数。当向该函数传入一个字符串时,该函数将创建一个以给定字符串作为消息的异常:

1report('Something went wrong.');

report_if()

如果给定的条件是该函数将使用异常处理程序report_if报告异常:true

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

report_unless()

如果给定的条件是该函数将使用异常处理程序report_unless报告异常:false

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

request()

request函数返回当前请求实例或从当前请求中获取输入字段的值:

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

rescue()

rescue函数执行给定的闭包并捕获执行过程中发生的任何异常。所有捕获的异常都将发送到你的异常处理程序;但是,请求将继续处理:

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

你也可以向函数传递第二个参数rescue。如果在执行闭包时发生异常,则此参数将作为“默认”值返回:

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

report可以向函数提供一个参数rescue来确定是否应该通过该函数报告异常report

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

resolve()

该函数使用服务容器resolve将给定的类或接口名称解析为实例

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

response()

response函数创建响应实例或获取响应Factories的实例:

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

retry()

retry函数会尝试执行给定的回调,直到达到给定的最大尝试次数阈值。如果回调未引发异常,则将返回其返回值。如果回调引发异常,则会自动重试。如果超过最大尝试次数,则会引发异常:

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

如果您想手动计算尝试之间休眠的毫秒数,您可以将闭包作为第三个参数传递给retry函数:

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

为了方便起见,你可以提供一个数组作为函数的第一个参数retry。该数组将用于确定后续尝试之间需要休眠多少毫秒:

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

要仅在特定条件下重试,您可以将闭包作为第四个参数传递给retry函数:

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

session()

session函数可用于获取或设置会话值:

1$value = session('key');

您可以通过将键/值对数组传递给函数来设置值:

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

如果没有向函数传递任何值,则将返回会话存储:

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

tap()

tap函数接受两个参数:一个任意值$value和一个闭包。$value将被传递给闭包,然后由函数返回tap。闭包的返回值无关紧要:

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

如果没有向函数传递闭包tap,则可以对给定的 调用任何方法。无论该方法在其定义中实际返回什么,$value调用方法的返回值始终为。例如,Eloquent 方法通常返回一个整数。但是,我们可以通过在函数中链接方法调用来强制该方法返回模型本身$valueupdateupdatetap

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

要为类添加tap方法,可以添加Illuminate\Support\Traits\Tappabletrait。tap此 trait 的方法接受一个闭包作为其唯一参数。对象实例本身将被传递给闭包,然后由该方法返回tap

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

throw_if()

如果给定的布尔表达式计算结果为:则该throw_if函数抛出给定的异常:true

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

throw_unless()

如果给定的布尔表达式计算结果为:则该throw_unless函数抛出给定的异常:false

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

today()

该函数为当前日期today创建一个新实例:Illuminate\Support\Carbon

1$today = today();

trait_uses_recursive()

trait_uses_recursive函数返回特征所使用的所有特征:

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

transform()

transform如果值不为空,则该函数对给定值执行闭包,然后返回闭包的返回值:

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

可以将默认值或闭包作为第三个参数传递给函数。如果给定值为空,则返回此值:

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

validator()

validator函数使用给定的参数创建一个新的验证器实例。你可以使用它来替代ValidatorFacade:

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

value()

函数value返回所传入的值。但是,如果将闭包传递给函数,闭包将被执行,并返回其返回值:

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

可以将附加参数传递给value函数。如果第一个参数是闭包,则附加参数将作为参数传递给闭包,否则将被忽略:

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

view()

view函数检索视图实例:

1return view('auth.login');

with()

函数with返回给定的值。如果将闭包作为第二个参数传递给函数,则闭包将被执行并返回其返回值:

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

when()

如果给定条件的计算结果为 ,则函数when返回给定的值true。否则,null返回 。如果将闭包作为第二个参数传递给函数,则闭包将被执行并返回其返回值:

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

when函数主要用于有条件地渲染 HTML 属性:

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

其他实用程序

基准测试

有时你可能希望快速测试应用程序某些部分的性能。在这种情况下,你可以使用Benchmarksupport 类来测量给定回调完成所需的毫秒数:

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

默认情况下,给定的回调将执行一次(一次迭代),并且它们的持续时间将显示在浏览器/控制台中。

要多次调用回调,可以将回调调用的迭代次数指定为该方法的第二个参数。当多次执行回调时,该类Benchmark将返回所有迭代中执行回调所需的平均毫秒数:

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

有时,你可能希望对回调的执行情况进行基准测试,同时仍获取回调的返回值。该value方法将返回一个元组,其中包含回调的返回值以及执行回调所需的毫秒数:

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

日期

Laravel 包含Carbon,一个强大的日期和时间操作库。要创建新Carbon实例,您可以调用该now函数。此函数在您的 Laravel 应用程序中全局可用:

1$now = now();

或者,您可以Carbon使用该类创建一个新实例Illuminate\Support\Carbon

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

有关 Carbon 及其特性的详细讨论,请参阅官方 Carbon 文档

延迟函数

虽然 Laravel 的排队作业允许您将任务排队以进行后台处理,但有时您可能希望推迟简单的任务,而无需配置或维护长时间运行的队列工作器。

延迟函数允许你将闭包的执行延迟到 HTTP 响应发送给用户之后,从而保持应用程序的快速响应。要延迟闭包的执行,只需将闭包传递给Illuminate\Support\defer函数即可:

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

默认情况下,延迟函数仅在调用它的 HTTP 响应、Artisan 命令或队列作业Illuminate\Support\defer成功完成后才会执行。这意味着,如果请求导致一个4xx5xxHTTP 响应,延迟函数将不会被执行。如果你希望延迟函数始终执行,可以将该always方法链接到延迟函数上:

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

取消延迟函数

如果你需要在延迟函数执行前取消它,可以使用该forget方法通过函数名称来取消它。要命名延迟函数,请为该Illuminate\Support\defer函数提供第二个参数:

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

在测试中禁用延迟函数

编写测试时,禁用延迟函数可能会很有用。你可以withoutDefer在测试中调用以下命令来指示 Laravel 立即调用所有延迟函数:

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

如果您想要禁用测试用例中所有测试的延迟函数,您可以withoutDefersetUpTestCase类的方法中调用该方法:

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

Lottery

Laravel 的 lottery 类可用于根据给定的概率执行回调。当你只想为一定比例的传入请求执行代码时,这尤其有用:

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

您可以将 Laravel 的 lottery 类与其他 Laravel 功能结合使用。例如,您可能希望仅向异常处理程序报告一小部分慢速查询。此外,由于 lottery 类是可调用的,我们可以将该类的实例传递给任何接受可调用函数的方法:

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

测试Lottery

Laravel 提供了一些简单的方法,让您可以轻松测试应用程序的Lottery调用:

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

Pipeline

Laravel 的Pipeline外观提供了一种方便的方法,可以通过一系列可调用的类、闭包或可调用函数来“Pipeline”给定的输入,从而使每个类都有机会检查或修改输入并调用Pipeline中的下一个可调用函数:

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

如你所见,Pipeline中的每个可调用类或闭包都提供了输入和一个$next闭包。调用$next闭包将调用Pipeline中的下一个可调用函数。你可能已经注意到,这与中间件非常相似。

当Pipeline中的最后一个可调用函数调用闭$next包时,提供给该方法的可调用函数then将被调用。通常,此可调用函数只会返回给定的输入。

当然,正如之前所讨论的,你并不局限于为Pipeline提供闭包。你也可以提供可调用类。如果提供了类名,该类将通过 Laravel 的服务容器实例化,从而允许将依赖项注入到可调用类中:

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

Sleep

Laravel 的类是 PHP 原生函数Sleep的轻量级包装器,提供了更高的可测试性,同时还公开了开发人员友好的用于处理时间的 API:sleepusleep

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

Sleep课程提供了多种方法,允许您使用不同的时间单位:

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

为了轻松地组合时间单位,您可以使用该and方法:

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

测试睡眠

当测试使用了该类或 PHP 原生 sleep 函数的代码时Sleep,测试将暂停执行。正如您所料,这会显著降低测试套件的运行速度。例如,假设您正在测试以下代码:

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

通常,测试这段代码至少需要一秒钟。幸运的是,这个Sleep类允许我们“假装”处于睡眠状态,这样我们的测试套件就能保持快速运行:

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

当伪造Sleep类时,实际的执行暂停被绕过,从而大大加快测试速度。

一旦Sleep类被伪造,就可以针对应该发生的预期“睡眠”做出断言。为了说明这一点,假设我们正在测试暂停执行三次的代码,每次暂停增加一秒。使用该assertSequence方法,我们可以断言我们的代码“睡眠”了适当的时间,同时保持测试快速运行:

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

当然,Sleep该类还提供了您在测试时可以使用的各种其他断言:

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

有时,每当应用程序代码中出现模拟睡眠时执行某个操作可能会很有用。为此,您可以为该whenFakingSleep方法提供一个回调。在下面的示例中,我们使用 Laravel 的时间操作Helpers,按每次睡眠的持续时间即时推进时间:

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

由于时间进展是一个常见的要求,该fake方法接受一个syncWithCarbon参数,以便在测试中休眠时保持 Carbon 同步:

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

LaravelSleep每次暂停执行时都会在内部使用该类。例如,重试Helpers在休眠时会使用该类Sleep,从而提高使用该Helpers时的可测试性。

时间盒

Laravel 的Timebox类确保给定的回调始终需要固定的执行时间,即使其实际执行完成得更快。这对于加密操作和用户身份验证检查尤其有用,因为攻击者可能会利用执行时间的变化来推断敏感信息。

如果执行时间超过固定时长,Timebox则不会产生任何影响。开发人员需要选择足够长的时间作为固定时长,以应对最坏的情况。

call 方法接受一个闭包和一个以微秒为单位的时间限制,然后执行闭包并等待直到达到时间限制:

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

如果闭包内抛出异常,此类将遵守定义的延迟并在延迟后重新抛出异常。

URI

Laravel 的Uri类提供了一个便捷流畅的接口来创建和操作 URI。该类封装了底层 League URI 包提供的功能,并与 Laravel 的路由系统无缝集成。

您可以Uri使用静态方法轻松创建实例:

1use App\Http\Controllers\UserController;
2use App\Http\Controllers\InvokableController;
3use Illuminate\Support\Uri;
4 
5// Generate a URI instance from the given string...
6$uri = Uri::of('https://example.com/path');
7 
8// Generate URI instances to paths, named routes, or controller actions...
9$uri = Uri::to('/dashboard');
10$uri = Uri::route('users.show', ['user' => 1]);
11$uri = Uri::signedRoute('users.show', ['user' => 1]);
12$uri = Uri::temporarySignedRoute('user.index', now()->addMinutes(5));
13$uri = Uri::action([UserController::class, 'index']);
14$uri = Uri::action(InvokableController::class);
15 
16// Generate a URI instance from the current request URL...
17$uri = $request->uri();

一旦有了 URI 实例,就可以流畅地修改它:

1$uri = Uri::of('https://example.com')
2 ->withScheme('http')
3 ->withHost('test.com')
4 ->withPort(8000)
5 ->withPath('/users')
6 ->withQuery(['page' => 2])
7 ->withFragment('section-1');

检查 URI

该类Uri还允许您轻松检查底层 URI 的各个组件:

1$scheme = $uri->scheme();
2$host = $uri->host();
3$port = $uri->port();
4$path = $uri->path();
5$segments = $uri->pathSegments();
6$query = $uri->query();
7$fragment = $uri->fragment();

操作查询字符串

该类Uri提供了几种可用于操作 URI 查询字符串的方法。这些withQuery方法可用于将附加查询字符串参数合并到现有查询字符串中:

1$uri = $uri->withQuery(['sort' => 'name']);

withQueryIfMissing如果给定的键在查询字符串中尚不存在,则可以使用该方法将附加查询字符串参数合并到现有查询字符串中:

1$uri = $uri->withQueryIfMissing(['page' => 1]);

replaceQuery方法可用于用新的查询字符串完全替换现有的查询字符串:

1$uri = $uri->replaceQuery(['page' => 1]);

pushOntoQuery方法可用于将附加参数推送到具有数组值的查询字符串参数上:

1$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);

withoutQuery方法可用于从查询字符串中删除参数:

1$uri = $uri->withoutQuery(['page']);

从 URI 生成响应

redirect方法可用于生成RedirectResponse给定 URI 的实例:

1$uri = Uri::of('https://example.com');
2 
3return $uri->redirect();

或者,您可以简单地Uri从路由或控制器操作返回实例,这将自动生成对返回的 URI 的重定向响应:

1use Illuminate\Support\Facades\Route;
2use Illuminate\Support\Uri;
3 
4Route::get('/redirect', function () {
5 return Uri::to('/index')
6 ->withQuery(['sort' => 'name']);
7});