Laravel 包含各种全局的"辅助"PHP 函数。其中许多函数由框架本身使用;但是,如果你觉得它们方便,也可以在你自己的应用程序中随意使用它们。
Arr::accessible
Arr::add
Arr::array
Arr::boolean
Arr::collapse
Arr::crossJoin
Arr::divide
Arr::dot
Arr::every
Arr::except
Arr::exists
Arr::first
Arr::flatten
Arr::float
Arr::forget
Arr::from
Arr::get
Arr::has
Arr::hasAll
Arr::hasAny
Arr::integer
Arr::isAssoc
Arr::isList
Arr::join
Arr::keyBy
Arr::last
Arr::map
Arr::mapSpread
Arr::mapWithKeys
Arr::only
Arr::partition
Arr::pluck
Arr::prepend
Arr::prependKeysWith
Arr::pull
Arr::push
Arr::query
Arr::random
Arr::reject
Arr::select
Arr::set
Arr::shuffle
Arr::sole
Arr::some
Arr::sort
Arr::sortDesc
Arr::sortRecursive
Arr::string
Arr::take
Arr::toCssClasses
Arr::toCssStyles
Arr::undot
Arr::where
Arr::whereNotNull
Arr::wrap
data_fill
data_get
data_set
data_forget
head
last
Number::abbreviate
Number::clamp
Number::currency
Number::defaultCurrency
Number::defaultLocale
Number::fileSize
Number::forHumans
Number::format
Number::ordinal
Number::pairs
Number::parseInt
Number::parseFloat
Number::percentage
Number::spell
Number::spellOrdinal
Number::trim
Number::useLocale
Number::withLocale
Number::useCurrency
Number::withCurrency
app_path
base_path
config_path
database_path
lang_path
public_path
resource_path
storage_path
action
asset
route
secure_asset
secure_url
to_action
to_route
uri
url
abort
abort_if
abort_unless
app
auth
back
bcrypt
blank
broadcast
broadcast_if
broadcast_unless
cache
class_uses_recursive
collect
config
context
cookie
csrf_field
csrf_token
decrypt
dd
dispatch
dispatch_sync
dump
encrypt
env
event
fake
filled
info
literal
logger
method_field
now
old
once
optional
policy
redirect
report
report_if
report_unless
request
rescue
resolve
response
retry
session
tap
throw_if
throw_unless
today
trait_uses_recursive
transform
validator
value
view
with
when
Arr::accessible()Arr::accessible 方法判断给定值是否可以数组访问:
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// falseArr::add()该 Arr::add 方法将给定的 键 / 值 对添加到数组中,如果该给定的键在数组中尚不存在或被设置为 null:
use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]Arr::array()该 Arr::array 方法使用“点”表示法从深度嵌套的数组中检索值(就像 Arr::get() 一样),但抛出 InvalidArgumentException 如果请求的值不是一个 array:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::array($array, 'languages');
// ['PHP', 'Ruby']
$value = Arr::array($array, 'name');
// throws 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');
// throws InvalidArgumentException
Arr::collapse()Arr::collapse 方法将数组的数组或集合折叠成单个数组:
use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]Arr::crossJoin()Arr::crossJoin 方法对给定数组进行交叉连接,返回一个包含所有可能排列的笛卡尔积:
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/Arr::divide()该 Arr::divide 方法返回两个数组:一个包含键,另一个包含给定数组的值:
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']Arr::dot()Arr::dot 方法将多维数组展平为一个使用“点”符号来表示深度的一维数组:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]Arr::every()Arr::every 方法确保数组中的所有值都通过给定的真值测试:
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::every($array, fn ($i) => $i > 0);
// true
Arr::every($array, fn ($i) => $i > 2);
// falseArr::except()Arr::except 方法会从数组中移除给定的键/值对:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']Arr::exists()Arr::exists 方法用于检查给定键是否存在于所提供的数组中:`
use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// falseArr::first()Arr::first 方法返回通过给定真值测试的数组的第一个元素:
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function (int $value, int $key) {
return $value >= 150;
});
// 200默认值也可以作为第三个参数传递给该方法。如果没有值通过真值测试,则会返回此值:
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);Arr::flatten()Arr::flatten 方法将一个多维数组扁平化为一个一维数组:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']Arr::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');
// throws InvalidArgumentException
Arr::forget()Arr::forget 方法使用“点”符号从一个深度嵌套的数组中移除指定的键/值对:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]Arr::from()Arr::from 方法将各种输入类型转换为一个纯 PHP 数组。它支持多种输入类型,包括数组、对象,以及一些常见的 Laravel 接口,例如 Arrayable、Enumerable、Jsonable 和 JsonSerializable。此外,它还处理 Traversable 和 WeakMap 实例:
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 方法使用“点”表示法从一个深度嵌套的数组中检索一个值:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100Arr::get 方法也接受一个默认值,如果指定的键不在数组中,该默认值将被返回:
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0Arr::has()该 Arr::has 方法检查给定项或多项是否存在于数组中,使用“点”表示法:
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::has($array, 'product.name');
// true
$contains = Arr::has($array, ['product.price', 'product.discount']);
// falseArr::具有所有()Arr::hasAll 方法确定给定数组中是否使用“点”表示法存在所有指定的键:
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']); // falseArr::hasAny()Arr::hasAny 方法检查给定集合中的任何项是否使用“点”表示法存在于数组中:
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// falseArr::整数()Arr::integer 方法使用“点”表示法从深度嵌套的数组中检索一个值(就像 Arr::get() 所做的那样),但会抛出 InvalidArgumentException 如果请求的值不是 int:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'age' => 42];
$value = Arr::integer($array, 'age');
// 42
$value = Arr::integer($array, 'name');
// throws InvalidArgumentException
Arr::isAssoc()该 Arr::isAssoc 方法返回 true,如果给定数组是一个关联数组。如果数组不包含从零开始的连续数字键,则认为该数组是“关联的”:
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// falseArr::isList()该 Arr::isList 方法返回 true 如果给定数组的键是从零开始的连续整数:
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// falseArr::连接()该 Arr::join 方法使用字符串连接数组元素。使用该方法的第三个参数,您还可以指定数组最后一个元素的连接字符串:
use Illuminate\Support\Arr;
$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
$joined = Arr::join($array, ', ');
// Tailwind, Alpine, Laravel, Livewire
$joined = Arr::join($array, ', ', ', and ');
// Tailwind, Alpine, Laravel, and LivewireArr::keyBy()Arr::keyBy 方法根据给定的键为数组建立索引。如果多个项具有相同的键,只有最后一个会出现在新数组中:
use Illuminate\Support\Arr;
$array = [
['product_id' => 'prod-100', 'name' => 'Desk'],
['product_id' => 'prod-200', 'name' => 'Chair'],
];
$keyed = Arr::keyBy($array, 'product_id');
/*
[
'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]
*/Arr::last()Arr::last 方法返回通过给定真值测试的数组的最后一个元素:
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function (int $value, int $key) {
return $value >= 150;
});
// 300默认值可以作为第三个参数传递给该方法。如果没有值通过真值测试,将返回此值:
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);Arr::map()Arr::map 方法会遍历数组并将每个值和键传递给给定的回调。 数组中的值会被回调返回的值替换:
use Illuminate\Support\Arr;
$array = ['first' => 'james', 'last' => 'kirk'];
$mapped = Arr::map($array, function (string $value, string $key) {
return ucfirst($value);
});
// ['first' => 'James', 'last' => 'Kirk']Arr::mapSpread()Arr::mapSpread 方法迭代数组,将每个嵌套项的值传递给给定闭包。该闭包可以自由修改项并将其返回,从而形成一个包含修改后项的新数组:
use Illuminate\Support\Arr;
$array = [
[0, 1],
[2, 3],
[4, 5],
[6, 7],
[8, 9],
];
$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
return $even + $odd;
});
/*
[1, 5, 9, 13, 17]
*/Arr::mapWithKeys()Arr::mapWithKeys 方法遍历数组,并将每个值传递给指定的回调。该回调应返回一个包含单个键/值对的关联数组:
use Illuminate\Support\Arr;
$array = [
[
'name' => 'John',
'department' => 'Sales',
'email' => 'john@example.com',
],
[
'name' => 'Jane',
'department' => 'Marketing',
'email' => 'jane@example.com',
]
];
$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
return [$item['email'] => $item['name']];
});
/*
[
'john@example.com' => 'John',
'jane@example.com' => 'Jane',
]
*/Arr::only()Arr::only 方法仅返回给定数组中指定的键值对:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]Arr::partition()The Arr::partition 方法可以与 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 方法从数组中检索给定键的所有值:
use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']你也可以指定你希望生成的列表如何进行键控:
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']Arr::前置()Arr::prepend 方法会将一个项目添加到数组的开头:
use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']如果需要,您可以指定应为该值使用的键:
use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]Arr::前置键名()Arr::prependKeysWith 为一个关联数组的所有键名添加给定前缀:
use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.price' => 100,
]
*/Arr::pull()Arr::pull 方法返回并移除数组中的一个键/值对:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]一个默认值可以作为第三个参数传递给该方法。如果键不存在,此值将被返回:
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);Arr::push()该 Arr::push 方法使用“点”符号将项目推入数组中. 如果给定键处不存在数组, 则会创建该数组:
use Illuminate\Support\Arr;
$array = [];
Arr::push($array, 'office.furniture', 'Desk');
// $array: ['office' => ['furniture' => ['Desk']]]Arr::query()该 Arr::query 方法将数组转换为查询字符串:
use Illuminate\Support\Arr;
$array = [
'name' => 'Taylor',
'order' => [
'column' => 'created_at',
'direction' => 'desc'
]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=descArr::random()Arr::random 方法从数组中返回一个随机值:
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)您还可以指定要返回的项目数量,作为可选的第二个参数。请注意,即使只需要一个项目,提供此参数也将返回一个数组:
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)Arr::拒绝()该 Arr::reject 方法使用给定的闭包从数组中移除项:
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 方法从一个数组中选择一个值数组:
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 方法使用“点”表示法在一个深度嵌套的数组中设置一个值:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]Arr::shuffle()Arr::shuffle 方法会随机打乱数组中的项目:
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)Arr::唯一()Arr::sole 方法使用给定的闭包从数组中检索单个值。如果数组中有多个值匹配给定的真值测试,则会抛出 Illuminate\Support\MultipleItemsFoundException 异常。如果没有值匹配真值测试,则会抛出 Illuminate\Support\ItemNotFoundException 异常:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$value = Arr::sole($array, fn (string $value) => $value === 'Desk');
// 'Desk'Arr::some()Arr::some 方法确保数组中至少一个值通过给定的真值测试:
use Illuminate\Support\Arr;
$array = [1, 2, 3];
Arr::some($array, fn ($i) => $i > 2);
// trueArr::sort()该 Arr::sort 方法根据其值对数组进行排序:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']您还可以根据给定闭包的结果对数组进行排序:
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/Arr::sortDesc()Arr::sortDesc 方法根据其值对数组进行降序排序:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sortDesc($array);
// ['Table', 'Desk', 'Chair']你还可以根据给定闭包的结果对数组进行排序:
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sortDesc($array, function (array $value) {
return $value['name'];
}));
/*
[
['name' => 'Table'],
['name' => 'Desk'],
['name' => 'Chair'],
]
*/Arr::递归排序()Arr::sortRecursive 方法递归地对数组进行排序,其中对数字索引的子数组使用 sort 函数,对关联子数组使用 ksort 函数:
use Illuminate\Support\Arr;
$array = [
['Roman', 'Taylor', 'Li'],
['PHP', 'Ruby', 'JavaScript'],
['one' => 1, 'two' => 2, 'three' => 3],
];
$sorted = Arr::sortRecursive($array);
/*
[
['JavaScript', 'PHP', 'Ruby'],
['one' => 1, 'three' => 3, 'two' => 2],
['Li', 'Roman', 'Taylor'],
]
*/如果您希望结果按降序排序,您可以使用 Arr::sortRecursiveDesc 方法。
$sorted = Arr::sortRecursiveDesc($array);Arr::string()Arr::string 方法使用“点”表示法从深度嵌套数组中检索值 (就像 [Arr::get()](#method-array-get) 一样),但如果请求的值不是 string,则会抛出 InvalidArgumentException:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$value = Arr::string($array, 'name');
// Joe
$value = Arr::string($array, 'languages');
// throws InvalidArgumentException
Arr::截取()Arr::take 方法返回一个包含指定数量项的新数组:
use Illuminate\Support\Arr;
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, 3);
// [0, 1, 2]您也可以传入一个负整数,以从数组末尾获取指定数量的项:
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, -2);
// [4, 5]Arr::toCssClasses()Arr::toCssClasses 方法条件性地编译一个 CSS 类字符串。该方法接受一个类数组,其中数组键包含你希望添加的一个或多个类,而值是一个布尔表达式。如果数组元素具有数字键,它将始终包含在渲染的类列表中:
use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/Arr::toCssStyles()此 Arr::toCssStyles 有条件地编译一个 CSS 样式字符串。该方法接受一个类数组,其中数组键包含你希望添加的类或多个类,而值是一个布尔表达式。如果数组元素具有数字键,它将始终被包含在渲染的类列表中:
use Illuminate\Support\Arr;
$hasColor = true;
$array = ['background-color: blue', 'color: blue' => $hasColor];
$classes = Arr::toCssStyles($array);
/*
'background-color: blue; color: blue;'
*/此方法为 Laravel 的功能提供支持,允许将类与 Blade 组件的属性包合并以及@classBlade 指令。
Arr::undot()Arr::undot 方法将使用“点”表示法的一维数组展开为一个多维数组:
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]Arr::where()该 Arr::where 方法使用给定的闭包过滤数组:
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function (string|int $value, int $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']Arr::whereNotNull()Arr::whereNotNull 方法从给定数组中移除所有 null 值:
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]Arr::wrap()Arr::wrap 方法将给定值封装到数组中. 如果给定值已经是一个数组,它将不作任何修改地返回:
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']如果给定值为 null,将返回一个空数组:
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []data_fill()data_fill 函数使用“点”表示法,在一个嵌套数组或对象中设置一个缺失值:
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]这个函数也接受星号作为通配符,并会相应地填充目标:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/data_get()data_get 函数使用“点”表示法从嵌套数组或对象中获取值:
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100data_get 函数也接受一个默认值,如果指定的键未找到,该值将被返回:
$discount = data_get($data, 'products.desk.discount', 0);
// 0该函数也支持使用星号的通配符,可以匹配数组或对象的任意键:
$data = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];占位符 {first} 和 {last} 可用于获取数组中的第一个或最后一个元素:
$flight = [
'segments' => [
['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
],
];
data_get($flight, 'segments.{first}.arrival');
// 15:00data_set()data_set 函数使用“点”表示法在嵌套数组或对象中设置一个值:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]此函数也接受使用星号的通配符,并会相应地在目标上设置值:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_set($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 200],
['name' => 'Desk 2', 'price' => 200],
],
]
*/默认情况下,任何现有值都将被覆盖。如果您只想在值不存在时才设置它,您可以将 false 作为第四个参数传递给该函数:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, overwrite: false);
// ['products' => ['desk' => ['price' => 100]]]data_forget()此 data_forget 函数使用“点”符号从嵌套数组或对象中移除一个值:
$data = ['products' => ['desk' => ['price' => 100]]];
data_forget($data, 'products.desk.price');
// ['products' => ['desk' => []]]此函数也接受使用星号的通配符,并将相应地移除目标上的值:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_forget($data, 'products.*.price');
/*
[
'products' => [
['name' => 'Desk 1'],
['name' => 'Desk 2'],
],
]
*/head()head 函数返回给定数组中的第一个元素。如果数组为空,将返回 false:
$array = [100, 200, 300];
$first = head($array);
// 100该 last 函数返回给定数组中的最后一个元素。如果数组为空,则将返回 false:
$array = [100, 200, 300];
$last = last($array);
// 300Number::abbreviate()该 Number::abbreviate 方法返回所提供数值的可读格式,并带有单位缩写:
use Illuminate\Support\Number;
$number = Number::abbreviate(1000);
// 1K
$number = Number::abbreviate(489939);
// 490K
$number = Number::abbreviate(1230000, precision: 2);
// 1.23M数字::clamp()Number::clamp 方法确保给定数字保持在指定范围内。如果数字小于最小值,则返回最小值。如果数字大于最大值,则返回最大值:
use Illuminate\Support\Number;
$number = Number::clamp(105, min: 10, max: 100);
// 100
$number = Number::clamp(5, min: 10, max: 100);
// 10
$number = Number::clamp(10, min: 10, max: 100);
// 10
$number = Number::clamp(20, min: 10, max: 100);
// 20数字::货币()Number::currency 方法返回给定值的货币表示形式作为字符串:
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 类正在使用的默认货币:
use Illuminate\Support\Number;
$currency = Number::defaultCurrency();
// USDNumber::默认语言环境()该 Number::defaultLocale 方法返回 Number 类正在使用的默认区域设置:
use Illuminate\Support\Number;
$locale = Number::defaultLocale();
// enNumber::文件大小()Number::fileSize 方法以字符串形式返回给定字节值的文件大小表示:
use Illuminate\Support\Number;
$size = Number::fileSize(1024);
// 1 KB
$size = Number::fileSize(1024 * 1024);
// 1 MB
$size = Number::fileSize(1024, precision: 2);
// 1.00 KBNumber::forHumans()Number::forHumans 方法返回所提供数值的人类可读格式:
use Illuminate\Support\Number;
$number = Number::forHumans(1000);
// 1 thousand
$number = Number::forHumans(489939);
// 490 thousand
$number = Number::forHumans(1230000, precision: 2);
// 1.23 millionNumber::format()Number::format 方法将给定数字格式化为区域设置特定的字符串:
use Illuminate\Support\Number;
$number = Number::format(100000);
// 100,000
$number = Number::format(100000, precision: 2);
// 100,000.00
$number = Number::format(100000.123, maxPrecision: 2);
// 100,000.12
$number = Number::format(100000, locale: 'de');
// 100.000Number::ordinal()该 Number::ordinal 方法返回数字的序数表示:
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21st数字::对()Number::pairs 方法根据指定的范围和步长值生成一个数字对(子范围)数组。该方法可用于将较大范围的数字划分为更小、更易于管理的子范围,以实现分页或批处理任务等目的。pairs 方法返回一个数组的数组,其中每个内部数组表示一对(子范围)数字:
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 方法根据指定的区域设置将字符串解析为整数:
use Illuminate\Support\Number;
$result = Number::parseInt('10.123');
// (int) 10
$result = Number::parseInt('10,123', locale: 'fr');
// (int) 10Number::parseFloat()Number::parseFloat 方法根据指定的区域设置将字符串解析为浮点数:
use Illuminate\Support\Number;
$result = Number::parseFloat('10');
// (float) 10.0
$result = Number::parseFloat('10', locale: 'fr');
// (float) 10.0Number::percentage()Number::percentage 方法返回给定值的百分比表示,以字符串形式:
use Illuminate\Support\Number;
$percentage = Number::percentage(10);
// 10%
$percentage = Number::percentage(10, precision: 2);
// 10.00%
$percentage = Number::percentage(10.123, maxPrecision: 2);
// 10.12%
$percentage = Number::percentage(10, precision: 2, locale: 'de');
// 10,00%数字::拼写()Number::spell 方法将给定数字转换为单词字符串:
use Illuminate\Support\Number;
$number = Number::spell(102);
// one hundred and two
$number = Number::spell(88, locale: 'fr');
// quatre-vingt-huit这个 after 参数允许您指定一个值在此之后所有数字都应拼写出来:
$number = Number::spell(10, after: 10);
// 10
$number = Number::spell(11, after: 10);
// elevenuntil 参数允许您指定一个值,在此值之前,所有数字都应拼写出来:
$number = Number::spell(5, until: 10);
// five
$number = Number::spell(10, until: 10);
// 10Number::spellOrdinal()Number::spellOrdinal 方法以词语字符串形式返回数字的序数表示:
use Illuminate\Support\Number;
$number = Number::spellOrdinal(1);
// first
$number = Number::spellOrdinal(2);
// second
$number = Number::spellOrdinal(21);
// twenty-first数字::修剪()Number::trim 方法移除给定数字小数点后所有尾随的零位数字:
use Illuminate\Support\Number;
$number = Number::trim(12.0);
// 12
$number = Number::trim(12.30);
// 12.3数字::使用区域设置()Number::useLocale 方法全局设置默认数字区域设置,这会影响后续调用 Number 类方法时数字和货币的格式化方式:
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useLocale('de');
}Number::withLocale 方法使用指定的语言环境执行给定的闭包,并在回调执行后恢复原始语言环境:
use Illuminate\Support\Number;
$number = Number::withLocale('de', function () {
return Number::format(1500);
});Number::useCurrency()Number::useCurrency 方法全局设置默认数字货币,这会影响后续调用 Number 类方法时货币的格式化方式:
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useCurrency('GBP');
}数字::附带货币()Number::withCurrency 方法使用指定的货币执行给定的闭包,然后在回调执行完毕后恢复原始货币:
use Illuminate\Support\Number;
$number = Number::withCurrency('GBP', function () {
// ...
});app_path()app_path 函数返回你的应用程序的 app 目录的完全限定路径。你也可以使用 app_path 函数来生成相对于应用程序目录的文件的完全限定路径:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');基本路径()base_path 函数返回你的应用程序的根目录的完整路径。你也可以使用 base_path 函数来生成相对于项目根目录的给定文件的完整路径:
$path = base_path();
$path = base_path('vendor/bin');config_path()config_path 函数返回你的应用程序的 config 目录的完整路径。你也可以使用 config_path 函数来生成应用程序配置目录中指定文件的完整路径:
$path = config_path();
$path = config_path('app.php');数据库路径()database_path 函数返回你的应用程序的 database 目录的完整路径。你也可以使用 database_path 函数来生成指向数据库目录中某个给定文件的完整路径:
$path = database_path();
$path = database_path('factories/UserFactory.php');lang_path()lang_path 函数返回你的应用程序的 lang 目录的完全限定路径。你也可以使用 lang_path 函数来生成该目录中指定文件的完全限定路径:
$path = lang_path();
$path = lang_path('en/messages.php');[!注意]
默认情况下,Laravel 应用程序骨架不包含lang目录。如果您想自定义 Laravel 的语言文件,您可以通过lang:publishArtisan 命令发布它们。
public_path()该 public_path 函数返回您的应用程序的 public 目录的完整路径。您也可以使用 public_path 函数来生成 public 目录中给定文件的完整路径:
$path = public_path();
$path = public_path('css/app.css');resource_path()resource_path 函数返回您的应用程序的 resources 目录的完整路径。您也可以使用 resource_path 函数来生成 resources 目录中给定文件的完整路径:
$path = resource_path();
$path = resource_path('sass/app.scss');storage_path()该 storage_path 函数返回您的应用程序的 storage 目录的完全限定路径。您也可以使用 storage_path 函数,以生成存储目录中给定文件的完全限定路径:
$path = storage_path();
$path = storage_path('app/file.txt');action()该 action 函数为指定的控制器动作生成一个 URL:
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);如果方法接受路由参数,你可以将它们作为第二个参数传递给该方法:
$url = action([UserController::class, 'profile'], ['id' => 1]);asset()该 asset 函数利用请求的当前方案(HTTP 或 HTTPS)为资产生成一个 URL:
$url = asset('img/photo.jpg');您可以通过设置 ASSET_URL 变量来配置资产 URL 主机,该变量位于您的 .env 文件中。如果您将资产托管在外部服务上(例如 Amazon S3 或其他 CDN),这会非常有用:
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpgroute()该 route 函数为给定的 命名路由 生成 URL:
$url = route('route.name');如果路由接受参数,您可以将它们作为第二个参数传递给该函数:
$url = route('route.name', ['id' => 1]);默认情况下,route 函数生成一个绝对 URL。如果你想生成一个相对 URL,你可以将 false 作为第三个参数传递给该函数:
$url = route('route.name', ['id' => 1], false);secure_asset()secure_asset 函数使用 HTTPS 为资产生成 URL:
$url = secure_asset('img/photo.jpg');secure_url()此 secure_url 函数生成一个完全限定的 HTTPS URL 指向给定路径。额外的 URL 片段可以在函数的第二个参数中传递:
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);to_action()该 to_action 函数生成一个 重定向 HTTP 响应,用于指定的控制器动作:
use App\Http\Controllers\UserController;
return to_action([UserController::class, 'show'], ['user' => 1]);如有必要,您可以将应分配给重定向的 HTTP 状态码以及任何额外的响应头作为第三和第四个参数传入 to_action 方法:
return to_action(
[UserController::class, 'show'],
['user' => 1],
302,
['X-Framework' => 'Laravel']
);to_route()该 to_route 函数生成一个 重定向 HTTP 响应 用于给定的 命名路由:
return to_route('users.show', ['user' => 1]);如有必要,您可以传入应分配给重定向的 HTTP 状态码以及任何额外的响应头作为第三个和第四个参数到 to_route 方法:
return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);uri()该 uri 函数 生成一个 流畅的 URI 实例 用于给定的 URI:
$uri = uri('https://example.com')
->withPath('/users')
->withQuery(['page' => 1]);如果 uri 函数给定一个包含可调用控制器和方法对的数组,该函数将为控制器方法的路由路径创建一个 Uri 实例:
use App\Http\Controllers\UserController;
$uri = uri([UserController::class, 'show'], ['user' => $user]);如果控制器是可调用的,您只需提供控制器类名:
use App\Http\Controllers\UserIndexController;
$uri = uri(UserIndexController::class);如果提供给 uri 函数的值与 命名路由 的名称匹配,则会为该路由的路径生成一个 Uri 实例:
$uri = uri('users.show', ['user' => $user]);url()url 函数会生成指向给定路径的完全限定 URL:
$url = url('user/profile');
$url = url('user/profile', [1]);如果未提供路径, 一个 Illuminate\Routing\UrlGenerator 实例被返回:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();有关使用 url 函数的更多信息,请查阅 URL 生成文档。
abort()abort 函数会抛出一个 HTTP 异常,该异常将由 异常处理器 渲染:
abort(403);您还可以提供异常消息以及应发送到浏览器的自定义 HTTP 响应头:
abort(403, 'Unauthorized.', $headers);abort_if()该 abort_if 函数抛出一个 HTTP 异常如果给定的布尔表达式评估结果为 true:`
abort_if(! Auth::user()->isAdmin(), 403);类似于 abort 方法,您还可以提供异常的响应文本作为第三个参数以及自定义响应头的数组作为第四个参数传递给该函数。
abort_unless()该 abort_unless 函数在给定布尔表达式的评估结果为 false 时会抛出一个 HTTP 异常:
abort_unless(Auth::user()->isAdmin(), 403);与 abort 方法类似,您还可以将异常的响应文本作为第三个参数,以及一个自定义响应头数组作为函数的第四个参数。
app()app 函数返回 服务容器 实例:
$container = app();您可以传入一个类或接口名称,以从容器中解析它:
$api = app('HelpSpot\API');auth()auth 函数返回一个 认证器 实例。 你可以使用它作为 Auth facade 的替代方案:
$user = auth()->user();如果需要,您可以指定要访问的 guard 实例:
$user = auth('admin')->user();back()该 back 函数生成一个 重定向 HTTP 响应 到用户的上一个位置:
return back($status = 302, $headers = [], $fallback = '/');
return back();bcrypt()此 bcrypt 函数 哈希 给定的值,使用 Bcrypt。您可以使用此函数作为 Hash 门面的替代方案:
$password = bcrypt('my-secret-password');blank()该 blank 函数判断给定值是否为“空白”:
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false对于 blank 的逆,请参阅 填充 函数。
该 broadcast 函数会 广播 给定的 事件 给其监听器:
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();broadcast_if()该 broadcast_if 函数 广播 给定的 事件 给其监听器,如果给定布尔表达式评估为 true:
broadcast_if($user->isActive(), new UserRegistered($user));
broadcast_if($user->isActive(), new UserRegistered($user))->toOthers();broadcast_unless()broadcast_unless 函数 广播 给定的 事件 给其监听器,如果给定的布尔表达式求值为 false:
broadcast_unless($user->isBanned(), new UserRegistered($user));
broadcast_unless($user->isBanned(), new UserRegistered($user))->toOthers();cache()该 cache 函数可用于从 缓存 获取值。如果给定键在缓存中不存在,将返回一个可选的默认值:
$value = cache('key');
$value = cache('key', 'default');您可以通过向函数传递键/值对数组来向缓存添加项。
您还应该传递缓存值应被视为有效的秒数或持续时间:
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));class_uses_recursive()class_uses_recursive 函数返回一个类使用的所有 traits,包括其所有父类使用的 traits:
$traits = class_uses_recursive(App\Models\User::class);收集()该 collect 函数从给定值创建了一个 集合 实例:
$collection = collect(['Taylor', 'Abigail']);config()config 函数获取一个 配置 变量的值。配置值可以使用“点”语法访问,该语法包含文件名和您希望访问的选项。您还可以提供一个默认值,如果配置选项不存在,该默认值将被返回:
$value = config('app.timezone');
$value = config('app.timezone', $default);你可以在运行时通过传递一个键/值对数组来设置配置变量。然而,请注意,此函数仅影响当前请求的配置值,并且不会更新你的实际配置值:
config(['app.debug' => true]);上下文()context 函数从当前 上下文 获取值。你也可以提供一个默认值,如果上下文键不存在,将返回该默认值:
$value = context('trace_id');
$value = context('trace_id', $default);您可以设置上下文值,通过传递一个键/值对数组:
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);cookie()该 cookie 函数创建了一个新的 cookie 实例:
$cookie = cookie('name', 'value', $minutes);csrf_field()csrf_field 函数会生成一个包含 CSRF token 值的 HTML hidden 输入字段。例如,使用 Blade 语法:
{{ csrf_field() }}csrf_token()这 csrf_token 函数获取当前 CSRF 令牌的值:
$token = csrf_token();解密()该 decrypt 函数 解密 给定值。你可以使用此函数来替代 Crypt 门面:
$password = decrypt($value);对于 decrypt 的逆运算,请参阅 加密 函数。
dd()dd 函数转储给定的变量并结束脚本的执行:
dd($value);
dd($value1, $value2, $value3, ...);如果你不想停止你的脚本的执行, 请使用 dump 函数代替。
分派()该 dispatch 函数会将给定的 任务 推送到 Laravel 任务队列:
dispatch(new App\Jobs\SendEmails);dispatch_sync()dispatch_sync 函数将给定任务推送到 同步 队列,以便立即处理:
dispatch_sync(new App\Jobs\SendEmails);dump()该 dump 函数转储给定的变量:
dump($value);
dump($value1, $value2, $value3, ...);如果想在转储变量后停止执行脚本,请改用 dd 函数。
加密()此 encrypt 函数会 加密 给定值。您可以将此函数用作 Crypt 门面的替代方案:
$secret = encrypt('my-secret-value');对于 encrypt 的逆操作,请参见 解密 函数。
env()该env函数获取一个环境变量的值或返回一个默认值:
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');[!WARNING]
如果你在部署过程中执行了config:cache命令,你应该确保你只从你的配置文件中调用env函数。一旦配置被缓存,.env文件将不会被加载,并且所有对env函数的调用将返回外部环境变量,例如服务器级别或系统级别的环境变量或null。
事件()该 event 函数将给定的 event 调度给其监听器:
event(new UserRegistered($user));fake()fake 函数从容器中解析一个 Faker 单例,这在模型工厂、数据库填充、测试和视图原型设计中创建伪造数据时非常有用:
@for ($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor默认情况下,fake 函数将使用你的 config/app.php 配置中的 app.faker_locale 配置选项。通常,此配置选项通过 APP_FAKER_LOCALE 环境变量进行设置。你也可以通过将其传递给 fake 函数来指定区域设置。每个区域设置将解析一个独立的单例:
fake('nl_NL')->name()filled()filled 函数确定给定值是否不为“空白”:
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false对于 filled 的逆运算,请参阅 空白 函数。
信息()info 函数会将信息写入到您的应用程序的 日志:
info('Some helpful information!');上下文数据数组也可以传递给该函数:
info('User login attempt failed.', ['id' => $user->id]);literal()该 literal 函数 创建一个新的 stdClass 实例 使用给定的命名参数作为属性:
$obj = literal(
name: 'Joe',
languages: ['PHP', 'Ruby'],
);
$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']logger()该 logger 函数可用于写入一个 debug 级别消息到 日志:
logger('Debug message');上下文数据数组也可以传递给函数:
logger('User has logged in.', ['id' => $user->id]);一个 日志记录器 实例将被返回,如果没有向该函数传递任何值:
logger()->error('You are not allowed here.');method_field()method_field 函数生成一个 HTML hidden 输入字段,其中包含表单 HTTP 动词的模拟值。 例如,使用 Blade 语法:
<form method="POST">
{{ method_field('DELETE') }}
</form>now()now 函数创建一个新的 Illuminate\Support\Carbon 实例用于表示当前时间:
$now = now();旧()该 old 函数 获取 一个 旧输入 值 已闪存 到 会话中:
$value = old('value');
$value = old('value', 'default');由于作为 old 函数的第二个参数提供的“默认值”通常是 Eloquent 模型的一个属性,Laravel 允许你直接将整个 Eloquent 模型作为 old 函数的第二个参数传递。这样做时,Laravel 将会假定提供给 old 函数的第一个参数是应被视为“默认值”的 Eloquent 属性的名称:
{{ old('name', $user->name) }}
// Is equivalent to...
{{ old('name', $user) }}once()此 once 函数执行给定的回调,并在请求期间将结果缓存在内存中。任何后续使用相同回调对 once 函数的调用,都将返回先前缓存的结果:
function random(): int
{
return once(function () {
return random_int(1, 1000);
});
}
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)当 once 函数从对象实例内部执行时,缓存结果将独属于该对象实例:
<?php
class NumberService
{
public function all(): array
{
return once(fn () => [1, 2, 3]);
}
}
$service = new NumberService;
$service->all();
$service->all(); // (cached result)
$secondService = new NumberService;
$secondService->all();
$secondService->all(); // (cached result)该 optional 函数接受任何参数,并允许您访问该对象的属性或调用其方法. 如果给定对象为 null, 属性和方法将返回 null 而不是引发错误:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}该 optional 函数也接受一个闭包作为其第二个参数。如果作为第一个参数提供的值不为 null,则该闭包将被调用:
return optional(User::find($id), function (User $user) {
return $user->name;
});policy()该policy方法检索一个策略实例,用于给定类:
$policy = policy(App\Models\User::class);redirect()该redirect函数返回一个 [重定向 HTTP 响应](/docs/laravel/12.x/zh-cn/responses#redirects),或在不带任何参数调用的情况下返回重定向器实例:
return redirect($to = null, $status = 302, $headers = [], $secure = null);
return redirect('/home');
return redirect()->route('route.name');report()report 函数将使用您的 异常处理器 报告异常:
report($e);report 函数也接受一个字符串作为参数. 当一个字符串被传递给该函数时, 该函数将创建一个异常, 并将该字符串作为其消息:
report('Something went wrong.');report_if()该 report_if 函数将使用您的 异常处理器 报告异常 如果给定的布尔表达式评估结果为 true:`
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');report_unless()report_unless 函数将使用你的 异常处理器 报告一个异常,如果一个给定的布尔表达式评估为 false:
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');request()该 request 函数返回当前的 请求 实例或从当前请求中获取输入字段的值:
$request = request();
$value = request('key', $default);rescue()该 rescue 函数执行给定的闭包并捕获在其执行过程中发生的任何异常。所有捕获到的异常都将被发送到您的 异常处理器; 然而,该请求将继续处理:
return rescue(function () {
return $this->method();
});您还可以向 rescue 函数传递第二个参数。此参数将是“默认”值,如果执行闭包时发生异常,应返回此值:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});一个 report 参数可以提供给 rescue 函数,以确定异常是否应该通过 report 函数进行报告:
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});解析()该 resolve 函数使用 服务容器 将给定的类或接口名称解析为一个实例:
$api = resolve('HelpSpot\API');响应()该 response 函数创建 响应 实例或获取响应工厂的实例:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);重试()retry 函数尝试执行给定的回调,直到达到给定的最大尝试次数阈值。如果回调不抛出异常,其返回值将被返回。如果回调抛出异常,它将自动重试。如果超过最大尝试次数,该异常将被抛出:
return retry(5, function () {
// Attempt 5 times while resting 100ms between attempts...
}, 100);如果您想手动计算每次尝试之间休眠的毫秒数,您可以将一个闭包作为第三个参数传递给 retry 函数:
use Exception;
return retry(5, function () {
// ...
}, function (int $attempt, Exception $exception) {
return $attempt * 100;
});为方便起见,您可以将一个数组作为第一个参数提供给 retry 函数。此数组将用于确定在后续尝试之间休眠多少毫秒:
return retry([100, 200], function () {
// Sleep for 100ms on first retry, 200ms on second retry...
});若要仅在特定条件下重试,您可以将一个闭包作为第四个参数传递给 retry 函数:
use App\Exceptions\TemporaryException;
use Exception;
return retry(5, function () {
// ...
}, 100, function (Exception $exception) {
return $exception instanceof TemporaryException;
});session()该 session 函数可用于获取或设置 会话 值:
$value = session('key');您可以通过向函数传递一个键/值对数组来设置值:
session(['chairs' => 7, 'instruments' => 3]);如果未向函数传递任何值,会话存储将被返回:
$value = session()->get('key');
session()->put('key', $value);tap()tap 函数接受两个参数:一个任意的 $value 和一个闭包。$value 将被传递给闭包,然后由 tap 函数返回。闭包的返回值是无关紧要的:
$user = tap(User::first(), function (User $user) {
$user->name = 'Taylor';
$user->save();
});如果没有闭包传递给 tap 函数,你可以在给定的 $value 上调用任何方法。你所调用的方法的返回值将始终是 $value,无论该方法在其定义中实际返回什么。例如,Eloquent 的 update 方法通常返回一个整数。然而,我们可以通过将 update 方法调用通过 tap 函数进行链式调用,来强制该方法返回模型本身:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);要为一个类添加 tap 方法,你可以为该类添加 Illuminate\Support\Traits\Tappable trait。该 trait 的 tap 方法接受一个闭包作为其唯一的参数。对象实例本身将被传递给该闭包,然后由 tap 方法返回:
return $user->tap(function (User $user) {
// ...
});throw_if()throw_if 函数在给定布尔表达式求值为 true 时抛出给定异常:
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 时抛出给定异常:
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);今天()today 函数创建一个新的 Illuminate\Support\Carbon 实例用于当前日期:
$today = today();特性递归使用() trait_uses_recursive函数返回一个 trait 使用的所有 trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);转换()该 transform 函数对给定值执行闭包,如果该值不是 空白 然后返回该闭包的返回值:
$callback = function (int $value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10一个默认值或闭包可以作为第三个参数传递给函数。如果给定值为空,则会返回此值:
$result = transform(null, $callback, 'The value is blank');
// The value is blank验证器()validator 函数使用给定的参数创建一个新的 验证器 实例。您可以将其作为 Validator 外观的替代方案:
$validator = validator($data, $rules, $messages);value()该 value 函数返回提供给它的值。然而,如果你向该函数传递一个闭包,该闭包将被执行,其返回的值将被返回:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false额外参数可以传递给 value 函数。如果第一个参数是一个闭包,那么这些额外参数将作为参数传递给该闭包,否则它们将被忽略:
$result = value(function (string $name) {
return $name;
}, 'Taylor');
// 'Taylor'view()view 函数获取一个 [视图](/docs/laravel/12.x/zh-cn/views) 实例:
return view('auth.login');with()该 with 函数返回其接收到的值。如果将一个闭包作为第二个参数传递给该函数,该闭包将被执行,并且其返回值将被返回:
$callback = function (mixed $value) {
return is_numeric($value) ? $value * 2 : 0;
};
$result = with(5, $callback);
// 10
$result = with(null, $callback);
// 0
$result = with(5, null);
// 5when()when 函数在给定条件评估为 true 时,返回传入的值。否则,返回 null。如果将闭包作为第二个参数传递给该函数,该闭包将被执行并返回其返回值:
$value = when(true, 'Hello World');
$value = when(true, fn () => 'Hello World');这个 when 函数主要用于有条件地渲染 HTML 属性:
<div {!! when($condition, 'wire:poll="calculate"') !!}>
...
</div>有时,您可能希望快速测试应用程序某些部分的性能。在这种情况下,您可以使用 Benchmark 支持类来测量给定回调完成所需的毫秒数:
<?php
use App\Models\User;
use Illuminate\Support\Benchmark;
Benchmark::dd(fn () => User::find(1)); // 0.1 ms
Benchmark::dd([
'Scenario 1' => fn () => User::count(), // 0.5 ms
'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);默认情况下,给定的回调将会执行一次(一次迭代),并且它们的持续时间将会在浏览器 / 控制台中显示。
要多次调用回调,你可以将回调应被调用的迭代次数指定为方法的第二个参数。当多次执行回调时,Benchmark 类将返回在所有迭代中执行回调所花费的平均毫秒数:
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms有时,你可能希望对回调的执行进行基准测试,同时仍然获取回调返回的值。该 value 方法将返回一个元组,其中包含回调返回的值和执行回调所花费的毫秒数:
[$count, $duration] = Benchmark::value(fn () => User::count());Laravel 包含 Carbon, 一个强大的日期和时间操作库。要创建一个新的 Carbon 实例,你可以调用 now 函数。此函数在你的 Laravel 应用程序中全局可用:
$now = now();或者,您可以使用 Illuminate\Support\Carbon 类创建一个新的 Carbon 实例:
use Illuminate\Support\Carbon;
$now = Carbon::now();有关 Carbon 及其功能的深入讨论,请查阅官方 Carbon 文档.
尽管 Laravel 的队列任务允许你将任务排队进行后台处理,但有时你可能有一些简单的任务,希望在无需配置或维护长时间运行的队列工作器的情况下推迟处理。
延迟函数允许你将闭包的执行延迟到 HTTP 响应发送给用户之后,这能让你的应用程序感觉快速且响应灵敏。要延迟闭包的执行,只需将闭包传递给 Illuminate\Support\defer 函数:
use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;
Route::post('/orders', function (Request $request) {
// Create order...
defer(fn () => Metrics::reportOrder($order));
return $order;
});默认情况下,延迟函数仅在从中调用 Illuminate\Support\defer 的 HTTP 响应、Artisan 命令或队列作业成功完成时才会执行。这意味着如果请求导致 4xx 或 5xx HTTP 响应,延迟函数将不会执行。如果您希望某个延迟函数总是执行,您可以将 always 方法链式调用到您的延迟函数上:
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 函数提供第二个参数:
defer(fn () => Metrics::report(), 'reportMetrics');
defer()->forget('reportMetrics');编写测试时,禁用延迟函数可能很有用。你可以在测试中调用 withoutDefer 以指示 Laravel 立即调用所有延迟函数:
test('without defer', function () {
$this->withoutDefer();
// ...
});use Tests\TestCase;
class ExampleTest extends TestCase
{
public function test_without_defer(): void
{
$this->withoutDefer();
// ...
}
}如果您想禁用测试用例中所有测试的延迟函数,您可以在您的基础 TestCase 类上的 setUp 方法中调用 withoutDefer 方法:
<?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 类可用于基于一组给定的概率来执行回调。这在以下情况尤其有用:当你只想针对你传入请求的某个百分比来执行代码时:
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();您可以将 Laravel 的 lottery 类与其他 Laravel 功能结合使用。例如,您可能希望只向异常处理程序报告一小部分慢查询。而且,由于 lottery 类是可调用的,我们可以将该类的一个实例传递给任何接受可调用对象的方法:
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 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 门面提供了一种便捷的方式,来“管道化”给定的输入,使其经过一系列可调用类、闭包或可调用对象,让每个类都有机会检查或修改该输入,并调用管道中的下一个可调用对象:
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 的 服务容器 进行实例化,允许将依赖注入到可调用类中:
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->thenReturn();该 withinTransaction 方法可以在管道上调用,以自动将管道的所有步骤封装在一个单一的数据库事务中:
$user = Pipeline::send($user)
->withinTransaction()
->through([
ProcessOrder::class,
TransferFunds::class,
UpdateInventory::class,
])
->thenReturn();Laravel 的 Sleep 类是一个轻量级封装,用于封装 PHP 原生的 sleep 和 usleep 函数,在提供更高可测试性的同时,也暴露出一个方便开发者使用的 API,用于处理时间:
use Illuminate\Support\Sleep;
$waiting = true;
while ($waiting) {
Sleep::for(1)->second();
$waiting = /* ... */;
}Sleep类 提供了多种方法,让您能够处理不同的时间单位:
// 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()->addMinute());
// Alias of PHP's native "sleep" function...
Sleep::sleep(2);
// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);为了方便地组合时间单位,您可以使用 and 方法:
Sleep::for(1)->second()->and(10)->milliseconds();当测试使用 Sleep 类或 PHP 原生 sleep 函数的代码时, 你的测试将暂停执行。 正如你可能预料的那样, 这会使你的测试套件明显变慢。 例如, 假设你正在测试以下代码:
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}通常,测试这段代码需要至少一秒. 幸运的是,Sleep 类允许我们"模拟"睡眠,这样我们的测试套件就能保持快速:
it('waits until ready', function () {
Sleep::fake();
// ...
});public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}在模拟 Sleep 类时,实际的执行暂停会被绕过,从而使测试速度大幅提升。
一旦 Sleep 类被伪造,就可以对预期发生的“休眠”进行断言。为了说明这一点,假设我们正在测试的代码会暂停执行三次,每次暂停的时间递增一秒。使用 assertSequence 方法,我们可以断言我们的代码“休眠”了适当的时间,同时保持测试的快速性:
it('checks if ready three times', function () {
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}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 类还提供各种其他断言,您可以在测试时使用:
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 的 时间操作辅助函数 来根据每次睡眠的持续时间立即推进时间:
use Carbon\CarbonInterval as Duration;
$this->freezeTime();
Sleep::fake();
Sleep::whenFakingSleep(function (Duration $duration) {
// Progress time when faking sleep...
$this->travel($duration->totalMilliseconds)->milliseconds();
});随着时间推进是一个常见需求,fake 方法接受一个 syncWithCarbon 参数,以在测试中休眠时保持 Carbon 同步:
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second agoLaravel 在暂停执行时,内部会使用 Sleep 类。例如,retry 辅助函数在休眠时使用 Sleep 类,从而在使用该辅助函数时提高了可测试性。
Laravel 的 Timebox 类确保给定的回调始终花费固定的时间来执行,即使其实际执行提前完成。这对于加密操作和用户身份验证检查尤其有用,其中攻击者可能会利用执行时间的变化来推断敏感信息。
如果执行超出固定时长,Timebox 无效。开发者需要选择足够长的时间作为固定时长,以应对最坏情况。
call 方法接受一个闭包和一个以微秒为单位的时间限制,然后执行该闭包并等待直到达到时间限制:
use Illuminate\Support\Timebox;
(new Timebox)->call(function ($timebox) {
// ...
}, microseconds: 10000);如果在闭包中抛出异常,此类将遵循定义的延迟,并在延迟后重新抛出该异常。
Laravel 的 Uri 类提供了一个方便且流畅的接口,用于创建和操作 URI. 此类封装了底层 League URI 包提供的功能,并与 Laravel 的路由系统无缝集成.
您可以使用静态方法轻松地创建一个 Uri 实例:
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()->addMinutes(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 实例,你就可以流畅地修改它:
$uri = Uri::of('https://example.com')
->withScheme('http')
->withHost('test.com')
->withPort(8000)
->withPath('/users')
->withQuery(['page' => 2])
->withFragment('section-1');Uri 类还允许您轻松检查底层 URI 的各个组件:
$scheme = $uri->scheme();
$host = $uri->host();
$port = $uri->port();
$path = $uri->path();
$segments = $uri->pathSegments();
$query = $uri->query();
$fragment = $uri->fragment();Uri 类提供了几种方法,可用于操作 URI 的查询字符串。 withQuery 方法可用于将额外的查询字符串参数合并到现有查询字符串中:
$uri = $uri->withQuery(['sort' => 'name']);withQueryIfMissing 方法可用于将额外的查询字符串参数合并到现有查询字符串中,如果给定键在查询字符串中尚不存在:
$uri = $uri->withQueryIfMissing(['page' => 1]);replaceQuery 方法可用于完全替换现有的查询字符串为一个新的:
$uri = $uri->replaceQuery(['page' => 1]);该 pushOntoQuery 方法可用于将额外参数推入具有数组值的查询字符串参数:
$uri = $uri->pushOntoQuery('filter', ['active', 'pending']);withoutQuery 方法可用于从查询字符串中移除参数:
$uri = $uri->withoutQuery(['page']);该 redirect 方法可用于生成一个 RedirectResponse 实例到给定的 URI:
$uri = Uri::of('https://example.com');
return $uri->redirect();或者,您也可以直接从路由或控制器动作中返回 Uri 实例,这将自动生成一个重定向响应到返回的 URI:
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Uri;
Route::get('/redirect', function () {
return Uri::to('/index')
->withQuery(['sort' => 'name']);
});