Skip to content

辅助函数

简介

Laravel 包含多种全局"辅助"PHP 函数。其中许多函数被框架本身使用;不过,如果你觉得方便,也可以在自有应用程序中自由使用它们。

可用方法

数组与对象

数字

路径

URL

其他

数组与对象

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

Arr::array 方法使用"点"表示法从深层嵌套数组中检索值(就像 Arr::get() 一样),但如果请求的值不是 array,则抛出 InvalidArgumentException

php
use Illuminate\Support\Arr;

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

$value = Arr::array($array, 'languages');

// ['PHP', 'Ruby']

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

// 抛出 InvalidArgumentException

Arr::boolean()

Arr::boolean 方法使用"点"表示法从深层嵌套数组中检索值(就像 Arr::get() 一样),但如果请求的值不是 boolean,则抛出 InvalidArgumentException

php
use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'available' => true];

$value = Arr::boolean($array, 'available');

// true

$value = Arr::boolean($array, 'name');

// 抛出 InvalidArgumentException

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

Arr::every 方法确保数组中的所有值都通过给定的真值测试:

php
use Illuminate\Support\Arr;

$array = [1, 2, 3];

Arr::every($array, fn ($i) => $i > 0);

// true

Arr::every($array, fn ($i) => $i > 2);

// false

Arr::except()

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

php
use Illuminate\Support\Arr;

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

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

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

Arr::exceptValues()

Arr::exceptValues 方法从数组中移除指定的值:

php
use Illuminate\Support\Arr;

$array = ['foo', 'bar', 'baz', 'qux'];

$filtered = Arr::exceptValues($array, ['foo', 'baz']);

// ['bar', 'qux']

你还可以传递 truestrict 参数,以在过滤时使用严格类型比较:

php
use Illuminate\Support\Arr;

$array = [1, '1', 2, '2'];

$filtered = Arr::exceptValues($array, [1, 2], strict: true);

// ['1', '2']

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

Arr::float 方法使用"点"表示法从深层嵌套数组中检索值(就像 Arr::get() 一样),但如果请求的值不是 float,则抛出 InvalidArgumentException

php
use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'balance' => 123.45];

$value = Arr::float($array, 'balance');

// 123.45

$value = Arr::float($array, 'name');

// 抛出 InvalidArgumentException

Arr::forget()

Arr::forget 方法使用"点"表示法从深层嵌套数组中移除给定的键/值对:

php
use Illuminate\Support\Arr;

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

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

// ['products' => []]

Arr::from()

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

php
use Illuminate\Support\Arr;

Arr::from((object) ['foo' => 'bar']); // ['foo' => 'bar']

class TestJsonableObject implements Jsonable
{
    public function toJson($options = 0)
    {
        return json_encode(['foo' => 'bar']);
    }
}

Arr::from(new TestJsonableObject); // ['foo' => 'bar']

Arr::get()

Arr::get 方法使用"点"表示法从深层嵌套数组中检索值:

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

Arr::hasAll 方法使用"点"表示法确定指定键是否全部存在于给定数组中:

php
use Illuminate\Support\Arr;

$array = ['name' => 'Taylor', 'language' => 'PHP'];

Arr::hasAll($array, ['name']); // true
Arr::hasAll($array, ['name', 'language']); // true
Arr::hasAll($array, ['name', 'IDE']); // 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::integer()

Arr::integer 方法使用"点"表示法从深层嵌套数组中检索值(就像 Arr::get() 一样),但如果请求的值不是 int,则抛出 InvalidArgumentException

php
use Illuminate\Support\Arr;

$array = ['name' => 'Joe', 'age' => 42];

$value = Arr::integer($array, 'age');

// 42

$value = Arr::integer($array, 'name');

// 抛出 InvalidArgumentException

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

Arr::onlyValues 方法仅返回数组中指定的值:

php
use Illuminate\Support\Arr;

$array = ['foo', 'bar', 'baz', 'qux'];

$filtered = Arr::onlyValues($array, ['foo', 'baz']);

// ['foo', 'baz']

你还可以传递 truestrict 参数,以在过滤时使用严格类型比较:

php
use Illuminate\Support\Arr;

$array = [1, '1', 2, '2'];

$filtered = Arr::onlyValues($array, [1, 2], strict: true);

// [1, 2]

Arr::partition()

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

php
<?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::push()

Arr::push 方法使用"点"表示法将一个项推入数组。如果给定键处不存在数组,将创建它:

php
use Illuminate\Support\Arr;

$array = [];

Arr::push($array, 'office.furniture', 'Desk');

// $array: ['office' => ['furniture' => ['Desk']]]

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

Arr::some 方法确保数组中至少有一个值通过给定的真值测试:

php
use Illuminate\Support\Arr;

$array = [1, 2, 3];

Arr::some($array, fn ($i) => $i > 2);

// true

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

Arr::string 方法使用"点"表示法从深层嵌套数组中检索值(就像 Arr::get() 一样),但如果请求的值不是 string,则抛出 InvalidArgumentException

php
use Illuminate\Support\Arr;

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

$value = Arr::string($array, 'name');

// Joe

$value = Arr::string($array, 'languages');

// 抛出 InvalidArgumentException

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 样式字符串。该方法接受一个 CSS 声明数组,其中数组键包含你想要添加的 CSS 声明,而值是一个布尔表达式。如果数组元素具有数字键,它将始终包含在编译后的 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 函数返回给定数组中的第一个元素。如果数组为空,将返回 false

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

$first = head($array);

// 100

last()

last 函数返回给定数组中的最后一个元素。如果数组为空,将返回 false

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 €

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

// 1.000 €

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

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

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

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

Number::parse()

Number::parse 方法使用 PHP 的 NumberFormatter 解析本地化的数字字符串:

php
use Illuminate\Support\Number;

$result = Number::parse('10,123', locale: 'en');

// 10123.0

$result = Number::parse('10,123', locale: 'fr');

// 10.123

Number::parseInt()

Number::parseInt 方法根据指定的语言区域将字符串解析为整数:

php
use Illuminate\Support\Number;

$result = Number::parseInt('10.123');

// (int) 10

$result = Number::parseInt('10,123', locale: 'fr');

// (int) 10

Number::parseFloat()

Number::parseFloat 方法根据指定的语言区域将字符串解析为浮点数:

php
use Illuminate\Support\Number;

$result = Number::parseFloat('10');

// (float) 10.0

$result = Number::parseFloat('10', locale: 'fr');

// (float) 10.0

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

public_path()

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

php
$path = public_path();

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

resource_path()

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

php
$path = resource_path();

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

storage_path()

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

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

to_action 函数为给定的控制器操作生成一个重定向 HTTP 响应

php
use App\Http\Controllers\UserController;

return to_action([UserController::class, 'show'], ['user' => 1]);

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

php
return to_action(
    [UserController::class, 'show'],
    ['user' => 1],
    302,
    ['X-Framework' => 'Laravel']
);

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 生成一个流式 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]);

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

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

有关使用 url 函数的更多信息,请参阅 URL 生成文档

其他

abort()

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

php
abort(403);

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

php
abort(403, '未授权。', $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 外观的替代:

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

如果需要,你可以指定要访问的 guard 实例:

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

back()

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

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

return back();

bcrypt()

bcrypt 函数使用 Bcrypt 哈希给定的值。你可以使用此函数作为 Hash 外观的替代:

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

broadcast_if()

broadcast_if 函数在给定的布尔表达式评估为 true广播给定的事件给其监听器:

php
broadcast_if($user->isActive(), new UserRegistered($user));

broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();

broadcast_unless()

broadcast_unless 函数在给定的布尔表达式评估为 false广播给定的事件给其监听器:

php
broadcast_unless($user->isBanned(), new UserRegistered($user));

broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();

cache()

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

php
$value = cache('key');

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

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

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

cache(['key' => 'value'], now()->plus(seconds: 10));

class_uses_recursive()

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

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

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 外观的替代:

php
$password = decrypt($value);

关于 decrypt 的反操作,请参见 encrypt 函数。

dd()

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

php
dd($value);

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

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

dispatch()

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

php
dispatch(new App\Jobs\SendEmails);

dispatch_sync()

dispatch_sync 函数将给定的任务推送到sync队列,使其立即被处理:

php
dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函数转储给定的变量:

php
dump($value);

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

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

encrypt()

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

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

关于 encrypt 的反操作,请参见 decrypt 函数。

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>姓名</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>邮箱</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('一些有用的信息!');

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

php
info('用户登录尝试失败。', ['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('调试消息');

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

php
logger('用户已登录。', ['id' => $user->id]);

如果没有向该函数传递值,将返回一个日志记录器实例:

php
logger()->error('您无权访问此页面。');

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 = [], $secure = null);

return redirect('/home');

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

report()

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

php
report($e);

report 函数也接受字符串作为参数。当向函数提供字符串时,该函数将创建一个异常,并将给定的字符串作为其消息:

php
report('出了问题。');

report_if()

report_if 函数在给定的布尔表达式评估为 true 时,将使用你的异常处理器报告异常:

php
report_if($shouldReport, $e);

report_if($shouldReport, '出了问题。');

report_unless()

report_unless 函数在给定的布尔表达式评估为 false 时,将使用你的异常处理器报告异常:

php
report_unless($reportingDisabled, $e);

report_unless($reportingDisabled, '出了问题。');

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

休眠持续时间也接受 CarbonInterval 实例:

php
use function Illuminate\Support\seconds;

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

如果你希望手动计算尝试之间休眠的毫秒数,可以传递一个闭包作为 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 App\Exceptions\TemporaryException;
use Exception;

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

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,
    '您无权访问此页面。'
);

throw_unless()

throw_unless 函数在给定的布尔表达式评估为 false 时抛出给定异常:

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

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    '您无权访问此页面。'
);

today()

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

php
$today = today();

trait_uses_recursive()

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

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, '值为空');

// 值为空

validator()

validator 函数使用给定的参数创建一个新的验证器实例。你可以使用它作为 Validator 外观的替代:

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([
    '场景 1' => fn () => User::count(), // 0.5 ms
    '场景 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();

Laravel 还增强了 Carbon 实例,添加了 plusminus 方法,允许轻松操作实例的日期和时间:

php
return now()->plus(minutes: 5);
return now()->plus(hours: 8);
return now()->plus(weeks: 4);

return now()->minus(minutes: 5);
return now()->minus(hours: 8);
return now()->minus(weeks: 4);

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

间隔函数

Laravel 还提供了 millisecondssecondsminuteshoursdaysweeksmonthsyears 函数,这些函数返回 CarbonInterval 实例,该类扩展了 PHP 的 DateInterval 类。这些函数可用于 Laravel 接受 DateInterval 实例的任何地方:

php
use Illuminate\Support\Facades\Cache;

use function Illuminate\Support\{minutes};

Cache::put('metrics', $metrics, minutes(10));

延迟函数

虽然 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 命令或队列任务成功完成时才会执行。这意味着如果请求导致 4xx5xx HTTP 响应,延迟函数将不会执行。如果你希望延迟函数始终执行,可以链式调用 always 方法:

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

WARNING

如果你已安装 Swoole PHP 扩展,Laravel 的 defer 函数可能与 Swoole 自己的全局 defer 函数冲突,导致 Web 服务器错误。确保通过显式命名空间来调用 Laravel 的 defer 辅助函数:use function Illuminate\Support\defer;

取消延迟函数

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

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

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

在测试中禁用延迟函数

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

php
test('无需延迟', 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// [tl! add:start]
    {
        parent::setUp();

        $this->withoutDefer();
    }// [tl! add:end]
}

抽奖

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('查询超过 2 秒。')),
);

测试抽奖

Laravel 提供了一些简单的方法,使你能够轻松测试应用程序中的抽奖调用:

php
// 抽奖将始终中奖...
Lottery::alwaysWin();

// 抽奖将始终不中...
Lottery::alwaysLose();

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

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

管道

Laravel 的 Pipeline 外观提供了一种方便的方法,将给定的输入"管道"传递一系列可调用的类、闭包或可调用对象,使每个类有机会检查或修改输入,并调用管道中的下一个可调用对象:

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 方法的可调用对象。通常,此可调用对象将简单地返回给定的输入。为方便起见,如果你只想在处理后返回输入,可以使用 thenReturn 方法。

当然,如前所述,你不仅限于向管道提供闭包。你还可以提供可调用的类。如果提供了类名,该类将通过 Laravel 的服务容器实例化,从而允许将依赖注入到可调用的类中:

php
$user = Pipeline::send($user)
    ->through([
        GenerateProfilePhoto::class,
        ActivateSubscription::class,
        SendWelcomeEmail::class,
    ])
    ->thenReturn();

withinTransaction 方法可以在管道上调用,以自动将管道的所有步骤包装在单个数据库事务中:

php
$user = Pipeline::send($user)
    ->withinTransaction()
    ->through([
        ProcessOrder::class,
        TransferFunds::class,
        UpdateInventory::class,
    ])
    ->thenReturn();

睡眠

Laravel 的 Sleep 类是 PHP 原生 sleepusleep 函数的轻量级包装器,在提供更开发者友好的时间处理 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()->plus(minutes: 1));

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

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

要轻松组合时间单位,你可以使用 and 方法:

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

测试睡眠

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

php
$waiting = /* ... */;

$seconds = 1;

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

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

通常,测试此代码将需要至少一秒。幸运的是,Sleep 类允许我们"伪造"睡眠,以使测试套件保持快速:

php
it('等待直到准备就绪', function () {
    Sleep::fake();

    // ...
});
php
public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

当伪造 Sleep 类时,实际的执行暂停将被绕过,从而产生更快的测试。

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

php
it('检查三次是否准备就绪', 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;

// 断言调用了 3 次 sleep...
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 类,从而在使用该辅助函数时提供更好的可测试性。

时间盒

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

如果执行超过固定的持续时间,Timebox 没有效果。由开发人员选择一个足够长的时间作为固定持续时间,以应对最坏情况。

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

php
use Illuminate\Support\Timebox;

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

基于 MIT 协议发布