版本：9.x

辅助函数

简介

Laravel 包含各种各样的全局 PHP 「辅助」函数，框架本身也大量的使用了这些功能函数；如果你觉的方便，你可以在你的应用中任意使用这些函数。

可用方法

方法列表

数组 & 对象

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

// false

`Arr::add()`

如果给定的键在数组中不存在或给定的键的值被设置为 null ，那么 Arr::add 函数将会把给定的键值对添加到数组中：

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 函数将多个数组合并为一个数组：

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

// false

`Arr::first()`

Arr::first 函数返回数组中满足指定条件的第一个元素：

use Illuminate\Support\Arr;

$array = [100, 200, 300];

$first = Arr::first($array, function ($value, $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::forget()`

Arr::forget 函数使用「.」符号从深度嵌套的数组中删除给定的键值对：

use Illuminate\Support\Arr;

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

Arr::forget($array, 'products.desk');

// ['products' => []]

`Arr::get()`

Arr::get 函数使用「.」符号从深度嵌套的数组根据指定键检索值：

use Illuminate\Support\Arr;

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

$price = Arr::get($array, 'products.desk.price');

// 100

Arr::get 函数也可以接受一个默认值，如果没有找到特定的键，将返回默认值：

use Illuminate\Support\Arr;

$discount = Arr::get($array, 'products.desk.discount', 0);

// 0

`Arr::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']);

// false

`Arr::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']);

// false

`Arr::isAssoc()`

如果给定数组是关联数组，则 Arr::isAssoc 函数返回 true，如果数组没有以零开头的连续数字键，则将其视为「关联」：

use Illuminate\Support\Arr;

$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);

// true

$isAssoc = Arr::isAssoc([1, 2, 3]);

// false

`Arr::isList()`

如果给定数组的键是从零开始的连续整数，则 Arr::isList 方法返回 true：

use Illuminate\Support\Arr;

$isAssoc = Arr::isList(['foo', 'bar', 'baz']);

// true

$isAssoc = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);

// false

`Arr::keyBy()`

注意

注意：自 Laravel 9.2 引入

The Arr::keyBy method keys the array by the given key. If multiple items have the same key, only the last one will appear in the new array:

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 ($value, $key) {
    return $value >= 150;
});

// 300

将默认值作为第三个参数传递给该方法，如果没有值满足条件，则返回该默认值：

use Illuminate\Support\Arr;

$last = Arr::last($array, $callback, $default);

`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::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::prepend()`

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::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::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]=desc

`Arr::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::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::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 ($value) {
    return $value['name'];
}));

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

`Arr::sortRecursive()`

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::toCssClasses()`

Arr::toCssClasses 函数根据给定的条件编译并返回 CSS 类字符串。该方法接受一个类数组，其中数组键包含你希望添加的一个或多个 CSS Class，而值是一个布尔表达式。如果数组元素有一个数字键，它将始终包含在呈现的类列表中：

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'
*/

Laravel 基于该函数实现条件类以及 @class Blade 指令。

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

// 100

该函数也接受一个默认值，如果没有找到指定的键，将返回默认值：

$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_get一样, 函数也支持使用「*」作为通配符给相应键名赋值：

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

`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）的路径,便于加载 css，js 等静态文件：

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

`public_path()`

public_path 函数返回 public 目录的完整路径。你可以使用 public_path 函数来生成 public 目录下特定文件的完整路径：

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

字符串函数

`__()`

__ 函数可使用本地化文件来翻译指定的字符串或特定的key：

echo __('Welcome to our application');

echo __('messages.welcome');

如果给定翻译的字符串或者key不存在，则 __ 会返回你指定的值. 所以上述例子中，如果给定翻译的字符串或者key不存在，则 __ 函数会返回messages.welcome。

`class_basename()`

class_basename 函数返回不带命名空间的特定类的类名：

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

// Baz

`e()`

e 函数运行PHP的htmlspecialchars 函数，且 double_encode 默认设定为 true：

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

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

`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

`Str::after()`

Str::after 方法返回字符串中指定值之后的所有内容。如果字符串中不存在这个值，它将返回整个字符串：

use Illuminate\Support\Str;

$slice = Str::after('This is my name', 'This is');

// ' my name'

`Str::afterLast()`

Str::afterLast 方法返回字符串中指定值最后一次出现后的所有内容。如果字符串中不存在这个值，它将返回整个字符串：

use Illuminate\Support\Str;

$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');

// 'Controller'

`Str::ascii()`

Str::ascii 方法尝试将字符串转换为 ASCII 值：

use Illuminate\Support\Str;

$slice = Str::ascii('û');

// 'u'

`Str::before()`

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

use Illuminate\Support\Str;

$slice = Str::before('This is my name', 'my name');

// 'This is '

`Str::beforeLast()`

Str::beforeLast 方法返回字符串中指定值最后一次出现前的所有内容：

use Illuminate\Support\Str;

$slice = Str::beforeLast('This is my name', 'is');

// 'This '

`Str::between()`

Str::between 方法返回字符串在指定两个值之间的内容：

use Illuminate\Support\Str;

$slice = Str::between('This is my name', 'This', 'name');

// ' is my '

`Str::camel()`

Str::camel 方法将指定字符串转换为 驼峰式 表示方法：

use Illuminate\Support\Str;

$converted = Str::camel('foo_bar');

// fooBar

`Str::contains()`

Str::contains 方法判断指定字符串中是否包含另一指定字符串（区分大小写）：

use Illuminate\Support\Str;

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

// true

你也可以传递数组的值的形式来判断指定字符串是否包含数组中的任一值：

use Illuminate\Support\Str;

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

// true

`Str::containsAll()`

Str::containsAll 方法用于判断指定字符串是否包含指定数组中的所有值：

use Illuminate\Support\Str;

$containsAll = Str::containsAll('This is my name', ['my', 'name']);

// true

`Str::endsWith()`

Str::endsWith 方法用于判断指定字符串是否以另一指定字符串结尾：

use Illuminate\Support\Str;

$result = Str::endsWith('This is my name', 'name');

// true

你也可以传递一个数组来判断指定字符串是否以数组中的任一值结尾：

use Illuminate\Support\Str;

$result = Str::endsWith('This is my name', ['name', 'foo']);

// true

$result = Str::endsWith('This is my name', ['this', 'foo']);

// false

`Str::excerpt()`

Str::excerpt 方法用于从给定字符串中提取与该字符串中短语的第一个实例匹配的片段：

use Illuminate\Support\Str;

$excerpt = Str::excerpt('This is my name', 'my', [
    'radius' => 3
]);

// '...is my na...'

radius 选项默认为 100，允许你定义应出现在截断字符串前后的字符数。

此外，你可以使用 omission 选项来定义将附加到截断字符串的字符串：

use Illuminate\Support\Str;

$excerpt = Str::excerpt('This is my name', 'name', [
    'radius' => 3,
    'omission' => '(...) '
]);

// '(...) my name'

`Str::finish()`

Str::finish 方法将指定的字符串修改为以指定的值结尾的形式：

use Illuminate\Support\Str;

$adjusted = Str::finish('this/string', '/');

// this/string/

$adjusted = Str::finish('this/string/', '/');

// this/string/

`Str::headline()`

Str::headline 方法会将由大小写、连字符或下划线分隔的字符串转换为空格分隔的字符串，同时保证每个单词的首字母大写：

use Illuminate\Support\Str;

$headline = Str::headline('steve_jobs');

// Steve Jobs

$headline = Str::headline('EmailNotificationSent');

// Email Notification Sent

`Str::is()`

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

use Illuminate\Support\Str;

$matches = Str::is('foo*', 'foobar');

// true

$matches = Str::is('baz*', 'foobar');

// false

`Str::isAscii()`

Str::isAscii 方法用于判断字符串是否是 7 位 ASCII：

use Illuminate\Support\Str;

$isAscii = Str::isAscii('Taylor');

// true

$isAscii = Str::isAscii('ü');

// false

`Str::isUuid()`

Str::isUuid 方法用于判断指定字符串是否是有效的 UUID ：

use Illuminate\Support\Str;

$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');

// true

$isUuid = Str::isUuid('laravel');

// false

`Str::kebab()`

Str::kebab 方法将字符串转换为 烤串式（ kebab-case ） 表示方法：

use Illuminate\Support\Str;

$converted = Str::kebab('fooBar');

// foo-bar

`Str::length()`

Str::length 方法返回指定字符串的长度：

use Illuminate\Support\Str;

$length = Str::length('Laravel');

// 7

`Str::limit()`

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

use Illuminate\Support\Str;

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

// The quick brown fox...

你也可通过第三个参数来改变追加到末尾的字符串：

use Illuminate\Support\Str;

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

// The quick brown fox (...)

`Str::lower()`

Str::lower 方法用于将字符串转换为小写：

use Illuminate\Support\Str;

$converted = Str::lower('LARAVEL');

// laravel

`Str::markdown()`

Str::markdown 方法可以将 GitHub 风格的 Markdown 转换为 HTML：

use Illuminate\Support\Str;

$html = Str::markdown('# Laravel');

// <h1>Laravel</h1>

$html = Str::markdown('# Taylor <b>Otwell</b>', [
    'html_input' => 'strip',
]);

// <h1>Taylor Otwell</h1>

`Str::mask()`

Str::mask 方法会使用重复的字符掩盖字符串的一部分，并可用于混淆字符串段，例如电子邮件地址和电话号码：

use Illuminate\Support\Str;

$string = Str::mask('taylor@example.com', '*', 3);

// tay***************

你可以提供一个负数作为 mask 方法的第三个参数，这将指示该方法在距字符串末尾的给定距离处开始屏蔽：

$string = Str::mask('taylor@example.com', '*', -15, 3);

// tay***@example.com

`Str::orderedUuid()`

Str::orderedUuid 方法用于生成一个「时间戳优先」的 UUID ，它可作为数据库索引列的有效值。使用此方法生成的每个 UUID 将排在之前使用该方法生成的 UUID 后面：

use Illuminate\Support\Str;

return (string) Str::orderedUuid();

`Str::padBoth()`

Str::padBoth 方法包装了 PHP 的 str_pad 函数，在指定字符串的两侧填充上另一字符串：

use Illuminate\Support\Str;

$padded = Str::padBoth('James', 10, '_');

// '__James___'

$padded = Str::padBoth('James', 10);

// '  James   '

`Str::padLeft()`

Str::padLeft 方法包装了 PHP 的 str_pad 函数，在指定字符串的左侧填充上另一字符串：

use Illuminate\Support\Str;

$padded = Str::padLeft('James', 10, '-=');

// '-=-=-James'

$padded = Str::padLeft('James', 10);

// '     James'

`Str::padRight()`

Str::padRight 方法包装了 PHP 的 str_pad 函数，在指定字符串的右侧填充上另一字符串：

use Illuminate\Support\Str;

$padded = Str::padRight('James', 10, '-');

// 'James-----'

$padded = Str::padRight('James', 10);

// 'James     '

`Str::plural()`

Str::plural 方法将单数形式的字符串转换为复数形式。目前该函数仅支持英语：

use Illuminate\Support\Str;

$plural = Str::plural('car');

// cars

$plural = Str::plural('child');

// children

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

use Illuminate\Support\Str;

$plural = Str::plural('child', 2);

// children

$singular = Str::plural('child', 1);

// child

`Str::pluralStudly()`

Str::pluralStudly 方法将以驼峰格式的单数字符串转化为其复数形式。目前该函数仅支持英语：

use Illuminate\Support\Str;

$plural = Str::pluralStudly('VerifiedHuman');

// VerifiedHumans

$plural = Str::pluralStudly('UserFeedback');

// UserFeedback

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

use Illuminate\Support\Str;

$plural = Str::pluralStudly('VerifiedHuman', 2);

// VerifiedHumans

$singular = Str::pluralStudly('VerifiedHuman', 1);

// VerifiedHuman

`Str::random()`

Str::random 方法用于生成指定长度的随机字符串。这个函数使用了PHP的 random_bytes 函数：

use Illuminate\Support\Str;

$random = Str::random(40);

`Str::remove()`

Str::remove 方法从字符串中删除给定值或给定数组内的所有值：

use Illuminate\Support\Str;

$string = 'Peter Piper picked a peck of pickled peppers.';

$removed = Str::remove('e', $string);

// Ptr Pipr pickd a pck of pickld ppprs.

你还可以将 false 作为第三个参数传递给 remove 方法以在删除字符串时忽略大小写。

`Str::replace()`

Str::replace 方法用于替换字符串中的给定字符串：

use Illuminate\Support\Str;

$string = 'Laravel 8.x';

$replaced = Str::replace('8.x', '9.x', $string);

// Laravel 9.x

`Str::replaceArray()`

Str::replaceArray 方法使用数组有序的替换字符串中的特定字符：

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 函数替换字符串中给定值的第一个匹配项：

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 函数替换字符串中最后一次出现的给定值：

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::reverse()`

Str::reverse 方法用于反转给定的字符串：

use Illuminate\Support\Str;

$reversed = Str::reverse('Hello World');

// dlroW olleH

`Str::singular()`

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

use Illuminate\Support\Str;

$singular = Str::singular('cars');

// car

$singular = Str::singular('children');

// child

`Str::slug()`

Str::slug 方法将给定的字符串生成一个 URL 友好的「slug」：

use Illuminate\Support\Str;

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

// laravel-5-framework

`Str::snake()`

Str::snake 方法是将驼峰的函数名或者字符串转换成 _ 命名的函数或者字符串，例如 snakeCase 转换成 snake_case

use Illuminate\Support\Str;

$converted = Str::snake('fooBar');

// foo_bar

$converted = Str::snake('fooBar', '-');

// foo-bar

`Str::start()`

Str::start 方法是将给定的值添加到字符串的开始位置，例如：

use Illuminate\Support\Str;

$adjusted = Str::start('this/string', '/');

// /this/string

$adjusted = Str::start('/this/string', '/');

// /this/string

`Str::startsWith()`

Str::startsWith 方法用来判断给定的字符串是否为给定值的开头：

use Illuminate\Support\Str;

$result = Str::startsWith('This is my name', 'This');

// true

如果传递了一个可能值的数组且字符串以任何给定值开头，则 startsWith 方法将返回 true：

$result = Str::startsWith('This is my name', ['This', 'That', 'There']);

// true

`Str::studly()`

Str::studly 方法将给定的字符串转换为 驼峰命名 的字符串：

use Illuminate\Support\Str;

$converted = Str::studly('foo_bar');

// FooBar

`Str::substr()`

Str::substr 方法与 php 自带的字符串 substr 截取函数相同：

use Illuminate\Support\Str;

$converted = Str::substr('The Laravel Framework', 4, 7);

// Laravel

`Str::substrCount()`

Str::substrCount 方法返回给定字符串中给定值出现的次数：

use Illuminate\Support\Str;

$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');

// 2

`Str::substrReplace()`

Str::substrReplace 方法在字符串的一部分中替换文本，从第三个参数指定的位置开始替换第四个参数指定的字符数。将 0 传递给方法的第四个参数将在指定位置插入字符串，而不替换字符串中的任何现有字符：

use Illuminate\Support\Str;

$result = Str::substrReplace('1300', ':', 2); 
// 13:

$result = Str::substrReplace('1300', ':', 2, 0); 
// 13:00

`Str::swap()`

Str::swap 方法使用 PHP 的 strtr 函数替换给定字符串中的多个值：

use Illuminate\Support\Str;

$string = Str::swap([
    'Tacos' => 'Burritos',
    'great' => 'fantastic',
], 'Tacos are great!');

// Burritos are fantastic!

`Str::title()`

Str::title 方法是把指定的字符串，每个单词首字母大写：

use Illuminate\Support\Str;

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

// A Nice Title Uses The Correct Case

`Str::toHtmlString()`

Str::toHtmlString 方法将字符串实例转换为 Illuminate\Support\HtmlString 的实例，它可以显示在 Blade 模板中：

use Illuminate\Support\Str;

$htmlString = Str::of('Nuno Maduro')->toHtmlString();

`Str::ucfirst()`

Str::ucfirst 方法是把指定的字符串首字母大写：

use Illuminate\Support\Str;

$string = Str::ucfirst('foo bar');

// Foo bar

`Str::upper()`

Str::upper 函数用于将指定字符串转换为大写：

use Illuminate\Support\Str;

$string = Str::upper('laravel');

// LARAVEL

`Str::uuid()`

Str::uuid 方法用于生成一个 UUID （第 4 版）：

use Illuminate\Support\Str;

return (string) Str::uuid();

`Str::wordCount()`

Str::wordCount 方法返回字符串包含的单词数：

use Illuminate\Support\Str;

Str::wordCount('Hello, world!'); // 2

`Str::words()`

Str::words 方法用于限制字符串中的单词数。可以通过它的第三个参数将另一个字符串传递给此方法，以指定应将哪个字符串附加到截断的字符串的末尾：

use Illuminate\Support\Str;

return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');

// Perfectly balanced, as >>>

`str()`

str 函数返回给定字符串的新 Illuminate\Support\Stringable 实例。这个函数等价于 Str::of 方法：

$string = str('Taylor')->append(' Otwell');

// 'Taylor Otwell'

如果没有为 str 函数提供参数，则该函数返回 Illuminate\Support\Str 的实例：

$snake = str()->snake('FooBar');

// 'foo_bar'

`trans()`

The 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。

字符流处理

字符流处理（Fluent strings）提供了一种更流畅的、拥有面向对象接口形式的字符串处理方式，它允许使用比传统字符串操作更具可读性的语法来进行多字符串的链式操作。

`after`

after 方法将返回字符串中指定值后的所有内容。如果字符串中不存在这个值，它将返回整个字符串：

use Illuminate\Support\Str;

$slice = Str::of('This is my name')->after('This is');

// ' my name'

`afterLast`

afterLast方法返回字符串中指定值最后一次出现后的所有内容。如果字符串中不存在这个值，它将返回整个字符串：

use Illuminate\Support\Str;

$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');

// 'Controller'

`append`

append 方法为字符串附加上指定的值：

use Illuminate\Support\Str;

$string = Str::of('Taylor')->append(' Otwell');

// 'Taylor Otwell'

`ascii`

ascii 方法尝试将字符串转换为 ASCII 值：

use Illuminate\Support\Str;

$string = Str::of('ü')->ascii();

// 'u'

`basename`

basename方法将返回指定字符串的结尾部分：

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz')->basename();

// 'baz'

如果有必要，你也可以提供提供一个「扩展名」，将从尾部的组件中移除它。

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');

// 'baz'

`before`

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

use Illuminate\Support\Str;

$slice = Str::of('This is my name')->before('my name');

// 'This is '

`beforeLast`

beforeLast 方法返回字符串中指定值最后一次出现前的所有内容：

use Illuminate\Support\Str;

$slice = Str::of('This is my name')->beforeLast('is');

// 'This '

`between`

between 方法返回两个值之间的字符串部分：

use Illuminate\Support\Str;

$converted = Str::of('This is my name')->between('This', 'name');

// ' is my '

`camel`

camel 方法将指定字符串转换为 驼峰式 表示方法：

use Illuminate\Support\Str;

$converted = Str::of('foo_bar')->camel();

// fooBar

`contains`

contains 方法判断指定字符串中是否包含另一指定字符串（区分大小写）：

use Illuminate\Support\Str;

$contains = Str::of('This is my name')->contains('my');

// true

你也可以传递数组的值的形式来判断指定字符串是否包含数组中的任一值：

use Illuminate\Support\Str;

$contains = Str::of('This is my name')->contains(['my', 'foo']);

// true

`containsAll`

containsAll 方法用于判断指定字符串是否包含指定数组中的所有值：

use Illuminate\Support\Str;

$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);

// true

`dirname`

dirname 方法用于返回指定字符串的父级目录部分：

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname();

// '/foo/bar'

你也可以指定你想要从字符串中删除多少个目录级别，该参数是可选的：

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname(2);

// '/foo'

`excerpt`

excerpt 方法从字符串中提取与该字符串中短语的第一个实例匹配的片段：

use Illuminate\Support\Str;

$excerpt = Str::of('This is my name')->excerpt('my', [
    'radius' => 3
]);

// '...is my na...'

radius 选项默认为 100，允许你定义应出现在截断字符串两侧的字符数。

此外，你也可以使用 omission 选项来更改将附加到截断字符串的字符串：

use Illuminate\Support\Str;

$excerpt = Str::of('This is my name')->excerpt('name', [
    'radius' => 3,
    'omission' => '(...) '
]);

// '(...) my name'

`endsWith`

endsWith 方法用于判断指定字符串是否以另一指定字符串结尾：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->endsWith('name');

// true

你也可以传递数组的值的形式来判断指定字符串是否包含指定数组中的任一值：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->endsWith(['name', 'foo']);

// true

$result = Str::of('This is my name')->endsWith(['this', 'foo']);

// false

`exactly`

exactly 方法用于判断指定字符串是否与另一字符串完全匹配：

use Illuminate\Support\Str;

$result = Str::of('Laravel')->exactly('Laravel');

// true

`explode`

explode 方法使用指定的分割符分割字符串，并返回包含字符串每个部分的集合：

use Illuminate\Support\Str;

$collection = Str::of('foo bar baz')->explode(' ');

// collect(['foo', 'bar', 'baz'])

`finish`

finish 方法用于判断指定字符串末尾是否有特定字符，若没有，则将其添加到字符串末尾：

use Illuminate\Support\Str;

$adjusted = Str::of('this/string')->finish('/');

// this/string/

$adjusted = Str::of('this/string/')->finish('/');

// this/string/

`is`

is 方法用于判断字符串是否与指定模式匹配。星号 * 用于表示通配符：

use Illuminate\Support\Str;

$matches = Str::of('foobar')->is('foo*');

// true

$matches = Str::of('foobar')->is('baz*');

// false

`isAscii`

isAscii 方法用于判断指定字符串是否是 ASCII 字符串：

use Illuminate\Support\Str;

$result = Str::of('Taylor')->isAscii();

// true

$result = Str::of('ü')->isAscii();

// false

`isEmpty`

isEmpty 方法用于判断指定字符串是否为空：

use Illuminate\Support\Str;

$result = Str::of('  ')->trim()->isEmpty();

// true

$result = Str::of('Laravel')->trim()->isEmpty();

// false

`isNotEmpty`

isNotEmpty 方法用于判断指定字符串是否不为空：

use Illuminate\Support\Str;

$result = Str::of('  ')->trim()->isNotEmpty();

// false

$result = Str::of('Laravel')->trim()->isNotEmpty();

// true

`isUuid`

isUuid 方法确定给定字符串是否为 UUID：

use Illuminate\Support\Str;

$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();

// true

$result = Str::of('Taylor')->isUuid();

// false

`kebab`

kebab 方法将指定字符串转换为 烤串式( kebab-case ) 表示形式：

use Illuminate\Support\Str;

$converted = Str::of('fooBar')->kebab();

// foo-bar

`length`

length 方法返回指定字符串的长度：

use Illuminate\Support\Str;

$length = Str::of('Laravel')->length();

// 7

`limit`

limit 方法用于将指定字符串切割为指定长度：

use Illuminate\Support\Str;

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);

// The quick brown fox...

你也可以通过第二个参数来改变追加到末尾的字符串：

use Illuminate\Support\Str;

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');

// The quick brown fox (...)

`lower`

lower 方法将指定字符串转换为小写：

use Illuminate\Support\Str;

$result = Str::of('LARAVEL')->lower();

// 'laravel'

`ltrim`

ltrim 方法移除字符串左端指定的字符：

use Illuminate\Support\Str;

$string = Str::of('  Laravel  ')->ltrim();

// 'Laravel  '

$string = Str::of('/Laravel/')->ltrim('/');

// 'Laravel/'

`markdown`

markdown 方法将 Github 风格的 Markdown 转换为 HTML：

use Illuminate\Support\Str;

$html = Str::of('# Laravel')->markdown();

// <h1>Laravel</h1>

$html = Str::of('# Taylor <b>Otwell</b>')->markdown([
    'html_input' => 'strip',
]);

// <h1>Taylor Otwell</h1>

`mask`

mask 方法用重复字符掩盖字符串的一部分，并可用于混淆字符串段，例如电子邮件地址和电话号码：

use Illuminate\Support\Str;

$string = Str::of('taylor@example.com')->mask('*', 3);

// tay***************

如果需要，你可以提供一个负数作为 mask 方法的第三个参数，这将指示该方法在距字符串末尾的给定距离处开始屏蔽：

$string = Str::of('taylor@example.com')->mask('*', -15, 3);

// tay***@example.com

`match`

match 方法将会返回字符串和指定正则表达式匹配的部分：

use Illuminate\Support\Str;

$result = Str::of('foo bar')->match('/bar/');

// 'bar'

$result = Str::of('foo bar')->match('/foo (.*)/');

// 'bar'

`matchAll`

matchAll 方法将会返回一个集合，该集合包含了指定字符串中与指定正则表达式匹配的部分：

use Illuminate\Support\Str;

$result = Str::of('bar foo bar')->matchAll('/bar/');

// collect(['bar', 'bar'])

如果你在正则表达式中指定了一个匹配组， Laravel 将会返回与该组匹配的集合：

use Illuminate\Support\Str;

$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');

// collect(['un', 'ly']);

如果没有找到任何匹配项，则返回空集合。

`padBoth`

padBoth 方法包装了 PHP 的 str_pad 函数，在指定字符串的两侧填充上另一字符串，直至该字符串到达指定的长度：

use Illuminate\Support\Str;

$padded = Str::of('James')->padBoth(10, '_');

// '__James___'

$padded = Str::of('James')->padBoth(10);

// '  James   '

`padLeft`

The padLeft 方法包装了 PHP 的 str_pad 函数，在指定字符串的左侧填充上另一字符串，直至该字符串到达指定的长度：

use Illuminate\Support\Str;

$padded = Str::of('James')->padLeft(10, '-=');

// '-=-=-James'

$padded = Str::of('James')->padLeft(10);

// '     James'

`padRight`

padRight 方法包装了 PHP 的 str_pad 函数，在指定字符串的右侧填充上另一字符串，直至该字符串到达指定的长度：

use Illuminate\Support\Str;

$padded = Str::of('James')->padRight(10, '-');

// 'James-----'

$padded = Str::of('James')->padRight(10);

// 'James     '

`pipe`

pipe 方法通过将字符串的当前值传递给给定的匿名函数来转换字符串：

use Illuminate\Support\Str;

$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');

// 'Checksum: a5c95b86291ea299fcbe64458ed12702'

$closure = Str::of('foo')->pipe(function ($str) {
    return 'bar';
});

// 'bar'

`plural`

plural 方法将单数形式的字符串转换为复数形式。目前该函数仅支持英语：

use Illuminate\Support\Str;

$plural = Str::of('car')->plural();

// cars

$plural = Str::of('child')->plural();

// children

你也可以给该函数提供一个整数作为第二个参数用于检索单数或复数形式：

use Illuminate\Support\Str;

$plural = Str::of('child')->plural(2);

// children

$plural = Str::of('child')->plural(1);

// child

`prepend`

prepend 方法用于在指定字符串的开头插入另一指定字符串：

use Illuminate\Support\Str;

$string = Str::of('Framework')->prepend('Laravel ');

// Laravel Framework

`remove`

remove 方法从字符串中删除给定的值或值数组：

use Illuminate\Support\Str;

$string = Str::of('Arkansas is quite beautiful!')->remove('quite');

// Arkansas is beautiful!

你还可以传递 false 作为第二个参数以在删除字符串时忽略大小写。

`replace`

replace 方法用于将字符串中的指定字符串替换为另一指定字符串：

use Illuminate\Support\Str;

$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');

// Laravel 7.x

`replaceArray`

replaceArray 方法使用数组顺序替换字符串中的给定值：

use Illuminate\Support\Str;

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

$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);

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

`replaceFirst`

replaceFirst方法替换字符串中给定值的第一个匹配项：

use Illuminate\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');

// a quick brown fox jumps over the lazy dog

`replaceLast`

replaceLast方法替换字符串中给定值的最后一次出现：

use Illuminate\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');

// the quick brown fox jumps over a lazy dog

`replaceMatches`

replaceMatches方法用给定的替换字符串替换与模式匹配的字符串的所有部分：

use Illuminate\Support\Str;

$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')

// '15015551000'

replaceMatches方法还接受一个闭包，该闭包将被与给定模式匹配的字符串的每个部分调用，从而允许你在闭包中执行替换逻辑并返回替换的值：

use Illuminate\Support\Str;

$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {
    return '['.$match[0].']';
});

// '[1][2][3]'

`rtrim`

rtrim方法修剪给定字符串的右侧：

use Illuminate\Support\Str;

$string = Str::of('  Laravel  ')->rtrim();

// '  Laravel'

$string = Str::of('/Laravel/')->rtrim('/');

// '/Laravel'

`scan`

scan 方法根据 sscanf PHP function 支持的格式将字符串中的输入解析为集合：

use Illuminate\Support\Str;

$collection = Str::of('filename.jpg')->scan('%[^.].%s');

// collect(['filename', 'jpg'])

`singular`

singular 方法将字符串转换为其单数形式。此函数当前仅支持英语：

use Illuminate\Support\Str;

$singular = Str::of('cars')->singular();

// car

$singular = Str::of('children')->singular();

// child

`slug`

slug 方法从给定字符串生成URL友好的 slug：

use Illuminate\Support\Str;

$slug = Str::of('Laravel Framework')->slug('-');

// laravel-framework

`snake`

snake方法将给定字符串转换为snake_case：

use Illuminate\Support\Str;

$converted = Str::of('fooBar')->snake();

// foo_bar

`split`

split 方法使用正则表达式将字符串拆分为集合：

use Illuminate\Support\Str;

$segments = Str::of('one, two, three')->split('/[\s,]+/');

// collect(["one", "two", "three"])

`start`

start 方法将给定值的单个实例添加到字符串中，前提是该字符串尚未以该值开头：

use Illuminate\Support\Str;

$adjusted = Str::of('this/string')->start('/');

// /this/string

$adjusted = Str::of('/this/string')->start('/');

// /this/string

`startsWith`

startsWith方法确定给定字符串是否以给定值开头：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->startsWith('This');

// true

`studly`

studly方法将给定字符串转换为StudlyCase：

use Illuminate\Support\Str;

$converted = Str::of('foo_bar')->studly();

// FooBar

`substr`

substr方法返回由给定的起始参数和长度参数指定的字符串部分：

use Illuminate\Support\Str;

$string = Str::of('Laravel Framework')->substr(8);

// Framework

$string = Str::of('Laravel Framework')->substr(8, 5);

// Frame

`substrReplace`

substrReplace 方法在字符串的一部分中替换文本，从第二个参数指定的位置开始替换第三个参数指定的字符数。将 0 传递给方法的第三个参数将在指定位置插入字符串，而不替换字符串中的任何现有字符：

use Illuminate\Support\Str;

$string = Str::of('1300')->substrReplace(':', 2);

// 13:

$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);

// The Laravel Framework

`swap`

swap 方法使用 PHP 的 strtr 函数替换字符串中的多个值：

use Illuminate\Support\Str;

$string = Str::of('Tacos are great!')
    ->swap([
        'Tacos' => 'Burritos',
        'great' => 'fantastic',
    ]);

// Burritos are fantastic!

`tap`

tap方法将字符串传递给给定的闭包，允许你在不影响字符串本身的情况下检查字符串并与之交互。tap方法返回原始字符串，而不管闭包返回什么：

use Illuminate\Support\Str;

$string = Str::of('Laravel')
    ->append(' Framework')
    ->tap(function ($string) {
        dump('String after append: ' . $string);
    })
    ->upper();

// LARAVEL FRAMEWORK

`test`

test 方法确定字符串是否与给定的正则表达式模式匹配：

use Illuminate\Support\Str;

$result = Str::of('Laravel Framework')->test('/Laravel/');

// true

`title`

title方法将给定字符串转换为title Case：

use Illuminate\Support\Str;

$converted = Str::of('a nice title uses the correct case')->title();

// A Nice Title Uses The Correct Case

`trim`

trim方法修剪给定字符串：

use Illuminate\Support\Str;

$string = Str::of('  Laravel  ')->trim();

// 'Laravel'

$string = Str::of('/Laravel/')->trim('/');

// 'Laravel'

`ucfirst`

ucfirst方法返回第一个字符大写的给定字符串：

use Illuminate\Support\Str;

$string = Str::of('foo bar')->ucfirst();

// Foo bar

`upper`

upper方法将给定字符串转换为大写：

use Illuminate\Support\Str;

$adjusted = Str::of('laravel')->upper();

// LARAVEL

`when`

如果给定的条件为true，则when方法调用给定的闭包。闭包将接收一个流畅字符串实例：

use Illuminate\Support\Str;

$string = Str::of('Taylor')
                ->when(true, function ($string) {
                    return $string->append(' Otwell');
                });

// 'Taylor Otwell'

如果需要，可以将另一个闭包作为第三个参数传递给when方法。如果条件参数的计算结果为false，则将执行此闭包。

`whenContains`

whenContains 方法会在字符串包含给定的值的前提下，调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('tony stark')
            ->whenContains('tony', function ($string) {
                return $string->title();
            });

// 'Tony Stark'

如有必要，你可以将另一个闭包作为第三个参数传递给 when 方法。如果字符串不包含给定值，则此闭包将执行。

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

use Illuminate\Support\Str;

$string = Str::of('tony stark')
            ->whenContains(['tony', 'hulk'], function ($string) {
                return $string->title();
            });

// Tony Stark

`whenContainsAll`

whenContainsAll 方法会在字符串包含所有给定的子字符串时，调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('tony stark')
                ->whenContainsAll(['tony', 'stark'], function ($string) {
                    return $string->title();
                });

// 'Tony Stark'

如有必要，你可以将另一个闭包作为第三个参数传递给 when 方法。如果条件参数评估为 false，则此闭包将执行。

`whenEmpty`

如果字符串为空，whenEmpty方法将调用给定的闭包。如果闭包返回一个值，whenEmpty方法也将返回该值。如果闭包不返回值，则将返回字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('  ')->whenEmpty(function ($string) {
    return $string->trim()->prepend('Laravel');
});

// 'Laravel'

`whenNotEmpty`

如果字符串不为空，whenNotEmpty 方法会调用给定的闭包。如果闭包返回一个值，那么 whenNotEmpty 方法也将返回该值。如果闭包没有返回值，则返回字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('Framework')->whenNotEmpty(function ($string) {
    return $string->prepend('Laravel ');
});

// 'Laravel Framework'

`whenStartsWith`

如果字符串以给定的子字符串开头，whenStartsWith 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('disney world')->whenStartsWith('disney', function ($string) {
    return $string->title();
});

// 'Disney World'

`whenEndsWith`

如果字符串以给定的子字符串结尾，whenEndsWith 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('disney world')->whenEndsWith('world', function ($string) {
    return $string->title();
});

// 'Disney World'

`whenExactly`

如果字符串与给定字符串完全匹配，whenExactly 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('laravel')->whenExactly('laravel', function ($string) {
    return $string->title();
});

// 'Laravel'

`whenIs`

如果字符串匹配给定的模式，whenIs 方法会调用给定的闭包。星号可用作通配符值。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('foo/bar')->whenIs('foo/*', function ($string) {
    return $string->append('/baz');
});

// 'foo/bar/baz'

`whenIsAscii`

如果字符串是 7 位 ASCII，whenIsAscii 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('foo/bar')->whenIsAscii('laravel', function ($string) {
    return $string->title();
});

// 'Laravel'

`whenIsUuid`

如果字符串是有效的 UUID，whenIsUuid 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('foo/bar')->whenIsUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de', function ($string) {
    return $string->substr(0, 8);
});

// 'a0a2a2d2'

`whenTest`

如果字符串匹配给定的正则表达式，whenTest 方法会调用给定的闭包。闭包将接收字符流处理实例：

use Illuminate\Support\Str;

$string = Str::of('laravel framework')->whenTest('/laravel/', function ($string) {
    return $string->title();
});

// 'Laravel Framework'

`wordCount`

wordCount 方法返回字符串包含的单词数：

use Illuminate\Support\Str;

Str::of('Hello, world!')->wordCount(); // 2

`words`

words方法限制字符串中的字数。如有必要，可以指定附加到截断字符串的附加字符串：

use Illuminate\Support\Str;

$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');

// Perfectly balanced, as >>>

URLs

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

你可以通过在.env文件中设置ASSET_URL变量来配置资产URL主机。如果你将资产托管在外部服务（如 Amazon S3 或其他 CDN）上，这将非常有用：

// ASSET_URL=http://example.com/assets

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

`route()`

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

$url = route('route.name');

如果路由接受参数，则可以将其作为第二个参数传递给函数：

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

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

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

`secure_asset()`

The secure_asset function generates a URL for an asset using HTTPS:

$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_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']);

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

你还可以提供应发送到浏览器的异常消息和自定义 HTTP 响应标头：

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

`abort_if()`

如果给定的布尔表达式评估为true，abort_if函数将引发HTTP异常：

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

像abort方法一样，你也可以将异常的响应文本作为第三个参数，并将自定义响应标头的数组作为该函数的第四个参数。

`abort_unless()`

如果给定的布尔表达式评估为 false，则abort_unless函数将引发 HTTP 异常：

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

像abort方法一样，你也可以将异常的响应文本作为第三个参数，并将自定义响应标头的数组作为该函数的第四个参数。

`app()`

app 方法返回服务容器实例：

$container = app();

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

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

`auth()`

auth 函数返回一个认证器实例. 你可以使用它来替代 Auth 门面：

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

如果需要，你可以指定你想要访问的认证实例：

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

`back()`

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

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

return back();

`bcrypt()`

The 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, 函数相反的方法，请看 filled 函数.

`broadcast()`

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

broadcast(new UserRegistered($user));

broadcast(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()`

collect 函数根据给定的值创建一个 collection 实例：

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

`config()`

config 函数获取 configuration 变量的值。可以使用「点」语法访问配置的值，其中包括文件的名称和访问的选项，如果访问的配置选项不存在，你可以指定一个默认值并且返回这个默认值：

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

`decrypt()`

decrypt 函数解密给定的值。你可以使用这个函数作为 Crypt 门面的替代：

$password = decrypt($value);

`dd()`

dd 函数打印输出给定的变量并且结束脚本运行：

dd($value);

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

如果你不停止执行脚本，那么可以使用 dump 函数。

`dispatch()`

dispatch 函数将给定的任务推送到 Laravel 任务队列：

dispatch(new App\Jobs\SendEmails);

`dump()`

dump 打印给定的变量：

dump($value);

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

如果你想要在打印后停止执行脚本，可以使用 dd 函数。

`encrypt()`

encrypt 函数加密给定的值。你可以使用这个函数作为 Crypt 门面的替代：

$secret = encrypt('my-secret-value');

`env()`

env 函数可以获取环境变量配置的值或者返回默认值：

$env = env('APP_ENV');

$env = env('APP_ENV', 'production');

注意

注意：如果你在部署过程中执行了 config:cache 命令 , 那么你应该确保只从配置文件中调用 env 函数. 一旦配置被缓存， .env 文件将不再次加载，所有对 env 函数的调用将返回 null。

`event()`

event函数向监听器派发给定事件：

event(new UserRegistered($user));

`filled()`

filled 函数返回是否不为「空」：

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

// true

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

// false

对于作用与 filled, 相反的方法，可以查看 blank 方法。

`info()`

info 函数将信息写入 log：

info('Some helpful information!');

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

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

`logger()`

logger 函数可以被用于将 debug 级别的消息写入 log：

logger('Debug message');

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

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

如果不带参数调用此函数，它将返回 logger 实例：

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 函数也接受闭包作为第二个参数。如果第一个参数提供的值不为空，闭包将被调用：

return optional(User::find($id), function ($user) {
    return $user->name;
});

`policy()`

policy 方法为给定的类获取 policy 实例

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

`redirect()`

redirect 函数返回重定向 HTTP 响应，如果不带参数调用则返回重定向器实例：

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

return redirect('/home');

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

`report()`

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

report($e);

report 函数也接受一个字符串作为参数。当给函数一个字符串时，函数将创建一个异常，并将该字符串作为其消息：

report('Something went wrong.');

`request()`

request 函数返回当前的 request实例或从当前请求中获取输入字段的值：

$request = request();

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

`rescue()`

rescue 函数执行给定的闭包，并且捕获其执行过程中引发的任何异常。捕获的所有异常都将传递给异常处理器；然后继续处理此次请求：

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

还可以为其传递第二个参数。这个参数将作为执行闭包引发异常时的「默认」值：

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 () {
    // Attempt 5 times while resting 100ms between attempts...
}, 100);

如果你想手动计算两次尝试之间休眠的毫秒数，您可以将闭包作为第三个参数传递给 retry 函数：

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

方便起见，你可以提供一个数组作为 retry 函数的第一个参数。该数组将用于确定后续尝试之间要休眠的毫秒数：

return retry([100, 200] function () {
    // Sleep for 100ms on first retry, 200ms on second retry...
});

要仅在特定条件下重试，你可以将闭包作为第四个参数传递给 retry 函数：

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

`session()`

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

$value = session('key');

可以向该函数传递键值对数组来设置 session 值：

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,
]);

要向类中添加 tap 方法，可以将 Illuminate\Support\Traits\Tappable 特征添加到类中。此特征的 tap 方法接受闭包作为其唯一参数。对象实例本身将传递给闭包，然后由 tap 方法返回：

return $user->tap(function ($user) {
    //
});

`throw_if()`

在给定的布尔表达式结果为 true 时，throw_if 函数抛出给定的异常：

throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    'You are not allowed to access this page.'
);

`throw_unless()`

在给定的布尔表达式结果为 false 时，throw_unless 函数抛出给定的异常：

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

$today = today();

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

// 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

简介​

可用方法​

数组 & 对象​

路径​

字符串​

字符流处理​

URLs​

其他​

方法列表​

数组 & 对象​

Arr::accessible()​

Arr::add()​

Arr::collapse()​

Arr::crossJoin()​

Arr::divide()​

Arr::dot()​

Arr::except()​

Arr::exists()​

Arr::first()​

Arr::flatten()​

Arr::forget()​

Arr::get()​

Arr::has()​

Arr::hasAny()​

Arr::isAssoc()​

Arr::isList()​

Arr::keyBy()​

Arr::last()​

Arr::only()​

Arr::pluck()​

Arr::prepend()​

Arr::pull()​

Arr::query()​

Arr::random()​

Arr::set()​

Arr::shuffle()​

Arr::sort()​

Arr::sortRecursive()​

Arr::toCssClasses()​

Arr::undot()​

Arr::where()​

Arr::whereNotNull()​

Arr::wrap()​

data_fill()​

data_get()​

data_set()​

head()​

last()​

路径​

app_path()​

base_path()​

config_path()​

database_path()​

mix()​

public_path()​

resource_path()​

storage_path()​

字符串函数​

__()​

class_basename()​

e()​

preg_replace_array()​

Str::after()​

Str::afterLast()​

Str::ascii()​

Str::before()​

Str::beforeLast()​

Str::between()​

Str::camel()​

Str::contains()​

Str::containsAll()​

Str::endsWith()​

Str::excerpt()​

Str::finish()​

Str::headline()​

Str::is()​

Str::isAscii()​

Str::isUuid()​

Str::kebab()​

Str::length()​

简介

可用方法

数组 & 对象

路径

字符串

字符流处理

URLs

其他

方法列表

数组 & 对象

`Arr::accessible()`

`Arr::add()`

`Arr::collapse()`

`Arr::crossJoin()`

`Arr::divide()`

`Arr::dot()`

`Arr::except()`

`Arr::exists()`

`Arr::first()`

`Arr::flatten()`

`Arr::forget()`

`Arr::get()`

`Arr::has()`

`Arr::hasAny()`

`Arr::isAssoc()`

`Arr::isList()`

`Arr::keyBy()`

`Arr::last()`

`Arr::only()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::pull()`

`Arr::query()`

`Arr::random()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sort()`

`Arr::sortRecursive()`

`Arr::toCssClasses()`

`Arr::undot()`

`Arr::where()`

`Arr::whereNotNull()`

`Arr::wrap()`

`data_fill()`

`data_get()`

`data_set()`

`head()`

`last()`

路径

`app_path()`

`base_path()`

`config_path()`

`database_path()`

`mix()`

`public_path()`

`resource_path()`

`storage_path()`

字符串函数

`__()`

`class_basename()`

`e()`

`preg_replace_array()`

`Str::after()`

`Str::afterLast()`

`Str::ascii()`

`Str::before()`

`Str::beforeLast()`

`Str::between()`

`Str::camel()`

`Str::contains()`

`Str::containsAll()`

`Str::endsWith()`

`Str::excerpt()`

`Str::finish()`

`Str::headline()`

`Str::is()`

`Str::isAscii()`

`Str::isUuid()`

`Str::kebab()`

`Str::length()`