辅助函数

未匹配的标注
本文档最新版为 10.x,旧版本可能放弃维护,推荐阅读最新版!

辅助函数

简介

Laravel 包含了多种全局的PHP 助手函数。这些函数许多被框架本身使用;然而,如果你觉得它们方便,你也可以在你自己的应用程序中自由使用它们。

可用方法

数组 & 对象

数字

路径

URLs

杂项

数组 & 对象

Arr::accessible()

Arr::accessible 方法判断给定值是否可作为数组访问:

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;

$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);

// true

$isAccessible = Arr::accessible(new Collection);

// true

$isAccessible = Arr::accessible('abc');

// false

$isAccessible = Arr::accessible(new stdClass);

// false

Arr::add()

如果给定的键名在数组中不存在键值或该键值设置为 null ,那么 Arr::add 方法将会把给定的键值对添加到数组中:

use Illuminate\Support\Arr;

$array = Arr::add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

Arr::collapse()

Arr::collapse 方法将多个数组合并为一个数组:

use Illuminate\Support\Arr;

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

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

Arr::crossJoin()

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

use Illuminate\Support\Arr;

$matrix = Arr::crossJoin([1, 2], ['a', 'b']);

/*
    [
        [1, 'a'],
        [1, 'b'],
        [2, 'a'],
        [2, 'b'],
    ]
*/

$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);

/*
    [
        [1, 'a', 'I'],
        [1, 'a', 'II'],
        [1, 'b', 'I'],
        [1, 'b', 'II'],
        [2, 'a', 'I'],
        [2, 'a', 'II'],
        [2, 'b', 'I'],
        [2, 'b', 'II'],
    ]
*/

Arr::divide()

Arr::divide 方法返回一个二维数组,一个值包含原数组的键,另一个值包含原数组的值:

use Illuminate\Support\Arr;

[$keys, $values] = Arr::divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

Arr::dot()

Arr::dot 方法将多维数组中所有的键平铺到一维数组中,新数组使用「.」符号表示层级包含关系:

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$flattened = Arr::dot($array);

// ['products.desk.price' => 100]

Arr::except()

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

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$filtered = Arr::except($array, ['price']);

// ['name' => 'Desk']

Arr::exists()

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

use Illuminate\Support\Arr;

$array = ['name' => 'John Doe', 'age' => 17];

$exists = Arr::exists($array, 'name');

// true

$exists = Arr::exists($array, 'salary');

// false

Arr::first()

Arr::first 方法返回数组中满足指定条件的第一个元素:

use Illuminate\Support\Arr;

$array = [100, 200, 300];

$first = Arr::first($array, function (int $value, int $key) {
    return $value >= 150;
});

// 200

可将默认值作为第三个参数传递给该方法,如果数组中没有值满足指定条件,则返回该默认值:

use Illuminate\Support\Arr;

$first = Arr::first($array, $callback, $default);

Arr::flatten()

Arr::flatten 方法将多维数组中数组的值取出平铺为一维数组:

use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];

$flattened = Arr::flatten($array);

// ['Joe', 'PHP', 'Ruby']

Arr::forget()

Arr::forget 方法使用「.」符号从深度嵌套的数组中删除给定的键值对:

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::forget($array, 'products.desk');

// ['products' => []]

Arr::get()

Arr::get 方法使用「.」符号从深度嵌套的数组中根据指定键检索值:

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$price = Arr::get($array, 'products.desk.price');

// 100

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

use Illuminate\Support\Arr;

$discount = Arr::get($array, 'products.desk.discount', 0);

// 0

Arr::has()

Arr::has 方法使用「.」符号判断数组中是否存在指定的一个或多个键:

use Illuminate\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::has($array, 'product.name');

// true

$contains = Arr::has($array, ['product.price', 'product.discount']);

// false

Arr::hasAny()

Arr::hasAny 方法使用「.」符号判断给定集合中的任一值是否存在于数组中:

use Illuminate\Support\Arr;

$array = ['product' => ['name' => 'Desk', 'price' => 100]];

$contains = Arr::hasAny($array, 'product.name');

// true

$contains = Arr::hasAny($array, ['product.name', 'product.discount']);

// true

$contains = Arr::hasAny($array, ['category', 'product.discount']);

// false

Arr::isAssoc()

如果给定数组是关联数组,则 Arr::isAssoc 方法返回 true,如果该数组没有以零开头的顺序数字键,则将其视为「关联」数组:

use Illuminate\Support\Arr;

$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);

// true

$isAssoc = Arr::isAssoc([1, 2, 3]);

// false

Arr::isList()

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

use Illuminate\Support\Arr;

$isList = Arr::isList(['foo', 'bar', 'baz']);

// true

$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);

// false

Arr::join()

Arr::join() 方法将给定数组的所有值通过给定字符串连接起来。使用此方法的第二个参数,你还可以为数组中的最后一个元素指定连接的字符串:

use Illuminate\Support\Arr;

$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];

$joined = Arr::join($array, ', ');

// Tailwind, Alpine, Laravel, Livewire

$joined = Arr::join($array, ', ', ' and ');

// Tailwind, Alpine, Laravel and Livewire

Arr::keyBy()

Arr::keyBy() 方法通过给定键名的值对该数组进行重组。如果数组中存在多个相同的值,则只有最后一个值会出现在新数组中:

use Illuminate\Support\Arr;

$array = [
    ['product_id' => 'prod-100', 'name' => 'Desk'],
    ['product_id' => 'prod-200', 'name' => 'Chair'],
];

$keyed = Arr::keyBy($array, 'product_id');

/*
    [
        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
    ]
*/

Arr::last()

Arr::last 方法返回数组中满足指定条件的最后一个元素:

use Illuminate\Support\Arr;

$array = [100, 200, 300, 110];

$last = Arr::last($array, function (int $value, int $key) {
    return $value >= 150;
});

// 300

将默认值作为第三个参数传递给该方法,如果没有值满足条件,则返回该默认值:

use Illuminate\Support\Arr;

$last = Arr::last($array, $callback, $default);

Arr::map()

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

use Illuminate\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

Arr::mapSpread()

Arr::mapSpread 方法遍历数组,将每个嵌套项值传递到给定的闭包。闭包可以自由修改项并返回它,从而形成一个新的修改后的项数组:

use Illuminate\Support\Arr;

$array = [
    [0, 1],
    [2, 3],
    [4, 5],
    [6, 7],
    [8, 9],
];

$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
    return $even + $odd;
});

/*
    [1, 5, 9, 13, 17]
*/

Arr::mapWithKeys()

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

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => 'john@example.com',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => 'jane@example.com',
    ]
];

$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});

/*
    [
        'john@example.com' => 'John',
        'jane@example.com' => 'Jane',
    ]
*/

Arr::only()

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

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];

$slice = Arr::only($array, ['name', 'price']);

// ['name' => 'Desk', 'price' => 100]

Arr::pluck()

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

use Illuminate\Support\Arr;

$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];

$names = Arr::pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

你也可以指定结果的键:

use Illuminate\Support\Arr;

$names = Arr::pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail']

Arr::prepend()

Arr::prepend 方法会将一个元素推到数组的开头:

use Illuminate\Support\Arr;

$array = ['one', 'two', 'three', 'four'];

$array = Arr::prepend($array, 'zero');

// ['zero', 'one', 'two', 'three', 'four']

你也可以指定插入值的键:

use Illuminate\Support\Arr;

$array = ['price' => 100];

$array = Arr::prepend($array, 'Desk', 'name');

// ['name' => 'Desk', 'price' => 100]

Arr::prependKeysWith()

Arr::prependKeysWith 方法用给定前缀预置关联数组的所有键名:

use Illuminate\Support\Arr;

$array = [
    'name' => 'Desk',
    'price' => 100,
];

$keyed = Arr::prependKeysWith($array, 'product.');

/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

Arr::pull()

Arr::pull 方法返回并移除数组中的一个键值对:

use Illuminate\Support\Arr;

$array = ['name' => 'Desk', 'price' => 100];

$name = Arr::pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

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

use Illuminate\Support\Arr;

$value = Arr::pull($array, $key, $default);

Arr::query()

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

use Illuminate\Support\Arr;

$array = [
    'name' => 'Taylor',
    'order' => [
        'column' => 'created_at',
        'direction' => 'desc'
    ]
];

Arr::query($array);

// name=Taylor&order[column]=created_at&order[direction]=desc

Arr::random()

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

use Illuminate\Support\Arr;

$array = [1, 2, 3, 4, 5];

$random = Arr::random($array);

// 4 - (随机获取)

你也可以指定作为可选第二个参数返回的项数。注意,即使只需要一个项,提供这个参数也将返回一个数组:

use Illuminate\Support\Arr;

$items = Arr::random($array, 2);

// [2, 5] - (随机获取)

Arr::set()

Arr::set 方法使用「.」符号在多维数组中设置指定键的值:

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

Arr::set($array, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

Arr::shuffle()

Arr::shuffle 方法将数组中值进行随机排序:

use Illuminate\Support\Arr;

$array = Arr::shuffle([1, 2, 3, 4, 5]);

// [3, 2, 5, 1, 4] - (generated randomly)

Arr::sort()

Arr::sort 方法根据给定数组的值进行升序排序:

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

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

// ['Chair', 'Desk', 'Table']

你还可以根据给定回调方法的返回结果对数组进行排序:

use Illuminate\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sort($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

Arr::sortDesc()

Arr::sortDesc 方法根据给定数组的值进行降序排序:

use Illuminate\Support\Arr;

$array = ['Desk', 'Table', 'Chair'];

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

// ['Table', 'Desk', 'Chair']

你还可以根据给定回调方法的返回结果对数组进行排序:

use Illuminate\Support\Arr;

$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];

$sorted = array_values(Arr::sortDesc($array, function (array $value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Table'],
        ['name' => 'Desk'],
        ['name' => 'Chair'],
    ]
*/

Arr::sortRecursive()

Arr::sortRecursive 方法对给定数组进行递归排序,使用 sort 方法对数字索引子数组进行按值升序排序,使用 ksort 方法对关联子数组进行按键升序排序:

use Illuminate\Support\Arr;

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

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

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

如果你希望结果降序排序,你可以使用 Arr::sortRecursiveDesc 方法。

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

Arr::take()

Arr::take 方法返回一个新数组,其中包含指定数量的项:

use Illuminate\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]

你也可以传递一个负整数,以从数组的末尾取出指定数量的项:

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, -2);

// [4, 5]

Arr::toCssClasses()

Arr::toCssClasses 方法有条件地编译 CSS 类字符串。该方法接受一个键值数组,其中数组键包含你希望添加的类,而值是一个布尔表达式。如果数组元素有数字键,它将始终包括在渲染的类列表中:

use Illuminate\Support\Arr;

$isActive = false;
$hasError = true;

$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];

$classes = Arr::toCssClasses($array);

/*
    'p-4 bg-red'
*/

Arr::toCssStyles()

Arr::toCssStyles 方法有条件地编译 CSS 样式字符串。该方法接受一个键值数组,其中数组键包含你希望添加的类,而值是一个布尔表达式。如果数组元素有数字键,它将始终包括在渲染的类列表中:

use Illuminate\Support\Arr;

$hasColor = true;

$array = ['background-color: blue', 'color: blue' => $hasColor];

$classes = Arr::toCssStyles($array);

/*
    'background-color: blue; color: blue;'
*/

这个方法实现了 Laravel 的功能,允许与 Blade 组件的属性包合并类以及 @class Blade 指令

Arr::undot()

Arr::undot 方法使用「.」符号将一维数组扩展为多维数组:

use Illuminate\Support\Arr;

$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];

$array = Arr::undot($array);

// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

Arr::where()

Arr::where 方法使用给定的回调函数返回的结果过滤数组:

use Illuminate\Support\Arr;

$array = [100, '200', 300, '400', 500];

$filtered = Arr::where($array, function (string|int $value, int $key) {
    return is_string($value);
});

// [1 => '200', 3 => '400']

Arr::whereNotNull()

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

use Illuminate\Support\Arr;

$array = [0, null];

$filtered = Arr::whereNotNull($array);

// [0 => 0]

Arr::wrap()

Arr::wrap 方法可以将给定值转换为一个数组,如果给定的值已经是一个数组,它将原样返回:

use Illuminate\Support\Arr;

$string = 'Laravel';

$array = Arr::wrap($string);

// ['Laravel']

如果给定值是 null ,将返回一个空数组:

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

data_fill()

data_fill 函数使用「.」符号给多维数组或对象设置缺少的值:

$data = ['products' => ['desk' => ['price' => 100]]];

data_fill($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 100]]]

data_fill($data, 'products.desk.discount', 10);

// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

也可以接收 「*」 作为通配符,设置相应缺少的值:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2'],
    ],
];

data_fill($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 100],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

data_get()

data_get 函数使用 「.」 符号从多维数组或对象中根据指定键检索值

$data = ['products' => ['desk' => ['price' => 100]]];

$price = data_get($data, 'products.desk.price');

// 100

data_get 函数也接受一个默认值,如果没有找到指定的键,将返回默认值:

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

// 0

该函数还接受「*」作为通配符,来指向数组或对象的任何键:

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];

data_get($data, '*.name');

// ['Desk 1', 'Desk 2'];

可以使用 {first} 和 {last} 占位符获取数组的第一个或最后一个项:

$flight = [
    'segments' => [
        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
    ],
];

data_get($flight, 'segments.{first}.arrival');

// 15:00

data_set()

data_set 函数使用「.」符号从多维数组或对象中根据指定键设置值:

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200);

// ['products' => ['desk' => ['price' => 200]]]

此函数也接受使用「*」作为通配符,并相应地在目标上设置值:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_set($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 200],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

默认情况下,任何现有值都将被覆盖。如果你希望仅在值不存在时设置它,可以将 false 作为函数的第四个参数传递:

$data = ['products' => ['desk' => ['price' => 100]]];

data_set($data, 'products.desk.price', 200, overwrite: false);

// ['products' => ['desk' => ['price' => 100]]]

data_forget()

data_forget 函数使用「.」符号从嵌套数组或对象中移除值:

$data = ['products' => ['desk' => ['price' => 100]]];

data_forget($data, 'products.desk.price');

// ['products' => ['desk' => []]]

此函数也接受使用「*」 作为通配符,并相应地在目标上移除值:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

data_forget($data, 'products.*.price');

/*
    [
        'products' => [
            ['name' => 'Desk 1'],
            ['name' => 'Desk 2'],
        ],
    ]
*/

head()

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

$array = [100, 200, 300];

$first = head($array);

// 100

last()

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

$array = [100, 200, 300];

$last = last($array);

// 300

数字

Number::abbreviate()

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

use Illuminate\Support\Number;

$number = Number::abbreviate(1000);

// 1K

$number = Number::abbreviate(489939);

// 490K

$number = Number::abbreviate(1230000, precision: 2);

// 1.23M

Number::clamp()

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

use Illuminate\Support\Number;

$number = Number::clamp(105, min: 10, max: 100);

// 100

$number = Number::clamp(5, min: 10, max: 100);

// 10

$number = Number::clamp(10, min: 10, max: 100);

// 10

$number = Number::clamp(20, min: 10, max: 100);

// 20

Number::currency()

Number::currency 方法将给定值作为字符串返回货币表示:

use Illuminate\Support\Number;

$currency = Number::currency(1000);

// $1,000

$currency = Number::currency(1000, in: 'EUR');

// €1,000

$currency = Number::currency(1000, in: 'EUR', locale: 'de');

// 1.000 €

Number::fileSize()

Number::fileSize 方法将给定字节值作为字符串返回文件大小表示:

use Illuminate\Support\Number;

$size = Number::fileSize(1024);

// 1 KB

$size = Number::fileSize(1024 * 1024);

// 1 MB

$size = Number::fileSize(1024, precision: 2);

// 1.00 KB

Number::forHumans()

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

use Illuminate\Support\Number;

$number = Number::forHumans(1000);

// 1 thousand

$number = Number::forHumans(489939);

// 490 thousand

$number = Number::forHumans(1230000, precision: 2);

// 1.23 million

Number::format()

Number::format 方法将给定数字格式化为特定区域的字符串:

use Illuminate\Support\Number;

$number = Number::format(100000);

// 100,000

$number = Number::format(100000, precision: 2);

// 100,000.00

$number = Number::format(100000.123, maxPrecision: 2);

// 100,000.12

$number = Number::format(100000, locale: 'de');

// 100.000

Number::ordinal()

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

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

Number::percentage()

Number::percentage 方法将给定值作为字符串返回百分比表示:

use Illuminate\Support\Number;

$percentage = Number::percentage(10);

// 10%

$percentage = Number::percentage(10, precision: 2);

// 10.00%

$percentage = Number::percentage(10.123, maxPrecision: 2);

// 10.12%

$percentage = Number::percentage(10, precision: 2, locale: 'de');

// 10,00%

Number::spell()

Number::spell 方法将给定数字转换为字词字符串:

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

$number = Number::spell(88, locale: 'fr');

// quatre-vingt-huit

after 参数允许你指定在哪个值之后所有数字都应该拼写出来:

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

// 10

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

// eleven

until 参数允许你指定在哪个值之前所有数字都应该拼写出来:

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

// five

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

// 10

Number::useLocale()

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

use Illuminate\Support\Number;

/**
 * 启动任何应用服务
 */
public function boot(): void
{
    Number::useLocale('de');
}

Number::withLocale()

Number::withLocale 方法在指定区域设置中执行给定闭包,然后在回调执行后恢复原始区域设置:

use Illuminate\Support\Number;

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

路径

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 命令发布它们。

mix()

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

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

public_path()

public_path 函数返回应用程序的 public 目录的完全限定路径。你还可以使用 public_path 函数生成公共目录中给定文件的完全限定路径:

$path = public_path();

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

resource_path()

resource_path 函数返回应用程序的 resources 目录的完全限定路径。你还可以使用 resource_path 函数生成资源目录中给定文件的完全限定路径:

$path = resource_path();

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

storage_path()

storage_path 函数返回应用程序的 storage 目录的完全限定路径。你还可以使用 storage_path 函数生成存储目录中给定文件的完全限定路径:

$path = storage_path();

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

URLs

action()

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

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

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

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

asset()

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

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

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

// ASSET_URL=http://example.com/assets

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

route()

route 函数为给定的 命名路由生成 URL:

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

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

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

默认情况下,route 函数生成一个绝对 URL。如果你希望生成一个相对 URL,你可以将 false 作为函数的第三个参数传递:

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

secure_asset()

secure_asset 函数使用 HTTPS 生成资源的 URL:

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

secure_url()

secure_url 函数生成到给定路径的完全限定 HTTPS URL。额外的 URL 段可以作为函数的第二个参数传递:

$url = secure_url('user/profile');

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

to_route()

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

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

如果需要,你可以将应该分配给重定向的 HTTP 状态码和任何其他响应头作为 to_route 方法的第三和第四个参数传递:

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

url()

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

$url = url('user/profile');

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

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

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

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

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

杂项

abort()

abort 函数抛出 HTTP 异常,该异常将由 异常处理器渲染:

abort(403);

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

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

abort_if()

如果给定的布尔表达式评估为 true 则 abort_if 函数抛出 HTTP 异常:

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

和 abort 方法类似,你也可以将异常的响应文本作为第三个参数提供,并将自定义响应头的数组作为第四个参数传递给函数。

abort_unless()

如果给定的布尔表达式评估为 false 则 abort_unless 函数抛出 HTTP 异常:

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

和 abort 方法类似,你也可以将异常的响应文本作为第三个参数提供,并将自定义响应头的数组作为第四个参数传递给函数。

app()

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

$container = app();

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

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

auth()

auth 函数返回一个 认证器 实例。你可以使用它来替代 Auth facade:

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

如果需要,你可以指定你想要访问的哪一个守卫实例:

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

back()

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

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

return back();

bcrypt()

bcrypt 函数使用 Bcrypt 哈希 给定的值。你可以使用这个函数替代 Hash facade :

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

blank()

blank 函数确定给定值是否为「空白」:

blank('');
blank('   ');
blank(null);
blank(collect());

// true

blank(0);
blank(true);
blank(false);

// false

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

broadcast()

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

broadcast(new UserRegistered($user));

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

cache()

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

$value = cache('key');

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

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

cache(['key' => 'value'], 300);

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

class_uses_recursive()

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

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

collect()

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

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

config()

config 函数获取 配置 变量的值。 可以使用「.」语法访问配置值,其中包括文件名和你希望访问的选项。 如果配置选项不存在,可以指定默认值并返回:

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

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

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

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

context()

context 函数从 当前上下文 中获取值。默认值可以指定,并且如果上下文键不存在则返回它

$value = context('trace_id');

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

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

use Illuminate\Support\Str;

context(['trace_id' => Str::uuid()->toString()]);

cookie()

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

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

csrf_field()

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

{{ csrf_field() }}

csrf_token()

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

$token = csrf_token();

decrypt()

decrypt 函数 解密 给定值。你可以使用这个函数替代 Crypt facade:

$password = decrypt($value);

dd()

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

dd($value);

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

如果你不想在转储变量后中止脚本的执行,请使用 dump 函数。

dispatch()

dispatch 函数将给定的 任务 推送到 Laravel 任务队列

dispatch(new App\Jobs\SendEmails);

dispatch_sync()

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

dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函数转储给定变量:

dump($value);

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

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

encrypt()

encrypt 函数 加密 给定值。你可以使用这个函数替代 Crypt facade :

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

env()

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

$env = env('APP_ENV');

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

注意
如果你在部署过程中执行了 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()

old 函数 检索 被闪存到 session 中的 旧输入值

$value = old('value');

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

由于 old 函数的第二个参数提供的「默认值」通常是 Eloquent 模型的属性,Laravel 允许你简单地将整个 Eloquent 模型作为 old 函数的第二个参数传递。这样做时,Laravel 将假定提供给 old 函数的第一个参数是 Eloquent 属性的名称,该属性应被视为「默认值」:

{{ old('name', $user->name) }}

// 等价于...

{{ old('name', $user) }}

once()

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

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}

random(); // 123
random(); // 123 (缓存的结果)
random(); // 123 (缓存的结果)

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

<?php

class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}

$service = new NumberService;

$service->all();
$service->all(); // (缓存的结果)

$secondService = new NumberService;

$secondService->all();
$secondService->all(); // (缓存的结果)

optional()

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

return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}

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

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

policy()

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

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

redirect()

redirect 函数返回 重定向 HTTP 响应,如果没有参数调用它,则返回重定向器实例:

return redirect($to = null, $status = 302, $headers = [], $https = null);

return redirect('/home');

return redirect()->route('route.name');

report()

report 函数将使用你的 异常处理程序 报告异常:

report($e);

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

report('Something went wrong.');

report_if()

如果给定条件为 truereport_if 函数将使用你的 异常处理程序 报告异常:

report_if($shouldReport, $e);

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

report_unless()

如果给定条件为 falsereport_unless 函数将使用你的 异常处理程序 报告异常:

report_unless($reportingDisabled, $e);

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

request()

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

$request = request();

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

rescue()

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

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

你可以向 rescue 函数传递第二个参数。此参数将是在执行闭包时发生异常应返回的「默认」值:

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

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

可以提供 report 参数给 rescue 函数来决定是否通过 report 函数报告异常:

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

resolve()

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

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

response()

response 函数创建一个 响应 实例或获取响应工厂的实例:

return response('Hello World', 200, $headers);

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

retry()

retry 函数尝试执行给定的回调,直到达到给定的最大尝试阈值。如果回调没有抛出异常,将返回它的返回值。如果回调抛出异常,它将自动被重试。如果超过最大尝试次数,将抛出异常:

return retry(5, function () {
    // 尝试 5 次,每次尝试之间休息 100ms...
}, 100);

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

use Exception;

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

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

return retry([100, 200], function () {
    //  第一次重试睡眠 100ms,第二次重试睡眠 200ms...
});

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

use Exception;

return retry(5, function () {
    // ...
}, 100, function (Exception $exception) {
    return $exception instanceof RetryException;
});

session()

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 方法接受闭包作为其唯一的参数。对象实例本身将被传递给闭包,然后通过 tap 方法返回:

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

throw_if()

如果给定的布尔表达式评估为 true,则 throw_if 函数抛出给定的异常:

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    '你不允许访问此页面。'
);

throw_unless()

如果给定的布尔表达式评估为 false,则 throw_unless 函数抛出给定的异常:

throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    '你不允许访问此页面。'
);

today()

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

$today = today();

trait_uses_recursive()

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

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

transform()

transform 函数在给定值不是 blank 的情况下对其执行闭包,然后返回闭包的返回值:

$callback = function (int $value) {
    return $value * 2;
};

$result = transform(5, $callback);

// 10

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

$result = transform(null, $callback, 'The value is blank');

// The value is blank

validator()

validator 函数使用给定的参数创建一个新的 validator 实例。你可以用它替代 Validator facade:

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

value()

value 函数返回它所接收到的值。但是,如果你传递一个闭包给该函数,闭包将被执行,并且其返回的值将被返回:

$result = value(true);

// true

$result = value(function () {
    return false;
});

// false

可以向 value 函数传递额外的参数。如果第一个参数是闭包,则额外的参数将作为参数传递给闭包,否则它们将被忽略:

$result = value(function (string $name) {
    return $name;
}, 'Taylor');

// 'Taylor'

view()

view 函数检索一个 视图 实例:

return view('auth.login');

with()

with 函数返回它被赋予的值。如果闭包作为该函数的第二个参数传递,则会执行闭包并返回其返回值:

$callback = function (mixed $value) {
    return is_numeric($value) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5

其他实用工具

基准测试

有时你可能希望快速测试应用程序的某些部分的性能。在这些场合,你可以使用 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();

有关 Carbon 及其功能的详尽讨论,请查阅 Carbon 官方文档

抽奖

Laravel 的 lottery 类可以根据一组给定的赔率执行回调。当你只想为你的传入请求的一部分执行代码时,这特别有用:

use Illuminate\Support\Lottery;

Lottery::odds(1, 20)
    ->winner(fn () => $user->won())
    ->loser(fn () => $user->lost())
    ->choose();

你可以将 Laravel 的抽奖类与其他 Laravel 功能结合使用。例如,你可能希望只向你的异常处理程序报告慢查询的一小部分。由于抽奖类是可调用的,我们可以将该类的实例传递给任何接受可调用对象的方法:

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.')),
);

测试抽奖

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

// 抽奖将总是赢...
Lottery::alwaysWin();

// 抽奖将总是输...
Lottery::alwaysLose();

// 抽奖将先赢然后输,最后恢复正常行为...
Lottery::fix([true, false]);

// 抽奖将恢复正常行为...
Lottery::determineResultsNormally();

管道

Laravel 的 Pipeline facade 提供了一种便捷的方式来通过一系列可调用类、闭包或可调用对象「管道化」给定输入,让每个类都有机会检查或修改输入并调用管道中的下一个可调用对象:

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 方法提供的可调用对象将被调用。通常,这个可调用对象只是简单地返回给定输入。

当然,正如之前讨论的,你不仅限于为你的管道提供闭包。你还可以提供可调用的类。如果提供了一个类名,该类将通过 Laravel 的服务容器实例化,允许将依赖项注入到可调用类中:

$user = Pipeline::send($user)
            ->through([
                GenerateProfilePhoto::class,
                ActivateSubscription::class,
                SendWelcomeEmail::class,
            ])
            ->then(fn (User $user) => $user);

睡眠

Laravel 的 Sleep 类是围绕 PHP 原生 sleep 和 usleep 函数的轻量级封装,提供更高的可测试性,同时也为处理时间提供了一个对开发者友好的 API:

use Illuminate\Support\Sleep;

$waiting = true;

while ($waiting) {
    Sleep::for(1)->second();

    $waiting = /* ... */;
}

Sleep 类提供了各种方法,允许你使用不同的时间单位:

// 暂停执行 90 秒...
Sleep::for(1.5)->minutes();

// 暂停执行 2 秒...
Sleep::for(2)->seconds();

// 暂停执行 500 毫秒...
Sleep::for(500)->milliseconds();

// 暂停执行 5,000 微秒...
Sleep::for(5000)->microseconds();

// 暂停执行到给定的时间...
Sleep::until(now()->addMinute());

// PHP 原生「sleep」函数的别名...
Sleep::sleep(2);

// PHP 原生「usleep」函数的别名...
Sleep::usleep(5000);

为了方便组合时间单位,你可以使用 and 方法:

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

测试睡眠

当在测试中利用 Sleep 类或 PHP 原生的 sleep 函数时,你的测试将暂停执行。可以想象,这会使你的测试套件显著变慢。例如,假设你正在测试以下代码:

$waiting = /* ... */;

$seconds = 1;

while ($waiting) {
    Sleep::for($seconds++)->seconds();

    $waiting = /* ... */;
}

通常,测试这段代码至少会花费一秒钟。幸运的是,Sleep 类允许我们「伪造」睡眠,使我们的测试套件保持快速:

//Pest示例
it('waits until ready', function () {
    Sleep::fake();

    // ...
});
//PHPUnit示例
public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

当伪造了 Sleep 类时,实际的执行暂停被绕过,导致测试显著加快。

一旦 Sleep 类被伪造,就可以对在应用程序代码中应该发生的预期「睡眠」进行断言。为了说明这一点,让我们假设我们正在测试的代码会三次暂停执行,每次暂停的时间都会增加一秒。使用 assertSequence 方法,我们可以断言在保持测试速度的同时代码「睡眠」了适当时间:

//Pest示例
it('checks if ready three times', function () {
    Sleep::fake();

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}
//PHPUnit示例
public function test_it_checks_if_ready_four_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 秒前

Laravel 在其内部使用 Sleep 类,每当要暂停执行时。例如,retry 帮助器使用 Sleep 类进行睡眠,从而提高在使用该帮助器时的可测试性。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/laravel/11.x/he...

译文地址:https://learnku.com/docs/laravel/11.x/he...

上一篇 下一篇
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
贡献者:1
讨论数量: 0
发起讨论 只看当前版本


暂无话题~