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

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

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

你也可以向 strict 参数传入 true,以便在过滤时使用严格类型比较:

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

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

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

你也可以向 strict 参数传入 true,以便在过滤时使用严格类型比较:

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

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 class 字符串。该方法接受一个类名数组,其中数组键为你希望添加的 class,值为布尔表达式。如果数组元素使用数字键,则它始终会被包含在最终渲染的 class 列表中:

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 style 字符串。该方法接受一个 CSS 声明数组,其中数组键为你希望添加的 CSS 声明,值为布尔表达式。如果数组元素使用数字键,则它始终会被包含在最终编译出的 CSS style 字符串中:

php
use Illuminate\Support\Arr;

$hasColor = true;

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

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

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

这个方法为 Laravel 提供了将 class 与 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 函数会返回给定数组中的第一个元素。如果数组为空,则返回 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::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;

/**
 * Bootstrap any application services.
 */
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;

/**
 * Bootstrap any application services.
 */
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 函数生成 database 目录中某个文件的完整路径:

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 函数会为给定 controller 动作生成 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 函数会为给定 controller 动作生成一个重定向 HTTP 响应

php
use App\Http\Controllers\UserController;

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

如有需要,你可以将应分配给重定向的 HTTP 状态码以及额外的响应头,分别作为方法的第三和第四个参数传入:

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 状态码以及额外的响应头,分别作为方法的第三和第四个参数传入:

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 函数传入一个包含可调用 controller 和方法对的数组,该函数会为该 controller 方法的路由路径创建一个 Uri 实例:

php
use App\Http\Controllers\UserController;

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

如果 controller 是可调用的 invokable controller,你可以直接提供 controller 类名:

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

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

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 函数会将给定的event 广播给其监听器:

php
broadcast(new UserRegistered($user));

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

broadcast_if()

broadcast_if 函数会在给定布尔表达式求值为 true 时,将给定的event 广播给其监听器:

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

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

broadcast_unless()

broadcast_unless 函数会在给定布尔表达式求值为 false 时,将给定的event 广播给其监听器:

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 token 值的 HTML hidden 输入字段。例如,使用 Blade 语法

blade
{{ csrf_field() }}

csrf_token()

csrf_token 函数会获取当前 CSRF token 的值:

php
$token = csrf_token();

decrypt()

decrypt 函数会对给定值进行解密。你可以将此函数作为 Crypt facade 的替代方案:

php
$password = decrypt($value);

decrypt 的反向函数请参阅 encrypt

dd()

dd 函数会 dump 给定变量并终止脚本执行:

php
dd($value);

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

如果你不想中断脚本执行,请改用 dump 函数。

dispatch()

dispatch 函数会将给定的job推送到 Laravel 的job 队列中:

php
dispatch(new App\Jobs\SendEmails);

dispatch_sync()

dispatch_sync 函数会将给定 job 推送到 sync 队列中,以便立即处理:

php
dispatch_sync(new App\Jobs\SendEmails);

dump()

dump 函数会 dump 给定变量:

php
dump($value);

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

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

encrypt()

encrypt 函数会对给定值进行加密。你可以将此函数作为 Crypt facade 的替代方案:

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 函数会将给定的event分发给它的监听器:

php
event(new UserRegistered($user));

fake()

fake 函数会从容器中解析出一个 Faker 单例,这在 model factory、数据库 seeding、测试以及视图原型开发中创建假数据时非常有用:

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 函数会生成一个 HTML hidden 输入字段,其中包含表单 HTTP 动词伪装后的值。例如,使用 Blade 语法

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

now()

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

php
$now = now();

old()

old 函数会获取闪存到 session 中的旧输入值:

php
$value = old('value');

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

由于传给 old 函数的第二个参数“默认值”通常是某个 Eloquent model 的属性,Laravel 允许你直接将整个 Eloquent model 作为第二个参数传给 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 (cached result)
random(); // 123 (cached result)

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 方法会为给定类获取一个policy实例:

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

redirect()

redirect 函数会返回一个重定向 HTTP 响应;如果不带参数调用,则返回 redirector 实例:

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('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 次,每次尝试之间休息 100ms……
}, 100);

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

php
use Exception;

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

为了方便起见,你可以将数组作为 retry 函数的第一个参数。这个数组将用于决定后续每次尝试之间应休眠多少毫秒:

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

如果你只想在特定条件下重试,可以将一个闭包作为 retry 函数的第四个参数传入:

php
use App\Exceptions\TemporaryException;
use Exception;

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

session()

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

php
$value = session('key');

你可以通过向该函数传入键 / 值对数组来设置值:

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

如果没有向该函数传值,则会返回 session 存储实例:

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 方法,强制它返回 model 本身:

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

如果你想为某个类添加 tap 方法,可以向该类添加 Illuminate\Support\Traits\Tappable trait。这个 trait 的 tap 方法只接受一个 Closure 作为参数。对象实例本身会被传给该 Closure,然后再由 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 函数会返回某个 trait 所使用的所有 trait:

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

transform()

transform 函数会在给定值不是 blank 时对其执行一个闭包,并返回该闭包的返回值:

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

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 的队列 job允许你将任务排队到后台处理,但有时你可能只想延后一些简单任务,而不想配置或维护长期运行的队列 worker。

延后函数允许你将某个闭包的执行推迟到 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 命令或队列 job 成功完成时,延后函数才会执行。这意味着如果某个请求最终返回 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('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// [tl! add:start]
    {
        parent::setUp();

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

抽签

Laravel 的 Lottery 类可用于根据给定概率执行回调。当你只想针对一部分进入应用的请求执行某段代码时,这会特别有用:

php
use Illuminate\Support\Lottery;

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

你可以将 Laravel 的 Lottery 类与其他 Laravel 特性结合使用。例如,你可能只想将一小部分慢查询报告给异常处理器。并且,由于 Lottery 类本身可调用,我们可以将它的实例传给任何接受可调用对象的方法:

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 提供了一些简单方法,让你可以轻松测试应用中对 Lottery 的调用:

php
// Lottery will always win...
Lottery::alwaysWin();

// Lottery will always lose...
Lottery::alwaysLose();

// Lottery will win then lose, and finally return to normal behavior...
Lottery::fix([true, false]);

// Lottery will return to normal behavior...
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 闭包将触发管道中的下一个可调用对象。你可能已经注意到,这与 middleware 非常相似。

当管道中的最后一个可调用对象调用 $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
// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);

// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());

// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();

// Pause execution for 2 seconds...
Sleep::for(2)->seconds();

// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();

// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();

// Pause execution until a given time...
Sleep::until(now()->plus(minutes: 1));

// Alias of PHP's native "sleep" function...
Sleep::sleep(2);

// Alias of PHP's native "usleep" function...
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('waits until ready', function () {
    Sleep::fake();

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

    // ...
}

在伪造 Sleep 类时,实际的执行暂停会被跳过,因此测试会快得多。

一旦 Sleep 类被伪造,就可以对预期发生的“休眠”进行断言。举例来说,假设我们正在测试一段会暂停执行三次的代码,而且每次暂停时间都增加一秒。通过 assertSequence 方法,我们可以在保持测试快速的同时,断言代码“休眠”了正确的时长:

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;

// Assert that sleep was called 3 times...
Sleep::assertSleptTimes(3);

// Assert against the duration of sleep...
Sleep::assertSlept(function (Duration $duration): bool {
    return /* ... */;
}, times: 1);

// Assert that the Sleep class was never invoked...
Sleep::assertNeverSlept();

// Assert that, even if Sleep was called, no execution paused occurred...
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 second ago

Laravel 在内部需要暂停执行时都会使用 Sleep 类。例如,retry 辅助函数在休眠时就会使用 Sleep 类,这让该辅助函数拥有更好的可测试性。

时间盒

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;

// Generate a URI instance from the given string...
$uri = Uri::of('https://example.com/path');

// Generate URI instances to paths, named routes, or controller actions...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);

// Generate a URI instance from the current request URL...
$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();
$authority = $uri->authority();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$segments = $uri->pathSegments();
$query = $uri->query();
$fragment = $uri->fragment();

操作查询字符串

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

或者,你也可以直接从路由或 controller 动作中返回 Uri 实例,它会自动生成一个重定向到该 URI 的响应:

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

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