辅助函数

介绍
可用方法
其他实用工具

介绍

Laravel 包含多种全局 "辅助" PHP 函数。许多这些函数被框架本身使用；然而，如果您觉得方便，也可以在自己的应用程序中使用它们。

可用方法

数组 & 对象

杂项

数组 & 对象

`Arr::accessible()`

Arr::accessible 方法用于确定给定的值是否是数组可访问的：

php

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()`

Arr::add 方法在给定的键不存在于数组中或设置为 null 时，向数组添加给定的键/值对：

php

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 方法将数组的数组折叠成一个单一数组：

php

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 方法交叉连接给定的数组，返回所有可能排列的笛卡尔积：

php

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 方法返回两个数组：一个包含给定数组的键，另一个包含值：

php

use Illuminate\Support\Arr;

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

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

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

php

use Illuminate\Support\Arr;

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

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

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

`Arr::except()`

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

php

use Illuminate\Support\Arr;

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

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

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

`Arr::exists()`

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

php

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 方法返回通过给定真值测试的数组的第一个元素：

php

use Illuminate\Support\Arr;

$array = [100, 200, 300];

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

// 200

该方法的第三个参数还可以传递一个默认值。如果没有值通过真值测试，将返回此值：

php

use Illuminate\Support\Arr;

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

`Arr::flatten()`

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

php

use Illuminate\Support\Arr;

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

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

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

`Arr::forget()`

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

php

use Illuminate\Support\Arr;

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

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

// ['products' => []]

`Arr::get()`

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

php

use Illuminate\Support\Arr;

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

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

// 100

Arr::get 方法还接受一个默认值，如果数组中不存在指定的键，将返回此值：

php

use Illuminate\Support\Arr;

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

// 0

`Arr::has()`

Arr::has 方法使用 "点" 符号检查数组中是否存在给定的项或项集：

php

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 方法使用 "点" 符号检查数组中是否存在给定集合中的任何项：

php

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 如果给定的数组是关联数组。如果数组没有从零开始的连续数字键，则被认为是 "关联" 的：

php

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 如果给定数组的键是从零开始的连续整数：

php

use Illuminate\Support\Arr;

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

// true

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

// false

`Arr::join()`

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

php

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 方法根据给定的键对数组进行键控。如果多个项具有相同的键，则只有最后一个会出现在新数组中：

php

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 方法返回通过给定真值测试的数组的最后一个元素：

php

use Illuminate\Support\Arr;

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

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

// 300

该方法的第三个参数还可以传递一个默认值。如果没有值通过真值测试，将返回此值：

php

use Illuminate\Support\Arr;

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

`Arr::map()`

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

php

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 方法遍历数组，将每个嵌套项的值传递给给定的闭包。闭包可以自由修改项并返回它，从而形成一个新的修改项数组：

php

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 方法遍历数组并将每个值传递给给定的回调。回调应返回一个包含单个键/值对的关联数组：

php

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 方法仅返回给定数组中指定的键/值对：

php

use Illuminate\Support\Arr;

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

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

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

`Arr::partition()`

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

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 方法从数组中检索给定键的所有值：

php

use Illuminate\Support\Arr;

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

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

// ['Taylor', 'Abigail']

您还可以指定希望结果列表如何键控：

php

use Illuminate\Support\Arr;

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

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

`Arr::prepend()`

Arr::prepend 方法将在数组的开头推入一个项：

php

use Illuminate\Support\Arr;

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

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

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

如果需要，您可以指定用于该值的键：

php

use Illuminate\Support\Arr;

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

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

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

`Arr::prependKeysWith()`

Arr::prependKeysWith 方法为关联数组的所有键名添加给定的前缀：

php

use Illuminate\Support\Arr;

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

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

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

`Arr::pull()`

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

php

use Illuminate\Support\Arr;

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

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

// $name: Desk

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

该方法的第三个参数还可以传递一个默认值。如果键不存在，将返回此值：

php

use Illuminate\Support\Arr;

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

`Arr::query()`

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

php

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 方法从数组中返回一个随机值：

php

use Illuminate\Support\Arr;

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

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

// 4 - (随机检索)

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

php

use Illuminate\Support\Arr;

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

// [2, 5] - (随机检索)

`Arr::reject()`

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

php

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 方法从数组中选择一组值：

php

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 方法使用 "点" 符号在深度嵌套的数组中设置值：

php

use Illuminate\Support\Arr;

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

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

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

`Arr::shuffle()`

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

php

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 异常：

php

use Illuminate\Support\Arr;

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

$value = Arr::sole($array, fn (string $value) => $value === 'Desk');

// 'Desk'

`Arr::sort()`

Arr::sort 方法按值对数组进行排序：

php

use Illuminate\Support\Arr;

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

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

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

您还可以通过给定的闭包结果对数组进行排序：

php

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 方法按值对数组进行降序排序：

php

use Illuminate\Support\Arr;

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

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

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

您还可以通过给定的闭包结果对数组进行排序：

php

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 函数对关联子数组进行排序：

php

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 方法。

php

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

`Arr::take()`

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

php

use Illuminate\Support\Arr;

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

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

// [0, 1, 2]

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

php

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

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

// [4, 5]

`Arr::toCssClasses()`

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

php

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 样式字符串。该方法接受一个类数组，其中数组键包含您希望添加的类或类，而值是一个布尔表达式。如果数组元素有一个数字键，它将始终包含在渲染的类列表中：

php

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 方法将使用 "点" 符号的单维数组扩展为多维数组：

php

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 方法使用给定的闭包过滤数组：

php

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 值：

php

use Illuminate\Support\Arr;

$array = [0, null];

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

// [0 => 0]

`Arr::wrap()`

Arr::wrap 方法将给定的值包装在一个数组中。如果给定的值已经是一个数组，它将不作修改地返回：

php

use Illuminate\Support\Arr;

$string = 'Laravel';

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

// ['Laravel']

如果给定的值是 null，将返回一个空数组：

php

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

data_fill 函数使用 "点" 符号在嵌套数组或对象中设置缺失的值：

php

$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]]]

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

php

$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 函数使用 "点" 符号从嵌套数组或对象中检索值：

php

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

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

// 100

data_get 函数还接受一个默认值，如果未找到指定的键，将返回此值：

php

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

// 0

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

php

$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} 占位符可用于检索数组中的第一个或最后一个项：

php

$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 函数使用 "点" 符号在嵌套数组或对象中设置值：

php

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

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

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

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

php

$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 作为函数的第四个参数传递：

php

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

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

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

`data_forget()`

data_forget 函数使用 "点" 符号从嵌套数组或对象中移除值：

php

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

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

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

此函数还接受使用星号的通配符，并将相应地在目标上移除值：

php

$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 函数返回给定数组中的第一个元素：

php

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

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

php

$array = [100, 200, 300];

$last = last($array);

// 300

数字

`Number::abbreviate()`

Number::abbreviate 方法返回提供的数值的可读格式，并带有单位的缩写：

php

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 方法确保给定的数字保持在指定范围内。如果数字低于最小值，则返回最小值。如果数字高于最大值，则返回最大值：

php

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 方法返回给定值的货币表示形式作为字符串：

php

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 €

`Number::defaultCurrency()`

Number::defaultCurrency 方法返回 Number 类使用的默认货币：

php

use Illuminate\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

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

php

use Illuminate\Support\Number;

$locale = Number::defaultLocale();

// en

`Number::fileSize()`

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

php

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 方法返回提供的数值的可读格式：

php

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 方法将给定的数字格式化为特定语言环境的字符串：

php

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 方法返回数字的序数表示：

php

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::pairs()`

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

php

use Illuminate\Support\Number;

$result = Number::pairs(25, 10);

// [[1, 10], [11, 20], [21, 25]]

$result = Number::pairs(25, 10, offset: 0);

// [[0, 10], [10, 20], [20, 25]]

`Number::percentage()`

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

php

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 方法将给定的数字转换为单词字符串：

php

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

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

// quatre-vingt-huit

after 参数允许您指定一个值，在此值之后的所有数字都应拼写出来：

php

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

// 10

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

// eleven

until 参数允许您指定一个值，在此值之前的所有数字都应拼写出来：

php

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

// five

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

// 10

`Number::spellOrdinal()`

Number::spellOrdinal 方法将数字的序数形式以英文单词的字符串形式返回：

php

use Illuminate\Support\Number;

$number = Number::spellOrdinal(1);

// first

$number = Number::spellOrdinal(2);

// second

$number = Number::spellOrdinal(21);

// twenty-first

`Number::trim()`

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

php

use Illuminate\Support\Number;

$number = Number::trim(12.0);

// 12

$number = Number::trim(12.30);

// 12.3

`Number::useLocale()`

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

php

use Illuminate\Support\Number;

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

`Number::withLocale()`

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

php

use Illuminate\Support\Number;

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

`Number::useCurrency()`

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

php

use Illuminate\Support\Number;

/**
 * 启动任何应用程序服务。
 */
public function boot(): void
{
    Number::useCurrency('GBP');
}

`Number::withCurrency()`

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

php

use Illuminate\Support\Number;

$number = Number::withCurrency('GBP', function () {
    // ...
});

路径

`app_path()`

app_path 函数返回应用程序的 app 目录的完全限定路径。您还可以使用 app_path 函数生成相对于应用程序目录的文件的完全限定路径：

php

$path = app_path();

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

`base_path()`

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

php

$path = base_path();

$path = base_path('vendor/bin');

`config_path()`

config_path 函数返回应用程序的 config 目录的完全限定路径。您还可以使用 config_path 函数生成应用程序配置目录中给定文件的完全限定路径：

php

$path = config_path();

$path = config_path('app.php');

`database_path()`

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

php

$path = database_path();

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

`lang_path()`

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

php

$path = lang_path();

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

NOTE

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

`mix()`

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

php

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

`public_path()`

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

php

$path = public_path();

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

`resource_path()`

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

php

$path = resource_path();

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

`storage_path()`

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

php

$path = storage_path();

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

URL

`action()`

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

php

use App\Http\Controllers\HomeController;

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

如果方法接受路由参数，您可以将它们作为方法的第二个参数传递：

php

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

`asset()`

asset 函数使用请求的当前方案（HTTP 或 HTTPS）为资产生成 URL：

php

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

您可以通过在 .env 文件中设置 ASSET_URL 变量来配置资产 URL 主机。如果您在外部服务（如 Amazon S3 或其他 CDN）上托管资产，这可能会很有用：

php

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

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

`route()`

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

php

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

如果路由接受参数，您可以将它们作为函数的第二个参数传递：

php

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

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

php

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

`secure_asset()`

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

php

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

`secure_url()`

secure_url 函数生成给定路径的完整 HTTPS URL。可以在函数的第二个参数中传递其他 URL 段：

php

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

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

`to_route()`

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

php

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

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

php

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

`uri()`

uri 函数为给定的 URI 生成一个 fluent URI 实例：

php

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

如果 uri 函数接收到一个包含控制器和方法对的数组，它将为该控制器方法的路由路径创建一个 Uri 实例：

php

use App\Http\Controllers\UserController;

$uri = uri([UserController::class, 'show'], ['user' => $user])

如果控制器是可调用的（invokable），你可以仅传入控制器类名：

php

use App\Http\Controllers\UserIndexController;

$uri = uri(UserIndexController::class);

如果传入 uri 函数的值与某个命名路由的名称匹配，则将为该路由的路径生成一个 Uri 实例：

php

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

`url()`

url 函数生成给定路径的完整 URL：

php

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

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

如果未提供路径，则返回 Illuminate\Routing\UrlGenerator 实例：

php

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

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

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

杂项

`abort()`

abort 函数抛出 HTTP 异常，该异常将由异常处理程序渲染：

php

abort(403);

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

php

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

`abort_if()`

abort_if 函数在给定的布尔表达式计算为 true 时抛出 HTTP 异常：

php

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

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

`abort_unless()`

abort_unless 函数在给定的布尔表达式计算为 false 时抛出 HTTP 异常：

php

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

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

`app()`

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

php

$container = app();

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

php

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

`auth()`

auth 函数返回认证器实例。您可以将其用作 Auth facade 的替代方法：

php

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

如果需要，您可以指定要访问的守卫实例：

php

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

`back()`

back 函数生成到用户先前位置的重定向 HTTP 响应：

php

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

return back();

`bcrypt()`

bcrypt 函数使用 Bcrypt 哈希给定的值。您可以将此函数用作 Hash facade 的替代方法：

php

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

`blank()`

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

php

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

// true

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

// false

有关 blank 的反义词，请参见 filled 方法。

`broadcast()`

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

php

broadcast(new UserRegistered($user));

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

`cache()`

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

php

$value = cache('key');

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

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

php

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

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

`class_uses_recursive()`

class_uses_recursive 函数返回类使用的所有特性，包括其所有父类使用的特性：

php

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

`collect()`

collect 函数从给定值创建集合实例：

php

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

`config()`

config 函数获取配置变量的值。可以使用“点”语法访问配置值，其中包括您希望访问的文件名和选项。如果配置选项不存在，可以指定默认值并返回：

php

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

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

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

php

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

`context()`

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

php

$value = context('trace_id');

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

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

php

use Illuminate\Support\Str;

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

`cookie()`

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

php

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

`csrf_field()`

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

blade

{{ csrf_field() }}

`csrf_token()`

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

php

$token = csrf_token();

`decrypt()`

decrypt 函数解密给定的值。您可以将此函数用作 Crypt facade 的替代方法：

php

$password = decrypt($value);

`dd()`

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

php

dd($value);

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

如果您不想在转储变量后停止脚本的执行，请使用 dump 函数。

`dispatch()`

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

php

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

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

php

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

dump 函数转储给定的变量：

php

dump($value);

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

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

`encrypt()`

encrypt 函数加密给定的值。您可以将此函数用作 Crypt facade 的替代方法：

php

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

`env()`

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

php

$env = env('APP_ENV');

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

WARNING

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

`event()`

event 函数将给定的事件分派给其监听器：

php

event(new UserRegistered($user));

`fake()`

fake 函数从容器中解析一个 Faker 单例，这在创建模型工厂、数据库填充、测试和原型视图中的假数据时非常有用：

blade

@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 函数来指定区域设置。每个区域设置将解析一个单独的单例：

php

fake('nl_NL')->name()

`filled()`

filled 函数确定给定的值是否不是“空白”：

php

filled(0);
filled(true);
filled(false);

// true

filled('');
filled('   ');
filled(null);
filled(collect());

// false

有关 filled 的反义词，请参见 blank 方法。

`info()`

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

php

info('Some helpful information!');

还可以将上下文数据数组传递给函数：

php

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

`literal()`

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

php

$obj = literal(
    name: 'Joe',
    languages: ['PHP', 'Ruby'],
);

$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']

`logger()`

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

php

logger('Debug message');

还可以将上下文数据数组传递给函数：

php

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

如果未传递任何值给函数，将返回一个 logger 实例：

php

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

`method_field()`

method_field 函数生成一个包含表单 HTTP 动词伪造值的 HTML hidden 输入字段。例如，使用 Blade 语法：

blade

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

`now()`

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

php

$now = now();

`old()`

old 函数检索闪存到会话中的旧输入值：

php

$value = old('value');

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

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

blade

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

// 等同于...

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

`once()`

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

php

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

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

当 once 函数从对象实例中执行时，缓存的结果将对该对象实例唯一：

php

<?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 而不是导致错误：

php

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

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

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

php

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

`policy()`

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

php

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

`redirect()`

redirect 函数返回重定向 HTTP 响应，如果不带参数调用，则返回重定向器实例：

php

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

return redirect('/home');

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

`report()`

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

php

report($e);

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

php

report('Something went wrong.');

`report_if()`

report_if 函数将在给定条件为 true 时使用您的异常处理程序报告异常：

php

report_if($shouldReport, $e);

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

`report_unless()`

report_unless 函数将在给定条件为 false 时使用您的异常处理程序报告异常：

php

report_unless($reportingDisabled, $e);

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

`request()`

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

php

$request = request();

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

`rescue()`

rescue 函数执行给定的闭包并捕获其执行期间发生的任何异常。所有捕获的异常将发送到您的异常处理程序；然而，请求将继续处理：

php

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

您还可以将第二个参数传递给 rescue 函数。此参数将在执行闭包时发生异常时返回的“默认”值：

php

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

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

可以为 rescue 函数提供一个 report 参数，以确定是否应通过 report 函数报告异常：

php

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

`resolve()`

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

php

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

`response()`

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

php

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

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

`retry()`

retry 函数尝试执行给定的回调，直到达到给定的最大尝试阈值。如果回调未抛出异常，则返回其返回值。如果回调抛出异常，则会自动重试。如果超过最大尝试次数，则抛出异常：

php

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

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

php

use Exception;

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

为了方便起见，您可以将数组作为 retry 函数的第一个参数提供。此数组将用于确定后续尝试之间休眠的毫秒数：

php

return retry([100, 200], function () {
    // 第一次重试休眠 100 毫秒，第二次重试休眠 200 毫秒...
});

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

php

use Exception;

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

`session()`

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

php

$value = session('key');

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

php

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

如果未传递任何值给函数，将返回会话存储：

php

$value = session()->get('key');

session()->put('key', $value);

`tap()`

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

php

$user = tap(User::first(), function (User $user) {
    $user->name = 'taylor';

    $user->save();
});

如果未将闭包传递给 tap 函数，您可以在给定的 $value 上调用任何方法。您调用的方法的返回值将始终是 $value，无论方法在其定义中实际返回什么。例如，Eloquent update 方法通常返回一个整数。然而，我们可以通过在 tap 函数中链接 update 方法调用来强制方法返回模型本身：

php

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

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

php

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

`throw_if()`

throw_if 函数在给定的布尔表达式计算为 true 时抛出给定的异常：

php

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 时抛出给定的异常：

php

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 实例：

php

$today = today();

`trait_uses_recursive()`

trait_uses_recursive 函数返回特性使用的所有特性：

php

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

`transform()`

transform 函数在给定值不为空白时执行闭包，然后返回闭包的返回值：

php

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

$result = transform(5, $callback);

// 10

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

php

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

// The value is blank

`validator()`

validator 函数使用给定的参数创建一个新的验证器实例。您可以将其用作 Validator facade 的替代方法：

php

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

`value()`

value 函数返回给定的值。然而，如果您将闭包传递给函数，则会执行闭包并返回其返回值：

php

$result = value(true);

// true

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

// false

可以将其他参数传递给 value 函数。如果第一个参数是闭包，则其他参数将作为参数传递给闭包，否则将被忽略：

php

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

// 'Taylor'

`view()`

view 函数检索视图实例：

php

return view('auth.login');

`with()`

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

php

$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

`when()`

when 函数在给定条件计算为 true 时返回给定的值。否则，返回 null。如果将闭包作为函数的第二个参数传递，则会执行闭包并返回其返回值：

php

$value = when(true, 'Hello World');

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

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

blade

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

其他实用工具

基准测试

有时您可能希望快速测试应用程序某些部分的性能。在这些情况下，您可以利用 Benchmark 支持类来测量给定回调完成所需的毫秒数：

php

<?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 类将返回在所有迭代中执行回调所需的平均毫秒数：

php

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

有时，您可能希望在基准测试回调的执行时仍然获取回调返回的值。value 方法将返回一个包含回调返回的值和执行回调所需的毫秒数的元组：

php

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

日期

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

php

$now = now();

或者，您可以使用 Illuminate\Support\Carbon 类创建新的 Carbon 实例：

php

use Illuminate\Support\Carbon;

$now = Carbon::now();

有关 Carbon 及其功能的详细讨论，请查阅官方 Carbon 文档。

延迟函数

WARNING

延迟函数目前处于测试阶段，我们正在收集社区反馈。

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

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

php

use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;

Route::post('/orders', function (Request $request) {
    // 创建订单...

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

    return $order;
});

默认情况下，仅当从中调用 Illuminate\Support\defer 的 HTTP 响应、Artisan 命令或队列作业成功完成时，才会执行延迟函数。这意味着如果请求导致 4xx 或 5xx HTTP 响应，则不会执行延迟函数。如果您希望始终执行延迟函数，可以将 always 方法链接到您的延迟函数上：

php

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

取消延迟函数

如果您需要在执行之前取消延迟函数，可以使用 forget 方法通过其名称取消函数。要命名延迟函数，请将第二个参数提供给 Illuminate\Support\defer 函数：

php

defer(fn () => Metrics::report(), 'reportMetrics');

defer()->forget('reportMetrics');

延迟函数兼容性

如果您从 Laravel 10.x 应用程序升级到 Laravel 11.x，并且应用程序的骨架仍然包含 app/Http/Kernel.php 文件，您应该将 InvokeDeferredCallbacks 中间件添加到内核的 $middleware 属性的开头：

php

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class,  
    \App\Http\Middleware\TrustProxies::class,
    // ...
];

在测试中禁用延迟函数

在编写测试时，可能需要禁用延迟函数。您可以在测试中调用 withoutDefer 来指示 Laravel 立即调用所有延迟函数：

PestPHPUnit

php

test('without defer', function () {
    $this->withoutDefer();

    // ...
});

php

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_without_defer(): void
    {
        $this->withoutDefer();

        // ...
    }
}

如果您希望在测试用例中的所有测试中禁用延迟函数，可以从基 TestCase 类的 setUp 方法中调用 withoutDefer 方法：

php

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void 
    {
        parent::setUp();

        $this->withoutDefer();
    } 
}

彩票

Laravel 的彩票类可用于根据给定的几率执行回调。这在您只希望为一部分传入请求执行代码时特别有用：

php

use Illuminate\Support\Lottery;

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

您可以将 Laravel 的彩票类与其他 Laravel 功能结合使用。例如，您可能希望仅向异常处理程序报告一小部分慢查询。而且，由于彩票类是可调用的，我们可以将类的实例传递给任何接受可调用对象的方法：

php

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 提供了一些简单的方法，允许您轻松测试应用程序的彩票调用：

php

// 彩票将始终获胜...
Lottery::alwaysWin();

// 彩票将始终失败...
Lottery::alwaysLose();

// 彩票将获胜然后失败，最后恢复正常行为...
Lottery::fix([true, false]);

// 彩票将恢复正常行为...
Lottery::determineResultsNormally();

管道

Laravel 的 Pipeline facade 提供了一种方便的方法，可以通过一系列可调用类、闭包或可调用对象“传递”给定的输入，使每个类都有机会检查或修改输入并调用管道中的下一个可调用对象：

php

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 的服务容器实例化，允许将依赖项注入到可调用类中：

php

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

睡眠

Laravel 的 Sleep 类是 PHP 原生 sleep 和 usleep 函数的轻量级包装器，提供更高的可测试性，同时还提供了一个开发者友好的 API 用于处理时间：

php

use Illuminate\Support\Sleep;

$waiting = true;

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

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

Sleep 类提供了多种方法，允许您使用不同的时间单位：

php

// 睡眠后返回值...
$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();

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

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

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

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

要轻松组合时间单位，您可以使用 and 方法：

php

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

测试睡眠

在测试使用 Sleep 类或 PHP 原生睡眠函数的代码时，您的测试将暂停执行。正如您可能预料的那样，这会使您的测试套件显著变慢。例如，假设您正在测试以下代码：

php

$waiting = /* ... */;

$seconds = 1;

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

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

通常，测试此代码至少需要一秒钟。幸运的是，Sleep 类允许我们“伪造”睡眠，以便我们的测试套件保持快速：

PestPHPUnit

php

it('waits until ready', function () {
    Sleep::fake();

    // ...
});

php

public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

在伪造 Sleep 类时，实际的执行暂停被绕过，从而显著加快测试速度。

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

PestPHPUnit

php

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

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}

php

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 类提供了许多其他断言，您可以在测试时使用：

php

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 的时间操作助手来立即通过每次睡眠的持续时间推进时间：

php

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

Sleep::whenFakingSleep(function (Duration $duration) {
    // 在伪造睡眠时推进时间...
    $this->travel($duration->totalMilliseconds)->milliseconds();
});

由于时间推进是一个常见的需求，fake 方法接受一个 syncWithCarbon 参数，以便在测试中睡眠时与 Carbon 保持同步：

php

Sleep::fake(syncWithCarbon: true);

$start = now();

Sleep::for(1)->second();

$start->diffForHumans(); // 1 秒前

Laravel 在暂停执行时内部使用 Sleep 类。例如，retry 辅助函数在睡眠时使用 Sleep 类，从而在使用该辅助函数时提高可测试性。

Timebox

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

如果执行时间超过了固定的持续时间，Timebox 将不起作用。开发人员需要选择一个足够长的时间作为固定持续时间，以应对最坏的情况。

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

php

use Illuminate\Support\Timebox;

(new Timebox)->call(function ($timebox) {
    // ...
}, microseconds: 10000);

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

URI

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

你可以使用静态方法轻松创建一个 Uri 实例：

php

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()->addMinutes(5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);

// 从当前请求的 URL 生成 URI 实例...
$uri = $request->uri();

获取到 URI 实例后，你可以流畅地对其进行修改：

php

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

检查 URI

Uri 类还允许你轻松检查底层 URI 的各个组成部分：

php

$scheme = $uri->scheme();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$query = $uri->query();
$fragment = $uri->fragment();

操作查询字符串

Uri 类提供了多种方法用于操作 URI 的查询字符串。withQuery 方法可用于将额外的查询字符串参数合并到现有的查询字符串中：

php

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

withQueryIfMissing 方法可在指定键不存在于现有查询字符串中时，合并额外的查询字符串参数：

php

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

replaceQuery 方法可用于完全替换当前的查询字符串为新的内容：

php

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

pushOntoQuery 方法可用于向具有数组值的查询参数追加额外的参数：

php

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

withoutQuery 方法可用于从查询字符串中移除指定参数：

php

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

从 URI 生成响应

redirect 方法可用于生成一个指向指定 URI 的 RedirectResponse 实例：

php

$uri = Uri::of('https://example.com');

return $uri->redirect();

你也可以直接在路由或控制器中返回一个 Uri 实例，Laravel 会自动生成一个跳转到该 URI 的重定向响应：

php

use Illuminate\Support\Facades\Route;
use Illuminate\Support\Uri;

Route::get('/redirect', function () {
    return Uri::to('/index')
        ->withQuery(['sort' => 'name']);
});

辅助函数 ​

介绍 ​

可用方法 ​

数组 & 对象 ​

数字 ​

路径 ​

URL ​

杂项 ​

数组 & 对象 ​

Arr::accessible() ​

Arr::add() ​

Arr::collapse() ​

Arr::crossJoin() ​

Arr::divide() ​

Arr::dot() ​

Arr::except() ​

Arr::exists() ​

Arr::first() ​

Arr::flatten() ​

Arr::forget() ​

Arr::get() ​

Arr::has() ​

Arr::hasAny() ​

Arr::isAssoc() ​

Arr::isList() ​

Arr::join() ​

Arr::keyBy() ​

Arr::last() ​

Arr::map() ​

Arr::mapSpread() ​

Arr::mapWithKeys() ​

Arr::only() ​

Arr::partition() ​

Arr::pluck() ​

Arr::prepend() ​

Arr::prependKeysWith() ​

Arr::pull() ​

Arr::query() ​

Arr::random() ​

Arr::reject() ​

Arr::select() ​

Arr::set() ​

Arr::shuffle() ​

Arr::sole() ​

Arr::sort() ​

Arr::sortDesc() ​

Arr::sortRecursive() ​

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::percentage() ​

Number::spell() ​

Number::spellOrdinal() ​

Number::trim() ​

Number::useLocale() ​

Number::withLocale() ​

Number::useCurrency() ​

Number::withCurrency() ​

路径 ​

辅助函数

介绍

可用方法

数组 & 对象

数字

路径

URL

杂项

数组 & 对象

`Arr::accessible()`

`Arr::add()`

`Arr::collapse()`

`Arr::crossJoin()`

`Arr::divide()`

`Arr::dot()`

`Arr::except()`

`Arr::exists()`

`Arr::first()`

`Arr::flatten()`

`Arr::forget()`

`Arr::get()`

`Arr::has()`

`Arr::hasAny()`

`Arr::isAssoc()`

`Arr::isList()`

`Arr::join()`

`Arr::keyBy()`

`Arr::last()`

`Arr::map()`

`Arr::mapSpread()`

`Arr::mapWithKeys()`

`Arr::only()`

`Arr::partition()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::prependKeysWith()`

`Arr::pull()`

`Arr::query()`

`Arr::random()`

`Arr::reject()`

`Arr::select()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sole()`

`Arr::sort()`

`Arr::sortDesc()`

`Arr::sortRecursive()`

`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::percentage()`

`Number::spell()`

`Number::spellOrdinal()`

`Number::trim()`

`Number::useLocale()`

`Number::withLocale()`

`Number::useCurrency()`

`Number::withCurrency()`

路径