Laravel 5.4 中文文档

简体中文

English

简体中文

English

主题

辅助函数 ​

介绍 ​

Laravel 包含多种全局 "辅助" PHP 函数。许多这些函数被框架本身使用；然而，如果你觉得方便，也可以在自己的应用程序中使用它们。

可用方法 ​

数组 ​

array_addarray_collapsearray_dividearray_dotarray_exceptarray_firstarray_flattenarray_forgetarray_getarray_hasarray_lastarray_onlyarray_pluckarray_prependarray_pullarray_setarray_sortarray_sort_recursivearray_wherearray_wrapheadlast

路径 ​

app_pathbase_pathconfig_pathdatabase_pathmixpublic_pathresource_pathstorage_path

字符串 ​

camel_caseclass_basenameeends_withkebab_casesnake_casestr_limitstarts_withstr_afterstr_containsstr_finishstr_isstr_pluralstr_randomstr_singularstr_slugstudly_casetitle_casetranstrans_choice

URL ​

actionassetsecure_assetroutesecure_urlurl

杂项 ​

abortabort_ifabort_unlessauthbackbcryptcachecollectconfigcsrf_fieldcsrf_tokendddispatchenveventfactoryinfologgermethod_fieldoldredirectrequestresponseretrysessionvalueview

方法列表 ​

数组 ​

array_add() ​

array_add 函数在给定键不存在于数组中时，向数组添加给定的键/值对：

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

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

array_collapse() ​

array_collapse 函数将数组的数组折叠成一个单一数组：

php
$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 函数返回两个数组，一个包含原始数组的键，另一个包含值：

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

// $keys: ['name']

// $values: ['Desk']

array_dot() ​

array_dot 函数将多维数组展平成一个单层数组，使用 "点" 符号表示深度：

php
$array = array_dot(['foo' => ['bar' => 'baz']]);

// ['foo.bar' => 'baz'];

array_except() ​

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

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

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

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

array_first() ​

array_first 函数返回通过给定真值测试的数组的第一个元素：

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

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

// 200

该方法的第三个参数还可以传递一个默认值。如果没有值通过真值测试，将返回此值：

php
$value = array_first($array, $callback, $default);

array_flatten() ​

array_flatten 函数将多维数组展平成一个单层。

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

$array = array_flatten($array);

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

array_forget() ​

array_forget 函数使用 "点" 符号从深度嵌套的数组中移除给定的键/值对：

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

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

// ['products' => []]

array_get() ​

array_get 函数使用 "点" 符号从深度嵌套的数组中检索值：

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

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

// ['price' => 100]

array_get 函数还接受一个默认值，如果找不到特定键，将返回此值：

php
$value = array_get($array, 'names.john', 'default');

array_has() ​

array_has 函数检查给定项或项是否存在于数组中，使用 "点" 符号：

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

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

// true

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

// false

array_last() ​

array_last 函数返回通过给定真值测试的数组的最后一个元素：

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

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

// 300

array_only() ​

array_only 函数将仅返回给定数组中指定的键/值对：

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

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

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

array_pluck() ​

array_pluck 函数将从数组中提取给定的键/值对列表：

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

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

// ['Taylor', 'Abigail'];

你还可以指定希望如何对结果列表进行键控：

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

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

array_prepend() ​

array_prepend 函数将在数组的开头推入一个项目：

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

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

// $array: ['zero', 'one', 'two', 'three', 'four']

array_pull() ​

array_pull 函数返回并移除数组中的键/值对：

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

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

// $name: Desk

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

array_set() ​

array_set 函数使用 "点" 符号在深度嵌套的数组中设置值：

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

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

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

array_sort() ​

array_sort 函数通过给定闭包的结果对数组进行排序：

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

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

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

array_sort_recursive() ​

array_sort_recursive 函数使用 sort 函数递归地对数组进行排序：

php
$array = [
    [
        'Roman',
        'Taylor',
        'Li',
    ],
    [
        'PHP',
        'Ruby',
        'JavaScript',
    ],
];

$array = array_sort_recursive($array);

/*
    [
        [
            'Li',
            'Roman',
            'Taylor',
        ],
        [
            'JavaScript',
            'PHP',
            'Ruby',
        ]
    ];
*/

array_where() ​

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

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

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

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

array_wrap() ​

array_wrap 函数将给定值包装在数组中。如果给定值已经是数组，则不会更改：

php
$string = 'Laravel';

$array = array_wrap($string);

// [0 => 'Laravel']

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

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

$first = head($array);

// 100

last() ​

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

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

$last = last($array);

// 300

路径 ​

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 函数返回应用程序配置目录的完全限定路径：

php
$path = config_path();

database_path() ​

database_path 函数返回应用程序数据库目录的完全限定路径：

php
$path = database_path();

mix() ​

mix 函数获取 版本化 Mix 文件 的路径：

php
mix($file);

public_path() ​

public_path 函数返回 public 目录的完全限定路径：

php
$path = public_path();

resource_path() ​

resource_path 函数返回 resources 目录的完全限定路径。你也可以使用 resource_path 函数生成相对于资源目录的给定文件的完全限定路径：

php
$path = resource_path();

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

storage_path() ​

storage_path 函数返回 storage 目录的完全限定路径。你也可以使用 storage_path 函数生成相对于存储目录的给定文件的完全限定路径：

php
$path = storage_path();

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

字符串 ​

camel_case() ​

camel_case 函数将给定字符串转换为 camelCase：

php
$camel = camel_case('foo_bar');

// fooBar

class_basename() ​

class_basename 返回给定类的类名，并移除类的命名空间：

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

// Baz

e() ​

e 函数运行 PHP 的 htmlspecialchars 函数，并将 double_encode 选项设置为 false：

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

// &lt;html&gt;foo&lt;/html&gt;

ends_with() ​

ends_with 函数确定给定字符串是否以给定值结尾：

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

// true

kebab_case() ​

kebab_case 函数将给定字符串转换为 kebab-case：

php
$value = kebab_case('fooBar');

// foo-bar

snake_case() ​

snake_case 函数将给定字符串转换为 snake_case：

php
$snake = snake_case('fooBar');

// foo_bar

str_limit() ​

str_limit 函数限制字符串中的字符数。该函数接受一个字符串作为第一个参数，最大字符数作为第二个参数：

php
$value = str_limit('The PHP framework for web artisans.', 7);

// The PHP...

starts_with() ​

starts_with 函数确定给定字符串是否以给定值开头：

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

// true

str_after() ​

str_after 函数返回字符串中给定值之后的所有内容：

php
$value = str_after('This is: a test', 'This is:');

// ' a test'

str_contains() ​

str_contains 函数确定给定字符串是否包含给定值：

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

// true

你还可以传递一个值数组，以确定给定字符串是否包含任何值：

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

// true

str_finish() ​

str_finish 函数在字符串末尾添加给定值的单个实例，如果它尚未以该值结尾：

php
$string = str_finish('this/string', '/');
$string2 = str_finish('this/string/', '/');

// this/string/

str_is() ​

str_is 函数确定给定字符串是否与给定模式匹配。星号可用于指示通配符：

php
$value = str_is('foo*', 'foobar');

// true

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

// false

str_plural() ​

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

php
$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

你可以提供一个整数作为函数的第二个参数，以检索字符串的单数或复数形式：

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

// children

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

// child

str_random() ​

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

php
$string = str_random(40);

str_singular() ​

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

php
$singular = str_singular('cars');

// car

str_slug() ​

str_slug 函数从给定字符串生成 URL 友好的 "slug"：

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

// laravel-5-framework

studly_case() ​

studly_case 函数将给定字符串转换为 StudlyCase：

php
$value = studly_case('foo_bar');

// FooBar

title_case() ​

title_case 函数将给定字符串转换为 Title Case：

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

// A Nice Title Uses The Correct Case

trans() ​

trans 函数使用你的 本地化文件 翻译给定的语言行：

php
echo trans('validation.required'):

trans_choice() ​

trans_choice 函数使用屈折翻译给定的语言行：

php
$value = trans_choice('foo.bar', $count);

URL ​

action() ​

action 函数为给定的控制器操作生成 URL。你不需要传递控制器的完整命名空间。相反，传递相对于 App\Http\Controllers 命名空间的控制器类名：

php
$url = action('HomeController@getIndex');

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

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

asset() ​

使用请求的当前方案（HTTP 或 HTTPS）为资产生成 URL：

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

secure_asset() ​

使用 HTTPS 为资产生成 URL：

php
echo secure_asset('foo/bar.zip');

route() ​

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

php
$url = route('routeName');

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

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

默认情况下，route 函数生成绝对 URL。如果你希望生成相对 URL，可以将 false 作为第三个参数传递：

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

secure_url() ​

secure_url 函数生成给定路径的完全限定 HTTPS URL：

php
echo secure_url('user/profile');

echo secure_url('user/profile', [1]);

url() ​

url 函数生成给定路径的完全限定 URL：

php
echo url('user/profile');

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

如果未提供路径，将返回 Illuminate\Routing\UrlGenerator 实例：

php
echo url()->current();
echo url()->full();
echo url()->previous();

杂项 ​

abort() ​

abort 函数抛出一个 HTTP 异常，该异常将由异常处理程序呈现：

php
abort(401);

你还可以提供异常的响应文本：

php
abort(401, 'Unauthorized.');

abort_if() ​

abort_if 函数在给定布尔表达式计算为 true 时抛出 HTTP 异常：

php
abort_if(! Auth::user()->isAdmin(), 403);

abort_unless() ​

abort_unless 函数在给定布尔表达式计算为 false 时抛出 HTTP 异常：

php
abort_unless(Auth::user()->isAdmin(), 403);

auth() ​

auth 函数返回一个认证器实例。你可以使用它来代替 Auth facade 以方便使用：

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

back() ​

back() 函数生成一个重定向响应到用户的上一个位置：

php
return back();

bcrypt() ​

bcrypt 函数使用 Bcrypt 哈希给定值。你可以将其用作 Hash facade 的替代品：

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

cache() ​

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

php
$value = cache('key');

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

你可以通过将键/值对数组传递给函数来将项目添加到缓存中。你还应该传递缓存值应被视为有效的分钟数或持续时间：

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

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

collect() ​

collect 函数从给定数组创建一个 集合 实例：

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

config() ​

config 函数获取配置变量的值。配置值可以使用 "点" 语法访问，其中包括文件名和你希望访问的选项。可以指定一个默认值，如果配置选项不存在，将返回该值：

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

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

config 辅助函数还可以通过传递键/值对数组在运行时设置配置变量：

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

csrf_field() ​

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

php
{{ csrf_field() }}

csrf_token() ​

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

php
$token = csrf_token();

dd() ​

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

php
dd($value);

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

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

php
dump($value);

dispatch() ​

dispatch 函数将新作业推送到 Laravel 作业队列：

php
dispatch(new App\Jobs\SendEmails);

env() ​

env 函数获取环境变量的值或返回默认值：

php
$env = env('APP_ENV');

// 如果变量不存在，则返回默认值...
$env = env('APP_ENV', 'production');

event() ​

event 函数将给定的 事件 分派给其监听器：

php
event(new UserRegistered($user));

factory() ​

factory 函数为给定类、名称和数量创建一个模型工厂构建器。它可以在 测试 或 播种 时使用：

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

info() ​

info 函数将信息写入日志：

php
info('Some helpful information!');

还可以将上下文数据数组传递给函数：

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

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

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

old() ​

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

php
$value = old('value');

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

redirect() ​

redirect 函数返回一个重定向 HTTP 响应，或者如果没有参数调用，则返回重定向器实例：

php
return redirect('/home');

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

request() ​

request 函数返回当前 请求 实例或获取输入项：

php
$request = request();

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

response() ​

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

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

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

retry() ​

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

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

session() ​

session 函数可用于获取或设置会话值：

php
$value = session('key');

你可以通过将键/值对数组传递给函数来设置值：

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

如果没有传递值给函数，将返回会话存储：

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

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

value() ​

value 函数的行为将简单地返回给定的值。然而，如果你将 Closure 传递给函数，将执行 Closure，然后返回其结果：

php
$value = value(function () {
    return 'bar';
});

view() ​

view 函数检索一个 视图 实例：

php
return view('auth.login');

版权所有 © 2024-2025 laravel.wiki