辅助函数

• 简介
• 可用方法
• 其他实用程序
  • 基准测试
  • 日期
  • 延迟函数
  • 彩票
  • 管道
  • 休眠

简介

Laravel 包含各种全局“辅助”PHP 函数。许多这些函数由框架本身使用；但是，如果您发现它们方便，可以在您自己的应用程序中随意使用它们。

可用方法

数组和对象

数字

路径

URL

其他

数组和对象

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

Arr::add 方法将给定的键/值对添加到数组中，前提是给定的键在数组中不存在或设置为 null。

use Illuminate\Support\Arr;
 
$array = Arr::add(['name' => 'Desk'], 'price', 100);
 
// ['name' => 'Desk', 'price' => 100]
 
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
 
// ['name' => 'Desk', 'price' => 100]

Arr::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' => '[email protected]',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => '[email protected]',
    ]
];
 
$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});
 
/*
    [
        '[email protected]' => 'John',
        '[email protected]' => 'Jane',
    ]
*/

Arr::only()

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

use Illuminate\Support\Arr;
 
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
 
$slice = Arr::only($array, ['name', 'price']);
 
// ['name' => 'Desk', 'price' => 100]

Arr::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 - (retrieved randomly)

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

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

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.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 类使用的默认货币。

use Illuminate\Support\Number;
 
$currency = Number::defaultCurrency();
 
// USD

Number::defaultLocale()

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

use Illuminate\Support\Number;
 
$locale = Number::defaultLocale();
 
// en

Number::fileSize()

Number::fileSize 方法将给定字节值的 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::pairs()

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

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 方法将给定值的百分比表示形式作为字符串返回。

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::trim()

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

use Illuminate\Support\Number;
 
$number = Number::trim(12.0);
 
// 12
 
$number = Number::trim(12.30);
 
// 12.3

Number::useLocale()

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

use Illuminate\Support\Number;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useLocale('de');
}

Number::withLocale()

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

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

Number::useCurrency()

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

use Illuminate\Support\Number;
 
/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useCurrency('GBP');
}

Number::withCurrency()

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

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

路径

app_path()

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

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

base_path()

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

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

config_path()

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

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

database_path()

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

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

lang_path()

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

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

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

URL

action()

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

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

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

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

asset()

asset 函数使用请求的当前方案（HTTP 或 HTTPS）为资源生成一个 URL。

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

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

// ASSET_URL=http://example.com/assets
 
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.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 门面的替代方案。

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

如果需要，您可以指定要访问哪个守卫实例。

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

back()

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

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

bcrypt()

bcrypt 函数使用 Bcrypt 哈希 给定的值。您可以将此函数用作 Hash 门面的替代方案。

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

blank()

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

blank('');
blank('   ');
blank(null);
blank(collect());
 
// true
 
blank(0);
blank(true);
blank(false);
 
// false

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

broadcast()

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

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 函数返回类使用的所有 trait，包括其所有父类使用的 trait。

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

collect()

collect 函数从给定值创建一个 集合 实例。

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

config()

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

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

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

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

context()

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

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

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

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

cookie()

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

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

csrf_field()

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

{{ csrf_field() }}

csrf_token()

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

$token = csrf_token();

decrypt()

decrypt 函数 解密 给定的值。您可以将此函数用作 Crypt 门面的替代方案。

$password = decrypt($value);

dd()

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

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

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

dispatch()

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

dispatch(new App\Jobs\SendEmails);

dispatch_sync()

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

dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函数转储给定的变量。

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

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

encrypt()

encrypt 函数 加密 给定的值。您可以将此函数用作 Crypt 门面的替代方案。

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

env()

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

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

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()->error('You are not allowed here.');

method_field()

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

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

now()

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

$now = now();

old()

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

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

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

{{ old('name', $user->name) }}
 
// Is equivalent to...
 
{{ old('name', $user) }}

once()

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

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}
 
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)

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

<?php
 
class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}
 
$service = new NumberService;
 
$service->all();
$service->all(); // (cached result)
 
$secondService = new NumberService;
 
$secondService->all();
$secondService->all(); // (cached result)

optional()

optional 函数接受任何参数，并允许您访问该对象的属性或调用方法。如果给定的对象为 null，则属性和方法将返回 null，而不是导致错误。

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

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

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

policy()

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

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

redirect()

redirect 函数返回 重定向 HTTP 响应，或者如果在不带参数的情况下调用则返回重定向器实例。

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

report()

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

report($e);

report 函数还接受字符串作为参数。当向函数提供字符串时，该函数将创建一个异常，并将该字符串作为其消息。

report('Something went wrong.');

report_if()

如果给定的条件为 true，则 report_if 函数将使用您的 异常处理程序 报告异常。

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

report_unless()

如果给定的条件为 false，则 report_unless 函数将使用您的 异常处理程序 报告异常。

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

request()

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

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

rescue()

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

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

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

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

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

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

resolve()

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

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

response()

response 函数创建 响应 实例或获取响应工厂的实例。

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

retry()

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

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

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

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