辅助函数

Created 6 years ago by 学院君, Updated 6 years ago Revision #1 13271 views 4 likes 1 collects

简介

Laravel 自带了一系列 PHP 辅助函数，很多被框架自身使用，如果你觉得方便的话也可以在代码中使用它们。

方法列表

数组 & 对象

Arr::add()

Arr::add方法添加给定键值对到数组 —— 如果给定键不存在或对应值为空的话：

xxxxxxxxxx
 
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::collapse()

Arr::collapse() 方法将多个数组合并成一个：

xxxxxxxxxx
 
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::divide()

Arr::divide 方法返回两个数组，一个包含原数组的所有键，另外一个包含原数组的所有值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
[$keys, $values] = Arr::divide(['name' => 'Desk']);
​
// $keys: ['name']
​
// $values: ['Desk']

Arr::dot()

Arr::dot 方法使用「.」号将将多维数组转化为一维数组：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['products' => ['desk' => ['price' => 100]]];
​
$flattened = Arr::dot($array);
​
// ['products.desk.price' => 100]

Arr::except()

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

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['name' => 'Desk', 'price' => 100];
​
$filtered = Arr::except($array, ['price']);
​
// ['name' => 'Desk']

Arr::first()

Arr::first 方法返回通过测试数组的第一个元素：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [100, 200, 300];
​
$first = Arr::first($array, function ($value, $key) {
    return $value >= 150;
});
​
// 200

默认值可以作为第三个参数传递给该方法，如果没有值通过测试的话返回默认值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$first = Arr::first($array, $callback, $default);

Arr::flatten()

Arr::flatten 方法将多维数组转化为一维数组：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
​
$flattened = Arr::flatten($array);
​
// ['Joe', 'PHP', 'Ruby']

Arr::forget()

Arr::forget 方法使用「.」号从嵌套数组中移除给定键值对：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['products' => ['desk' => ['price' => 100]]];
​
Arr::forget($array, 'products.desk');
​
// ['products' => []]

Arr::get()

Arr::get 方法使用「.」号从嵌套数组中获取值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['products' => ['desk' => ['price' => 100]]];
​
$price = Arr::get($array, 'products.desk.price');
​
// 100

Arr::get 方法还接收一个默认值，如果指定键不存在的话则返回该默认值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$discount = Arr::get($array, 'products.desk.discount', 0);
​
// 0

Arr::has()

Arr::has 方法使用「.」检查给定数据项是否在数组中存在：

xxxxxxxxxx
 
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::last()

Arr::last 方法返回通过过滤数组的最后一个元素：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [100, 200, 300, 110];
​
$last = Arr::last($array, function ($value, $key) {
    return $value >= 150;
});
​
// 300

我们可以传递一个默认值作为第三个参数到该方法，如果没有值通过真理测试的话该默认值被返回：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$last = Arr::last($array, $callback, $default);

Arr::only()

Arr::only 方法只从给定数组中返回指定键值对：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
​
$slice = Arr::only($array, ['name', 'price']);
​
// ['name' => 'Desk', 'price' => 100]

Arr::pluck()

Arr::pluck 方法从数组中返回给定键对应的键值对列表：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];
​
$names = Arr::pluck($array, 'developer.name');
​
// ['Taylor', 'Abigail']

你还可以指定返回结果的键：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$names = Arr::pluck($array, 'developer.name', 'developer.id');
​
// [1 => 'Taylor', 2 => 'Abigail']

Arr::prepend()

Arr::prepend 方法将数据项推入数组开头：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['one', 'two', 'three', 'four'];
​
$array = Arr::prepend($array, 'zero');
​
// ['zero', 'one', 'two', 'three', 'four']

如果需要的话还可以指定用于该值的键：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['price' => 100];
​
$array = Arr::prepend($array, 'Desk', 'name');
​
// ['name' => 'Desk', 'price' => 100]

Arr::pull()

Arr::pull 方法从数组中返回并移除键值对：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['name' => 'Desk', 'price' => 100];
​
$name = Arr::pull($array, 'name');
​
// $name: Desk
​
// $array: ['price' => 100]

我们还可以传递默认值作为第三个参数到该方法，如果指定键不存在的话返回该值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$value = Arr::pull($array, $key, $default);

Arr::random()

Arr::random 方法从数组中返回随机值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [1, 2, 3, 4, 5];
​
$random = Arr::random($array);
​
// 4 - (retrieved randomly)

还可以指定返回的数据项数目作为可选的第二个参数，需要注意的是提供这个参数会返回一个数组，即使只返回一个数据项：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$items = Arr::random($array, 2);
​
// [2, 5] - (retrieved randomly)

Arr::set()

Arr::set 方法用于在嵌套数组中使用「.」号设置值：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['products' => ['desk' => ['price' => 100]]];
​
Arr::set($array, 'products.desk.price', 200);
​
// ['products' => ['desk' => ['price' => 200]]]

Arr::sort()

Arr::sort 方法通过值对数组进行排序：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = ['Desk', 'Table', 'Chair'];
​
$sorted = Arr::sort($array);
​
// ['Chair', 'Desk', 'Table']

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

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [
    ['name' => 'Desk'],
    ['name' => 'Table'],
    ['name' => 'Chair'],
];
​
$sorted = array_values(Arr::sort($array, function ($value) {
    return $value['name'];
}));
​
/*
    [
        ['name' => 'Chair'],
        ['name' => 'Desk'],
        ['name' => 'Table'],
    ]
*/

Arr::sortRecursive()

Arr::sortRecursive 方法使用 sort 函数对索引数组、ksort 函数对关联数组进行递归排序：

xxxxxxxxxx
 
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::where()

Arr::where 方法使用给定闭包对数组进行过滤：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$array = [100, '200', 300, '400', 500];
​
$filtered = Arr::where($array, function ($value, $key) {
    return is_string($value);
});
​
// [1 => '200', 3 => '400']

Arr::wrap()

Arr::wrap 方法将给定值包裹到数组中，如果给定值已经是数组则保持不变：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$string = 'Laravel';
​
$array = Arr::wrap($string);
​
// ['Laravel']

如果给定值是空的，则返回一个空数组：

xxxxxxxxxx
 
use Illuminate\Support\Arr;
​
$nothing = null;
​
$array = Arr::wrap($nothing);
​
// []

data_fill()

data_fill 函数使用「.」号以嵌套数组或对象的方式设置缺失值：

xxxxxxxxxx
 
$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]]]

该函数还接收「*」号作为通配符并填充相应目标：

xxxxxxxxxx
 
$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 函数使用「.」号从嵌套数组或对象中获取值：

xxxxxxxxxx
 
$data = ['products' => ['desk' => ['price' => 100]]];
​
$price = data_get($data, 'products.desk.price');
​
// 100

data_get 函数还接收默认值，以便指定键不存在的情况下返回：

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

data_set()

data_set 函数使用「.」号设置嵌套数组或对象的值：

xxxxxxxxxx
 
$data = ['products' => ['desk' => ['price' => 100]]];
​
data_set($data, 'products.desk.price', 200);
​
// ['products' => ['desk' => ['price' => 200]]]

该函数还接收通配符然后设置相应的目标值：

xxxxxxxxxx
 
$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 作为第三个参数：

xxxxxxxxxx
 
$data = ['products' => ['desk' => ['price' => 100]]];
​
data_set($data, 'products.desk.price', 200, false);
​
// ['products' => ['desk' => ['price' => 100]]]

head()

head 函数只是简单返回给定数组的第一个元素：

xxxxxxxxxx
 
$array = [100, 200, 300];
​
$first = head($array);
​
// 100

last()

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

xxxxxxxxxx
 
$array = [100, 200, 300];
​
$last = last($array);
​
// 300

路径函数

app_path()

app_path 函数返回 app 目录的绝对路径，你还可以使用 app_path 函数为相对于 app 目录的给定文件生成绝对路径：

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

base_path()

base_path 函数返回项目根目录的绝对路径，你还可以使用 base_path 函数为相对于应用根目录的给定文件生成绝对路径：

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

config_path()

config_path 函数返回应用配置目录 config 的绝对路径，还可以使用 config_path 函数在应用配置目录内为给定文件生成完整路径：

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

database_path()

database_path 函数返回应用数据库目录 database 的完整路径，还可以使用 database_path 函数在数据库目录内为给定文件生成完整路径：

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

mix()

mix 函数返回带有版本号的Mix文件路径：

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

public_path()

public_path 函数返回 public 目录的绝对路径，还可以使用 public_path 函数在 public 目录下为给定文件生成完整路径：

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

resource_path()

resource_path 函数返回 resources 目录的绝对路径，还可以使用 resources 函数在 resources 目录下为给定文件生成完整路径：

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

storage_path()

storage_path 函数返回 storage 目录的绝对路径，还可以使用 storage_path 函数在 storage 目录下为给定文件生成完整路径：

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

字符串函数

__()

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

xxxxxxxxxx
 
echo __('Welcome to our application');
​
echo __('messages.welcome');

如果给定翻译字符串或键不存在，__ 函数将会返回给定值。所以，使用上面的例子，如果翻译键不存在的话 __ 函数将会返回 messages.welcome。

class_basename()

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

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

e()

e 函数在给定字符串上运行 htmlentities（double_encode 选项设置为 false）：

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

preg_replace_array()

preg_replace_array 函数使用数组替换字符串序列中的给定模式：

xxxxxxxxxx
 
$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

Str::after()

Str::after 方法返回字符串中给定值之后的所有内容：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$slice = Str::after('This is my name', 'This is');
​
// ' my name'

Str::before()

Str::before 方法返回字符串中给定值之前的所有内容：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$slice = Str::before('This is my name', 'my name');
​
// 'This is '

Str::camel()：

Str::camel 将给定字符串转化为形如 camelCase 的驼峰风格：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$converted = Str::camel('foo_bar');
​
// fooBar

Str::contains()

Str::contains 方法判断给定字符串是否包含给定值（大小写敏感）：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$contains = Str::contains('This is my name', 'my');
​
// true

还可以传递数组值判断给定字符串是否包含数组中的任意值：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$contains = Str::contains('This is my name', ['my', 'foo']);
​
// true

Str::endsWith()

Str::endsWith 方法用于判断字符串是否以给定值结尾：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$result = Str::endsWith('This is my name', 'name');
​
// true

Str::finish()

Str::finish 方法添加给定值单个实例到字符串结尾 —— 如果原字符串不以给定值结尾的话：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$adjusted = Str::finish('this/string', '/');
​
// this/string/
​
$adjusted = Str::finish('this/string/', '/');
​
// this/string/

Str::is()

Str::is 方法判断给定字符串是否与给定模式匹配，星号可用于表示通配符：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$matches = Str::is('foo*', 'foobar');
​
// true
​
$matches = Str::is('baz*', 'foobar');
​
// false

Str::kebab()

Str::kebeb 方法将给定字符串转化为形如 kebab-case 风格的字符串：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$converted = Str::kebab('fooBar');
​
// foo-bar

Str::limit()

Str::limit 方法以指定长度截断字符串：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
​
// The quick brown fox...

还可以传递第三个参数来改变字符串末尾字符：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
​
// The quick brown fox (...)

Str::orderedUuid()

Str::orderedUuid 方法会生成一个「时间戳优先」的 UUID 以便更高效地存储到数据库索引字段：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
return (string) Str::orderedUuid();

Str::plural()

Str::plural 方法将字符串转化为复数形式，该函数当前只支持英文：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$plural = Str::plural('car');
​
// cars
​
$plural = Str::plural('child');
​
// children

还可以传递整型数据作为第二个参数到该函数以获取字符串的单数或复数形式：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$plural = Str::plural('child', 2);
​
// children
​
$plural = Str::plural('child', 1);
​
// child

Str::random()

Str::random 方法通过指定长度生成随机字符串，该函数使用了PHP的 random_bytes 函数：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$random = Str::random(40);

Str::replaceArray()

Str::replaceArray 方法使用数组在字符串序列中替换给定值：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$string = 'The event will take place between ? and ?';
​
$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);
​
// The event will take place between 8:30 and 9:00

Str::replaceFirst()

Str::replaceFirst 方法会替换字符串中第一次出现的值：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');
​
// a quick brown fox jumps over the lazy dog

Str::replaceLast()

Str::replaceLast 方法会替换字符串中最后一次出现的值：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');
​
// the quick brown fox jumps over a lazy dog

Str::singular()

Str::singular 方法将字符串转化为单数形式，该函数目前只支持英文：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$singular = Str::singular('cars');
​
// car
​
$singular = Str::singular('children');
​
// child

Str::slug()

Str::slug 方法将给定字符串生成 URL 友好的格式：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$slug = Str::slug('Laravel 5 Framework', '-');
​
// laravel-5-framework

Str::snake()

Str::snake 方法将给定字符串转换为形如 snake_case 格式字符串：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$converted = Str::snake('fooBar');
​
// foo_bar

Str::start()

如果字符串没有以给定值开头的话 Str::start 方法会将给定值添加到字符串最前面：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$adjusted = Str::start('this/string', '/');
​
// /this/string
​
$adjusted = Str::start('/this/string', '/');
​
// /this/string

Str::startsWith()

Str::startsWith 方法用于判断传入字符串是否以给定值开头：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$result = Str::startsWith('This is my name', 'This');
​
// true

Str::studly()

Str::studly 方法将给定字符串转化为形如 StudlyCase 的、单词开头字母大写的格式：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$converted = Str::studly('foo_bar');
​
// FooBar

Str::title()

Str::title 方法将字符串转化为形如 Title Case 的格式：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
$converted = Str::title('a nice title uses the correct case');
​
// A Nice Title Uses The Correct Case

Str::uuid()

Str::uuid 方法生成一个 UUID（版本4）：

xxxxxxxxxx
 
use Illuminate\Support\Str;
​
return (string) Str::uuid();

trans()

trans 函数使用本地文件翻译给定翻译键：

xxxxxxxxxx
 
echo trans('messages.welcome');

如果指定翻译键不存在，trans 函数会返回给定键，所以，以上面的示例为例，如果翻译键不存在，trans 函数会返回 messages.welcome。

trans_choice()

trans_choice 函数翻译带拐点的给定翻译键：

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

如果指定的翻译键不存在，trans_choice 函数会将其返回。所以，以上面的示例为例，如果指定翻译键不存在 trans_choice 函数会返回 messages.notifications。

URL 函数

action()

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

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

如果该方法接收路由参数，你可以将其作为第二个参数传递进来：

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

asset()

asset 函数使用当前请求的 scheme（HTTP 或 HTTPS）为前端资源生成一个 URL：

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

你可以通过在 .env 文件中设置 ASSET_URL 变量来配置资源 URL 主机名，如果你将资源托管在第三方服务如 Amazon S3 时，这一功能很有用：

xxxxxxxxxx
 
// ASSET_URL=http://example.com/assets
​
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg

secure_asset()

secure_asset 函数使用 HTTPS 为前端资源生成一个 URL：

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

route()

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

xxxxxxxxxx
 
$url = route('routeName');

如果该路由接收参数，你可以将其作为第二个参数传递进来：

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

默认情况下，route 函数生成的是绝对 URL，如果你想要生成一个相对 URL，可以传递 false 作为第三个参数：

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

secure_url

secure_url 函数为给定路径生成完整的 HTTPS URL：

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

url()

url 函数为给定路径生成完整URL：

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

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

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

其它函数

abort()

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

xxxxxxxxxx
 
abort(403);

还可以提供异常响应文本以及自定义响应头：

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

abort_if()

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

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

和 abort 一样，你还可以传递异常响应文本作为第三个参数以及自定义响应头数组作为第四个参数。

abort_unless()

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

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

和 abort 一样，你还可以传递异常响应文本作为第三个参数以及自定义响应头数组作为第四个参数。

app()

app 函数返回服务容器实例：

xxxxxxxxxx
 
$container = app();

还可以传递类或接口名从容器中解析它：

xxxxxxxxxx
 
$api = app('HelpSpot\API');

auth()

auth 函数返回一个认证器实例，为方便起见你可以用其取代 Auth 门面：

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

如果需要的话还可以指定你想要使用的 guard 实例：

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

back()

back 函数生成HTTP 重定向响应到用户前一个访问页面：

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

bcrypt()

bcrypt 函数使用 Bcrypt 对给定值进行哈希，你可以用其替代 Hash 门面：

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

blank()

blank 函数返回给定值是否为空：

xxxxxxxxxx
 
blank('');
blank('   ');
blank(null);
blank(collect());
​
// true
​
blank(0);
blank(true);
blank(false);
​
// false

与 blank 相对的是 filled 函数。

broadcast()

broadcast 函数广播给定事件到监听器：

xxxxxxxxxx
 
broadcast(new UserRegistered($user));

cache()

cache 函数可以用于从缓存中获取值，如果给定 key 在缓存中不存在，可选的默认值会被返回：

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

你可以通过传递数组键值对到函数来添加数据项到缓存。还需要传递缓存有效期（秒数）：

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

class_uses_recursive()

class_uses_recursive 函数某个类所使用的所有 trait，包括子类使用的：

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

collect()

collect 函数会根据提供的数据项创建一个集合：

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

config()

config 函数获取配置变量的值，配置值可以通过使用”.”号访问，包含文件名以及你想要访问的选项。如果配置选项不存在的话默认值将会被指定并返回：

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

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

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

cookie()

cookie 函数可用于创建一个新的 Cookie 实例：

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

csrf_field()

csrf_field 函数生成一个包含 CSRF 令牌值的 HTML 隐藏字段，例如，使用Blade语法示例如下：

xxxxxxxxxx
 
{{ csrf_field() }}

csrf_token()

csrf_token 函数获取当前 CSRF 令牌的值：

xxxxxxxxxx
 
$token = csrf_token();

dd()

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

xxxxxxxxxx
 
dd($value);
​
dd($value1, $value2, $value3, ...);

如果你不想停止脚本的运行，可以使用 dump 函数。

decrypt()

decrypt 函数使用 Laravel 加密器对给定值进行解密：

xxxxxxxxxx
 
$decrypted = decrypt($encrypted_value);

dispatch()

dispatch 函数推送一个新的任务到 Laravel 任务队列：

xxxxxxxxxx
 
dispatch(new App\Jobs\SendEmails);

dispatch_now()

dispatch_now 函数会立即运行给定任务并返回 handle 方法处理结果：

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

dump()

dump 函数会打印给定变量：

xxxxxxxxxx
 
dump($value);
​
dump($value1, $value2, $value3, ...);

如果你想要在打印变量后终止脚本执行，可以使用 dd 函数替代之。

注：你可以使用 Artisan 的 dump-server 命令拦截所有 dump 调用并在控制台窗口显示它们。

encrypt()

encrypt 函数使用 Laravel 加密器加密给定字符串：

xxxxxxxxxx
 
$encrypted = encrypt($unencrypted_value);

env()

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

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

注：如果你在开发过程中执行了 config:cache 命令，需要确保只在配置文件中调用了 env，一旦配置被缓存起来，.env 文件将不会被加载，因此所有对 env 函数的调用都会返回 null。

event()

event 函数分发给定事件到对应监听器：

xxxxxxxxxx
 
event(new UserRegistered($user));

factory()

factory 函数为给定类、名称和数量创建模型工厂构建器，可用于测试或数据填充：

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

filled()

filled 函数会返回给定值是否不为空：

xxxxxxxxxx
 
filled(0);
filled(true);
filled(false);
​
// true
​
filled('');
filled('   ');
filled(null);
filled(collect());
​
// false

与 filled 相对的是 blank 函数。

info()

info 函数会记录信息到日志系统：

xxxxxxxxxx
 
info('Some helpful information!');

还可以传递上下文数据数组到该函数：

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

logger()

logger 函数可以用于记录 debug 级别的日志消息：

xxxxxxxxxx
 
logger('Debug message');

同样，也可以传递上下文数据数组到该函数：

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

如果没有值传入该函数的话会返回日志实例：

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

method_field()

method_field 函数生成包含 HTTP 请求方法的 HTML hidden 表单字段，例如：

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

now()

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

xxxxxxxxxx
 
$now = now();

old()

old 函数获取存放在一次性 Session 中上一次输入的值：

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

optional()

optional 函数接收任意参数并允许你访问对象上的属性或调用其方法。如果给定的对象为空，属性或方法调用返回 null 而不是出错：

xxxxxxxxxx
 
return optional($user->address)->street;
​
{!! old('name', optional($user)->name) !!}

optional 函数还可以接收一个闭包作为第二个参数，闭包会在第一个参数值不为空的情况下调用：

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

policy()

policy 函数为给定模型类获取对应策略实例：

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

redirect()

redirect 函数返回 HTTP 重定向响应，如果不带参数的话返回重定向器示例：

xxxxxxxxxx
 
return redirect($to = null, $status = 302, $headers = [], $secure = null);
​
return redirect('/home');
​
return redirect()->route('route.name');

report()

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

xxxxxxxxxx
 
report($e);

request()

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

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

rescue()

rescue 函数可以执行给定闭包并捕获执行过程中的所有异常。这些捕获的异常会发送给异常处理器的 report 方法，不过，请求会继续执行：

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

还可以传递第二个参数到 rescue 函数，作为在执行闭包出现异常的情况下返回的默认值：

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

resolve()

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

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

response()

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

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

retry()

retry 函数尝试执行给定回调直到达到最大执行次数，如果回调没有抛出异常，会返回对应的返回值。如果回调抛出了异常，会自动重试。如果超出最大执行次数，异常会被抛出：

xxxxxxxxxx
 
return retry(5, function () {
    // Attempt 5 times while resting 100ms in between attempts...
}, 100);

session()

session 函数可以用于获取/设置 Session 值：

xxxxxxxxxx
 
$value = session('key');

可以通过传递键值对数组到该函数的方式设置 Session 值：

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

如果没有传入参数到 session 函数则返回 Session 存储器对象实例：

xxxxxxxxxx
 
$value = session()->get('key');
​
session()->put('key', $value);

tap()

tap 函数接收两个参数：任意的 $value 和一个闭包。$value 会被传递到闭包然后通过 tap 函数返回。闭包返回值与函数返回值不相关：

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

如果没有传入闭包到 tap 函数，那么你可以调用给定 $value 上面的任意方法，调用方法的返回值永远都是 $value，不管在方法中定义的返回值是什么。例如，Eloquent update 方法通常返回一个整型，不过，我们可以通过 tap 函数强制该方法返回模型本身：

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

throw_if()

throw_if 函数会在给定布尔表达式为 true 的情况下抛出给定异常：

xxxxxxxxxx
 
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 的情况下抛出给定异常：

xxxxxxxxxx
 
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 实例：

xxxxxxxxxx
 
$today = today();

trait_uses_recursive()

trait_uses_recursive 函数会返回某个 trait 使用的所有 trait：

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

transform()

transform 函数会在给定值不为空的情况下执行闭包并返回闭包结果：

xxxxxxxxxx
 
$callback = function ($value) {
    return $value * 2;
};
​
$result = transform(5, $callback);
​
// 10

默认值或者闭包可以以第三个参数的方式传递给该函数，默认值在给定值为空的情况下返回：

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

validator()

validator 函数通过给定参数创建一个新的验证器实例，为方便起见可以使用它代替 Validator 门面：

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

value()

value 函数返回给定的值，不过，如果你传递一个闭包到该函数，该闭包将会被执行并返回执行结果：

xxxxxxxxxx
 
$result = value(true);
​
// true
​
$result = value(function () {
    return false;
});
​
// false

view()

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

xxxxxxxxxx
 
return view('auth.login');

with()

with 函数返回给定的值，如果第二个参数是闭包，则返回闭包执行结果：

xxxxxxxxxx
 
$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

新版特性

升级指南

贡献指南

安装配置

目录结构

重量级开发环境：Homestead

轻量级开发环境：Valet

部署应用到生产环境

一次 Laravel 请求的生命周期

服务容器

服务提供者

门面（Facades）

契约（Contracts）

路由

中间件

CSRF 保护

控制器

HTTP 请求

HTTP 响应

视图

URL 生成

Session

表单验证

异常处理

日志

Blade 模板引擎

本地化

快速入门：JavaScript & CSS 脚手架

使用进阶：通过 Laravel Mix 编译前端资源

登录认证

API 认证解决方案：Laravel Passport

API 认证

授权

邮箱验证

加密

哈希

重置密码

Artisan 控制台

广播

缓存

集合

事件

文件存储

辅助函数

邮件

通知

扩展包开发

队列

任务调度

快速入门

查询构建器

分页

迁移

数据填充

Redis

快速入门

关联关系

集合

访问器和修改器

API 资源类

序列化

快速入门

HTTP 测试

浏览器测试

控制台测试

数据库测试

模拟

订阅支付解决方案：Laravel Cashier（Stripe）

订阅支付解决方案：Laravel Cashier（Braintree）

远程操作解决方案：Laravel Envoy

队列系统解决方案：Laravel Horizon

全文搜索解决方案：Laravel Scout

第三方登录解决方案：Laravel Socialite

本地开发调试解决方案：Laravel Telescope

辅助函数

简介

方法列表

数组 & 对象

路径函数

字符串函数