辅助函数

Laravel 中文文档 / 综合话题

辅助函数

简介

Laravel 包含各种各样的 PHP 全局辅助函数。框架本身也是用了很多这些函数;同样,如果您觉得方便,也可以在应用中自由使用它们。

可用的函数

数组 & 对象

array_add
array_collapse
array_divide
array_dot
array_except
array_first
array_flatten
array_forget
array_get
array_has
array_last
array_only
array_pluck
array_prepend
array_pull
array_random
array_set
array_sort
array_sort_recursive
array_where
array_wrap
data_fill
data_get
data_set
head
last

路径

app_path
base_path
config_path
database_path
mix
public_path
resource_path
storage_path

字符串

__
camel_case
class_basename
e
ends_with
kebab_case
preg_replace_array
snake_case
starts_with
str_after
str_before
str_contains
str_finish
str_is
str_limit
Str::orderedUuid
str_plural
str_random
str_replace_array
str_replace_first
str_replace_last
str_singular
str_slug
str_start
studly_case
title_case
trans
trans_choice
Str::uuid

URL

action
asset
secure_asset
route
secure_url
url

其它

abort
abort_if
abort_unless
app
auth
back
bcrypt
blank
broadcast
cache
class_uses_recursive
collect
config
cookie
csrf_field
csrf_token
dd
decrypt
dispatch
dispatch_now
dump
encrypt
env
event
factory
filled
info
logger
method_field
now
old
optional
policy
redirect
report
request
rescue
resolve
response
retry
session
tap
today
throw_if
throw_unless
trait_uses_recursive
transform
validator
value
view
with

函数列表

数组 & 对象

array_add()

array_add 函数会在给定键在数组中不存在时,将给定键/值对添加到数组:

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

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

array_collapse()

array_collapse 函数将数组中的数组展开到一个数组中:

$array = array_collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

array_divide()

array_divide 函数返回两个数组,一个包含给定数组的键,另一个包含给定数组的值:

[$keys, $values] = array_divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

array_dot()

array_dot 函数使用「点」连接符将多维数组按指定深度平铺成一维数组:

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

$flattened = array_dot($array);

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

array_except()

array_except 函数从数组中移除给定的键/值对:

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

$filtered = array_except($array, ['price']);

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

array_first()

array_first 函数返回数组中通过给定的可信测试的第一个元素:

$array = [100, 200, 300];

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

// 200

还可以将默认值作为第三个参数传递给此函数。如果没有值通过可信测试,将返回此值:

$first = array_first($array, $callback, $default);

array_flatten()

array_flatten 函数将多维数组平铺为一维数组:

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

$flattened = array_flatten($array);

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

array_forget()

array_forget 函数使用「点」连接符从多层嵌套的数组中移除给定键/值对:

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

array_forget($array, 'products.desk');

// ['products' => []]

array_get()

array_get 函数使用「点」连接符从多层嵌套的数组中获取值:

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

$price = array_get($array, 'products.desk.price');

// 100

array_get 函数还接收一个默认值,当指定键找不到时会返回此默认值:

$discount = array_get($array, 'products.desk.discount', 0);

// 0

array_has()

array_has 函数使用「点」连接符检查给定的一项或多项是否存在于数组中:

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

$contains = array_has($array, 'product.name');

// true

$contains = array_has($array, ['product.price', 'product.discount']);

// false

array_last()

array_last 函数返回数值中通过可信测试的最后一个元素:

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

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

// 300

还可以将默认值作为第三个参数传递给此函数。如果没有值通过可信测试,将返回此值:

$last = array_last($array, $callback, $default);

array_only()

array_only 函数仅从给定数组中返回指定键/值对:

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

$slice = array_only($array, ['name', 'price']);

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

array_pluck()

array_pluck 函数从数组中获取指定键的所有值:

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

$names = array_pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

还可以指定结果中使用的键:

$names = array_pluck($array, 'developer.name', 'developer.id');

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

array_prepend()

array_prepend 函数添加一项到数组的开头:

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

$array = array_prepend($array, 'zero');

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

如有需要,可以指定值对应的键:

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

$array = array_prepend($array, 'Desk', 'name');

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

array_pull()

array_pull 函数从数组中返回并移除键/值对:

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

$name = array_pull($array, 'name');

// $name: Desk

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

可以将默认值作为第三个参数传递给此函数。当键不存在时,会返回此默认值:

$value = array_pull($array, $key, $default);

array_random()

array_random 函数从数组中随机返回一个值:

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

$random = array_random($array);

// 4 - (随机获取)

还可以将要返回项数作为可选的第二个参数。注意提供此参数时会返回一个数组,即使只想获取一项:

$items = array_random($array, 2);

// [2, 5] - (随机获取)

array_set()

array_set 函数使用「点」连接符向多层嵌套的数组中设置一个值:

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

array_set($array, 'products.desk.price', 200);

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

array_sort()

array_sort 函数使用数组的值对数组进行排序:

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

$sorted = array_sort($array);

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

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

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

$sorted = array_values(array_sort($array, function ($value) {
    return $value['name'];
}));

/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

array_sort_recursive()

array_sort_recursive 函数对数组进行递归排序,子数组为数字时使用 sort 函数,子数组为关联数组时使用 ksort

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

$sorted = array_sort_recursive($array);

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

array_where()

array_where 函数使用给定闭包过滤数组:

$array = [100, '200', 300, '400', 500];

$filtered = array_where($array, function ($value, $key) {
    return is_string($value);
});

// [1 => '200', 3 => '400']

array_wrap()

array_wrap 函数将给定值包装到数组中。如果给定值已是数组,则不会更改:

$string = 'Laravel';

$array = array_wrap($string);

// ['Laravel']

如果给定值为 null,会返回一个空数组:

$nothing = null;

$array = array_wrap($nothing);

// []

data_fill()

data_fill 函数使用「点」连接符在嵌套的数组或对象中填充缺省值:

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

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

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

data_fill($data, 'products.desk.discount', 10);

// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

此函数也接收星号作为通配符并填充对应的目标:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2'],
    ],
];

data_fill($data, 'products.*.price', 200);

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 100],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

data_get()

data_get 函数使用「点」连接符从嵌套的数组或对象中获取一个值:

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

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

// 100

data_get 函数还接收一个默认值,当指定键找不到时会返回此默认值:

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

// 0

此函数还接收使用星号作为通配符,选取数组或对象的任意键的目标:

$data = [
    'product-one' => ['name' => 'Desk 1', 'price' => 100],
    'product-two' => ['name' => 'Desk 2', 'price' => 150],
];

data_get($data, '*.name');

// ['Desk 1', 'Desk 2'];

data_set()

data_set 函数使用「点」连接符在嵌套的数组或对象中设置一个值:

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

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

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

此函数也接收星号作为通配符并填充对应的目标:

$data = [
    'products' => [
        ['name' => 'Desk 1', 'price' => 100],
        ['name' => 'Desk 2', 'price' => 150],
    ],
];

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

/*
    [
        'products' => [
            ['name' => 'Desk 1', 'price' => 200],
            ['name' => 'Desk 2', 'price' => 200],
        ],
    ]
*/

默认情况下,任何存在的值都会被覆盖。如果希望仅设置不存在的值,可以将 false 作为第三个参数传递:

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

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

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

head()

head 函数返回给定数组的第一个元素:

$array = [100, 200, 300];

$first = head($array);

// 100

last()

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

$array = [100, 200, 300];

$last = last($array);

// 300

路径

app_path()

app_path 函数返回 app 目录的全路径。还可以使用 app_path 函数为相对于应用目录的文件生成全路径:

$path = app_path();

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

base_path()

base_path 函数返回应用根目录的全路径。还可以使用 base_path 函数为相对于应用根目录的文件生成全路径:

$path = base_path();

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

config_path()

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

$path = config_path();

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

database_path()

database_path 函数返回 database 目录的全路径。还可以使用 database_path 函数为数据库目录中的给定文件生成全路径:

$path = database_path();

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

mix()

mix 函数返回一个 Mix 版本控制的文件 的路径:

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

public_path()

public_path 函数返回 public 目录的全路径。还可以使用 public_path 函数为公共目录中的给定文件生成全路径:

$path = public_path();

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

resource_path()

resource_path 函数返回 resources 目录的全路径。还可以使用 resource_path 函数为资源目录中的给定文件生成全路径:

$path = resource_path();

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

storage_path()

storage_path 函数返回 storage 目录的全路径。还可以使用 storage_path 函数为存储目录中的给定文件生成全路径:

$path = storage_path();

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

字符串

__()

__ 函数使用 本地化文件 翻译给定翻译字符串或翻译键:

echo __('Welcome to our application');

echo __('messages.welcome');

如果指定的翻译字符串或键不存在,__ 函数将返回给定值。因此,在上述示例中,如果翻译键不存在,__ 函数会返回 messages.welcome

camel_case()

camel_case 函数将给定字符串转换为驼峰命名法 camelCase

$converted = camel_case('foo_bar');

// fooBar

class_basename()

class_basename 返回给定类移除命名空间后的类名:

$class = class_basename('Foo\Bar\Baz');

// Baz

e()

e 函数运行 PHP 的 htmlspecialchars 函数,并将 double_encode 选项默认设置为 true

echo e('<html>foo</html>');

// <html>foo</html>

ends_with()

ends_with 函数判断字符串是否以给定字符串结尾:

$result = ends_with('This is my name', 'name');

// true

kebab_case()

kebab_case 函数将给定字符串转换为短横线命名法 kebab-case

$converted = kebab_case('fooBar');

// foo-bar

preg_replace_array()

preg_replace_array 函数使用数组在字符串中替换给定规则:

$string = 'The event will take place between :start and :end';

$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

snake_case()

snake_case 函数将给定字符串转换为蛇形命名法 snake_case

$converted = snake_case('fooBar');

// foo_bar

starts_with()

starts_with 函数判断字符串是否以给定字符串起头:

$result = starts_with('This is my name', 'This');

// true

str_after()

str_after 函数返回字符串中给定字符串之后的部分:

$slice = str_after('This is my name', 'This is');

// ' my name'

str_before()

str_before 函数返回字符串中给定字符串之前的部分:

$slice = str_before('This is my name', 'my name');

// 'This is '

str_contains()

str_contains 函数判断字符串中是否包含给定字符串(大小写敏感):

$contains = str_contains('This is my name', 'my');

// true

还可以传递一个数组判断字符串中是否包含任何给定值:

$contains = str_contains('This is my name', ['my', 'foo']);

// true

str_finish()

str_finish 函数会在字符串的末尾不包含给定值时,将给定值添加到字符串末尾:

$adjusted = str_finish('this/string', '/');

// this/string/

$adjusted = str_finish('this/string/', '/');

// this/string/

str_is()

str_is 函数判断字符串是否和给定规则相匹配。可以使用星号作为通配符:

$matches = str_is('foo*', 'foobar');

// true

$matches = str_is('baz*', 'foobar');

// false

str_limit()

str_limit 函数按给定长度截断字符串:

$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20);

// The quick brown fox...

还可以传递第三个参数指定追加到字符串末尾的内容:

$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');

// The quick brown fox (...)

Str::orderedUuid()

Str::orderedUuid 函数生成一个「时间戳优先」的 UUID,可高效地存储在添加索引的数据库字段中:

use Illuminate\Support\Str;

return (string) Str::orderedUuid();

str_plural()

str_plural 函数将字符串转换为复数形式。此函数目前仅支持英文:

$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

还可以提供一个整数作为第二个参数传递给此函数来获取单数或复数字符串:

$plural = str_plural('child', 2);

// children

$plural = str_plural('child', 1);

// child

str_random()

str_random 函数生成指定长度的随机字符串。此函数使用 PHP 的 random_bytes 函数:

$random = str_random(40);

str_replace_array()

str_replace_array 函数使用数组顺序替换字符串中的给定值:

$string = 'The event will take place between ? and ?';

$replaced = str_replace_array('?', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

str_replace_first()

str_replace_first 函数替换字符串中第一个出现的给定值:

$replaced = str_replace_first('the', 'a', 'the quick brown fox jumps over the lazy dog');

// a quick brown fox jumps over the lazy dog

str_replace_last()

str_replace_last 函数替换字符串中最后一个出现的给定值:

$replaced = str_replace_last('the', 'a', 'the quick brown fox jumps over the lazy dog');

// the quick brown fox jumps over a lazy dog

str_singular()

str_singular 函数将字符串转换为单数形式。此函数目前仅支持英文:

$singular = str_singular('cars');

// car

$singular = str_singular('children');

// child

str_slug()

str_slug 函数从指定字符串生成一个 URL 友好的「slug」:

$slug = str_slug('Laravel 5 Framework', '-');

// laravel-5-framework

str_start()

str_start 函数会在字符串不是以给定值起头时,将给定值添加到字符串的开头:

$adjusted = str_start('this/string', '/');

// /this/string

$adjusted = str_start('/this/string', '/');

// /this/string

studly_case()

studly_case 函数将给定字符串转换为首字母大写的驼峰命名法 StudlyCase

$converted = studly_case('foo_bar');

// FooBar

title_case()

title_case 函数将给定字符串转换为首字母大写 Title Case

$converted = title_case('a nice title uses the correct case');

// A Nice Title Uses The Correct Case

trans()

trans 函数使用 本地化文件 翻译给定翻译字符串:

echo trans('messages.welcome');

如果指定的翻译键不存在,trans 函数会返回给定键。因此,在上述示例中,如果翻译键不存在,trans 函数会返回 messages.welcome

trans_choice()

trans_choice 函数使用变量翻译给定翻译键:

echo trans_choice('messages.notifications', $unreadCount);

如果指定的翻译键不存在,trans_choice 函数会返回给定键。因此,在上述示例中,如果翻译键不存在,trans_choice 函数会返回 messages.notifications

Str::uuid()

Str::uuid 函数生成一个 UUID(V4):

use Illuminate\Support\Str;

return (string) Str::uuid();

URL

action()

action 函数为给定控制器操作生成一个 UR。不需要传递控制器的完整命名空间。而是,传递相对于 App\Http\Controllers 命名空间的控制器类名:

$url = action('HomeController@index');

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

如果控制器操作还接收了路由参数,可以将其作为第二个参数传递给此函数:

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

asset()

asset 函数使用当前的请求协议(HTTP 或 HTTPS)为资源生成 URL:

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

secure_asset()

secure_asset 函数使用 HTTPS 为资源生成 URL:

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

route()

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

$url = route('routeName');

如果路由接收参数,可以将其作为第二个参数传递给此函数:

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

默认情况下,route 函数生成一个绝对 URL。如果要生成一个相对 URL,可以将 false 作为第三个参数传递:

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

secure_url()

secure_url 函数为给定路径生成一个全路径的 HTTPS URL:

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

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

url()

url 函数为给定路径生成全路径 URL:

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

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

如果没有提供路径,会返回一个 Illuminate\Routing\UrlGenerator 实例:

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

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

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

其它

abort()

abort 函数抛出一个会被 异常处理器 渲染的 HTTP 异常

abort(403);

还可以提供异常的响应文本和自定义响应头:

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

abort_if()

abort_if 函数会在给定的布尔表达式值为 true 时抛出一个 HTTP 异常:

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

如果需要,还可以指定要访问的看守器实例:

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

back()

back 函数生成一个用户之前访问位置的 HTTP 重定向响应

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

return back();

bcrypt()

bcrypt 函数使用 Bcrypt 对给定值进行 哈希处理。可以代替 Hash Facade 使用:

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

broadcast()

broadcast 函数将给定 事件 广播 到其监听器:

broadcast(new UserRegistered($user));

blank()

blank 函数返回给定值是否为「空」:

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

// true

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

// false

blank 相反的函数,可以参见 filled

cache()

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

$value = cache('key');

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

可以传递一个键/值对数组添加数据到缓存。同时还应该传递缓存的数组的有效分钟数:

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

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

class_uses_recursive()

class_uses_recursive 函数会返回类使用的所有 Trait,包括其父类使用的 Trait:

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

collect()

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

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

config()

config 函数获取 配置 变量的值。可以使用「点」语法 file.option 访问配置值。还可以指定一个配置项不存在时返回的默认值:

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

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

可以传递一个键/值对数组在运行时设置配置变量:

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

cookie()

cookie 函数创建一个新的 Cookie 实例:

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

csrf_field()

csrf_field 函数生成一个包含 CSRF 令牌的 HTML hidden 隐藏域。例如,使用 Blade 语法

{{ csrf_field() }}

csrf_token()

csrf_token 函数获取当前的 CSRF 令牌:

$token = csrf_token();

dd()

dd 函数输出给定变量并终止脚本执行:

dd($value);

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

如果不想终止脚本执行,可以使用 dump 函数代替。

decrypt()

decrypt 函数使用 Laravel 的 加密器 对给定值解密:

$decrypted = decrypt($encrypted_value);

dispatch()

dispatch 函数将给定 任务 添加到 Laravel 的 队列

dispatch(new App\Jobs\SendEmails);

dispatch_now()

dispatch_now 函数立即运行给定 任务 并返回 handle 方法的值:

$result = dispatch_now(new App\Jobs\SendEmails);

dump()

dump 函数输出给定变量:

dump($value);

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

如果要在输出变量后停止脚本执行,可以使用 dd 函数代替。

可以使用 Artisan 命令 dump-server 拦截所有 dump 调用,将对应输出显示到终端窗口而不是浏览器中。

encrypt()

encrypt 函数使用 Laravel 的 加密器 加密给定值:

$encrypted = encrypt($unencrypted_value);

env()

env 函数获取一个 环境变量 或者返回一个默认值:

$env = env('APP_ENV');

// 如果 APP_ENV 未设置,则返回「production」
$env = env('APP_ENV', 'production');

如果部署过程中执行 config:cache 命令,应该确保只在配置文件里调用 env函数。配置缓存后,不会加载 .env 文件,并且所有 env 函数调用都会返回 null

event()

event 函数将给定 事件 分发给其监听器:

event(new UserRegistered($user));

factory()

factory 函数按给定类、名称和数量创建一个模型工厂。可以在 测试数据填充 时使用:

$user = factory(App\User::class)->make();

filled()

filled 函数返回给定值是否不为「空」:

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

// true

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

// false

filled 相反的函数,可以参见 blank

info()

info 函数会写入信息到 日志

info('Some helpful information!');

还可以传递一个上下文数据的数组给此函数:

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

logger()

logger 函数可用于写入调试信息到 日志

logger('Debug message');

还可以传递一个上下文数据的数组给此函数:

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

如果没有给此函数传递任何值,会返回一个 日志 实例:

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

method_field()

method_field 函数生成一个包含 HTTP 请求类型的 HTML hidden 隐藏域。例如,使用 Blade 语法

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

now()

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

$now = now();

old()

old 函数 获取 一个闪存到 Session 中的 旧的输入

$value = old('value');

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

optional()

optional 函数接收任何参数并允许访问此对象的属性或调用其方法。如果给定对象为 null,属性或方法会返回 null 而不会导致错误:

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

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

optional 函数还接收一个闭包作为其第二个参数。如果提供的第一个参数值不为 null,就会运行此闭包:

return optional(User::find($id), function ($user) {
    return new DummyUser;
});

policy()

policy 函数获取给定类的 授权策略

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

redirect()

redirect 函数返回一个 HTTP 重定向响应,或者不带参数时返回一个重定向实例:

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

return redirect('/home');

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

report()

report 函数会使用 异常处理器report 方法报告异常:

report($e);

request()

request 函数返回当前 请求 实例或获取一个输入值:

$request = request();

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

rescue()

rescue 函数执行给定闭包,并捕获在此过程中产生的任何异常。所有捕获的异常都会发送给 异常处理器report 方法;但是,会继续处理请求:

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

还可以传递第二个参数给 rescue 函数。此参数会在执行闭包发生异常后作为「默认」值返回:

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

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

resolve()

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

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

response()

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

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

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

retry()

retry 函数会尝试执行给定回调直到达到最大尝试次数。如果回调没有抛出异常,会返回其返回值。如果回调抛出异常,会自定重试。运行最大尝试次数后,异常将被抛出:

return retry(5, function () {
    // 尝试 5 次,每次间隔 100ms
}, 100);

session()

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

$value = session('key');

可以通过传递键/值对数组给此函数来设置值:

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

如果没有传递值给此函数,会返回 Session 存储:

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

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

tap()

tap 函数接收两个参数:一个任意 $value 和一个闭包。$value 会被传递给闭包,然后通过 tap 函数返回。在闭包中返回值是无效的:

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

    $user->save();
});

如果没有传递闭包给 tap 函数,可以调用任何给定 $value 的方法。无论在调用的方法中定义返回什么,返回值始终会是 $value。例如, Eloquent 的 update 方法通常会返回一个整数。不过,我们可以可以在 tap 函数后链式调用 update 方法来强制返回模型本身:

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

today()

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

$today = today();

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

trait_uses_recursive()

trait_uses_recursive 函数会返回一个 Trait 使用的所有 Trait:

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

transform()

transform 函数会在给定值不为 时,对给定值运行闭包并返回闭包的结果:

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

$result = transform(5, $callback);

// 10

默认值或闭包可以作为第三个参数传递给此函数。如果给定值为空时,会返回该值:

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

// 值为空

validator()

validator 函数会使用给定参数创建一个 验证器 实例。比使用 Validator Facade 更方便:

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

value()

value 函数会返回给定值。但是,如果传递一个闭包给此函数,会在执行闭包后返回其结果:

$result = value(true);

// true

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

// false

view()

view 函数获取一个 视图 实例:

return view('auth.login');

with()

with 函数返回给定值。如果将闭包作为第二个参数传递给此函数,会在执行闭包后返回其结果:

$callback = function ($value) {
    return (is_numeric($value)) ? $value * 2 : 0;
};

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5
  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...