辅助函数

未匹配的标注

辅助函数

简介

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

可用方法

数组 & 对象

路径

字符串

字符流处理

URLs

杂项

方法列表

数组 & 对象

Arr::accessible() {.collection-method .first-collection-method}

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() {.collection-method}

如果给定的键名在数组中不存在键值或该键值设置为 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() {.collection-method}

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() {.collection-method}

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() {.collection-method}

Arr::divide 方法返回一个二维数组,一个值包含原数组的键,另一个值包含原数组的值:

use Illuminate\Support\Arr;

[$keys, $values] = Arr::divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

Arr::dot() {.collection-method}

Arr::dot 方法将多维数组中所有的键平铺到一维数组中,新数组使用「.」符号表示层级包含关系:

use Illuminate\Support\Arr;

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

$flattened = Arr::dot($array);

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

Arr::except() {.collection-method}

Arr::except 方法从数组中删除指定的键值对:

use Illuminate\Support\Arr;

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

$filtered = Arr::except($array, ['price']);

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

Arr::exists() {.collection-method}

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() {.collection-method}

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

use Illuminate\Support\Arr;

$array = [100, 200, 300];

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

// 200

可将默认值作为第三个参数传递给该方法,如果数组中没有值满足指定条件,则返回该默认值:

use Illuminate\Support\Arr;

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

Arr::flatten() {.collection-method}

Arr::flatten 方法将多维数组中数组的值取出平铺为一维数组:

use Illuminate\Support\Arr;

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

$flattened = Arr::flatten($array);

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

Arr::forget() {.collection-method}

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

use Illuminate\Support\Arr;

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

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

// ['products' => []]

Arr::get() {.collection-method}

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() {.collection-method}

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() {.collection-method}

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() {.collection-method}

如果给定数组是关联数组,则 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() {.collection-method}

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

use Illuminate\Support\Arr;

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

// true

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

// false

Arr::join() {.collection-method}

Arr::join()方法将给定数组的所有值通过给定字符串连接起来。使用此方法的第二个参数,您还可以为数组中的最后一个元素指定连接的字符串:

use Illuminate\Support\Arr;

$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];

$joined = Arr::join($array, ', ');

// Tailwind, Alpine, Laravel, Livewire

$joined = Arr::join($array, ', ', ' and ');

// Tailwind, Alpine, Laravel and Livewire

Arr::keyBy() {.collection-method}

Arr::keyBy()方法通过给定键名的值对该数组进行重组。如果数组中存在多个相同的值,则只有最后一个值会出现在新数组中:

use Illuminate\Support\Arr;

$array = [
    ['product_id' => 'prod-100', 'name' => 'Desk'],
    ['product_id' => 'prod-200', 'name' => 'Chair'],
];

$keyed = Arr::keyBy($array, 'product_id');

/*
    [
        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
    ]
*/

Arr::last() {.collection-method}

Arr::last 方法返回数组中满足指定条件的最后一个元素:

use Illuminate\Support\Arr;

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

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

// 300

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

use Illuminate\Support\Arr;

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

Arr::map() {.collection-method}

Arr::map 方法用来遍历数组,并将每个值和键传递给给定的回调。数组值由回调返回的值替换:

use Illuminate\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

Arr::only() {.collection-method}

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() {.collection-method}

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::last() {.collection-method}

Arr::last 方法返回数组中满足指定条件的最后一个元素:

use Illuminate\Support\Arr;

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

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

// 300

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

use Illuminate\Support\Arr;

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

Arr::map() {.collection-method}

Arr::map 方法遍历数组并将每个键和值传递至给定的回调方法。数组的值将替换为该回调方法返回的值:

use Illuminate\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

Arr::only() {.collection-method}

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() {.collection-method}

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() {.collection-method}

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::prependKeysWith() {.collection-method}

Arr::prependKeysWith 方法为关联数组中的所有键添加给定前缀:

use Illuminate\Support\Arr;

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

$keyed = Arr::prependKeysWith($array, 'product.');

/*
    [
        'product.name' => 'Desk',
        'product.price' => 100,
    ]
*/

Arr::pull() {.collection-method}

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() {.collection-method}

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() {.collection-method}

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() {.collection-method}

Arr::set 方法使用「.」符号在多维数组中设置指定键的值:

use Illuminate\Support\Arr;

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

Arr::set($array, 'products.desk.price', 200);

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

Arr::shuffle() {.collection-method}

Arr::shuffle 方法将数组中值进行随机排序:

use Illuminate\Support\Arr;

$array = Arr::shuffle([1, 2, 3, 4, 5]);

// [3, 2, 5, 1, 4] - (generated randomly)

Arr::sort() {.collection-method}

Arr::sort 方法根据给定数组的值进行升序排序:

use Illuminate\Support\Arr;

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

$sorted = Arr::sort($array);

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

你还可以根据给定回调方法的返回结果对数组进行排序:

use Illuminate\Support\Arr;

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

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

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

Arr::sortDesc() {.collection-method}

Arr::sortDesc 方法根据给定数组的值进行降序排序:

use Illuminate\Support\Arr;

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

$sorted = Arr::sortDesc($array);

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

你还可以根据给定回调方法的返回结果对数组进行排序:

use Illuminate\Support\Arr;

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

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

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

Arr::sortRecursive() {.collection-method}

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() {.collection-method}

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 基于该方法实现 Blade 组件里的条件合并类 以及 @class Blade 指令

Arr::undot() {.collection-method}

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() {.collection-method}

Arr::where 方法使用给定的回调函数返回的结果过滤数组:

use Illuminate\Support\Arr;

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

$filtered = Arr::where($array, function (string|int $value, int $key) {
    return is_string($value);
});

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

Arr::whereNotNull() {.collection-method}

Arr::whereNotNull 方法将从给定数组中删除所有 null 值:

use Illuminate\Support\Arr;

$array = [0, null];

$filtered = Arr::whereNotNull($array);

// [0 => 0]

Arr::wrap() {.collection-method}

Arr::wrap 方法可以将给定值转换为一个数组,如果给定的值已经是一个数组,它将原样返回:

use Illuminate\Support\Arr;

$string = 'Laravel';

$array = Arr::wrap($string);

// ['Laravel']

如果给定值是 null ,将返回一个空数组:

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

data_fill() {#collection-method}

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() {#collection-method}

data_get 函数使用 「.」 符号从多维数组或对象中根据指定键检索值

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

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

// 100

data_get 函数也接受一个默认值,如果没有找到指定的键,将返回默认值:

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

// 0

该函数还接受「*」作为通配符,来指向数组或对象的任何键:

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

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

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

data_set() {#collection-method}

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() {#collection-method}

head 函数将返回数组中的第一个值:

$array = [100, 200, 300];

$first = head($array);

// 100

last() {.collection-method}

last 函数将返回数组中的最后一个值:

$array = [100, 200, 300];

$last = last($array);

// 300

路径

app_path() {.collection-method}

app_path 函数返回 app 目录的完整路径。你也可以使用 app_path 函数来生成应用目录下特定文件的完整路径:

$path = app_path();

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

base_path() {#collection-method}

base_path 函数返回项目根目录的完整路径。你也可以使用 base_path 函数生成项目根目录下特定文件的完整路径:

$path = base_path();

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

config_path() {#collection-method}

config_path 函数返回项目配置目录 (config) 的完整路径。你也可以使用 config_path 函数来生成应用配置目录中的特定文件的完整路径:

$path = config_path();

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

database_path() {.collection-method}

database_path 函数返回 database 目录的完整路径。你可以使用 database_path 函数来生成数据库目录下指定文件的完整路径:

$path = database_path();

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

lang_path() {.collection-method}

The lang_path 函数返回 lang 目录的完整路径。你可以使用 lang_path 函数来生成自定义语言目录下指定文件的完整路径:

$path = lang_path();

$path = lang_path('en/messages.php');

注意
默认情况下,Laravel 框架不包含 lang 目录。如果你想自定义 Laravel 的语言文件,可以通过 Artisan 命令 lang:publish 来发布它们。

mix() {.collection-method}

mix 函数返回 编译前端资源(Mix)的路径,便于加载 css,js 等静态文件:

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

public_path() {.collection-method}

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

$path = public_path();

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

resource_path() {.collection-method}

resource_path 函数返回 resource 目录的完整路径。你可以使用 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() {.collection-method}

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::betweenFirst()

Str::betweenFirst 方法返回字符串在指定两个值之间的最小可能的部分:

use Illuminate\Support\Str;

$slice = Str::betweenFirst('[a] bc [d]', '[', ']');

// 'a'

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() {.collection-method}

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

use Illuminate\Support\Str;

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

// this/string/

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

// this/string/

Str::headline() {.collection-method}

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

use Illuminate\Support\Str;

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

// Steve Jobs

$headline = Str::headline('邮件通知发送');

// 邮件通知发送

Str::inlineMarkdown() {.collection-method}

Str::inlineMarkdown方法使用通用标记将 GitHub 风味 Markdown 转换为内联 HTML。然而,与markdown方法不同的是,它不会将所有生成的 HTML 都包装在块级元素中:

use Illuminate\Support\Str;

$html = Str::inlineMarkdown('**Laravel**');

// <strong>Laravel</strong>

Str::is() {.collection-method}

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

use Illuminate\Support\Str;

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

// true

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

// false

Str::isAscii() {.collection-method}

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

use Illuminate\Support\Str;

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

// true

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

// false

Str::isJson() {.collection-method}

Str::isJson方法确定给定的字符串是否是有效的 JSON:

use Illuminate\Support\Str;

$result = Str::isJson('[1,2,3]');

// true

$result = Str::isJson('{"first": "John", "last": "Doe"}');

// true

$result = Str::isJson('{first: "John", last: "Doe"}');

// false

Str::isUlid() {.collection-method}

Str::isUlid方法用于判断指定字符串是否是有效的 ULID:

use Illuminate\Support\Str;

$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');

// true

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

// false

Str::isUuid() {.collection-method}

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

use Illuminate\Support\Str;

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

// true

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

// false

Str::kebab() {.collection-method}

Str::kebab方法将字符串转换为烤串式( kebab-case )表示方法:

use Illuminate\Support\Str;

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

// foo-bar

Str::lcfirst() {.collection-method}

Str::lcfirst方法返回第一个小写字符的给定字符串:

use Illuminate\Support\Str;

$string = Str::lcfirst('Foo Bar');

// foo Bar

Str::length() {.collection-method}

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

use Illuminate\Support\Str;

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

// 7

Str::limit() {.collection-method}

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

use Illuminate\Support\Str;

$truncated = Str::limit('敏捷的棕色狐狸跳过懒惰的狗', 20);

// 敏捷的棕色狐狸...

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

use Illuminate\Support\Str;

$truncated = Str::limit('敏捷的棕色狐狸跳过懒惰的狗', 20, ' (...)');

// 敏捷的棕色狐狸 (...)

Str::lower() {.collection-method}

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

use Illuminate\Support\Str;

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

// laravel

Str::markdown() {.collection-method}

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() {.collection-method}

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() {.collection-method}

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

use Illuminate\Support\Str;

return (string) Str::orderedUuid();

Str::padBoth() {.collection-method}

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

use Illuminate\Support\Str;

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

// '__James___'

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

// '  James   '

Str::padLeft() {.collection-method}

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

use Illuminate\Support\Str;

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

// '-=-=-James'

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

// '     James'

Str::padRight() {.collection-method}

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

use Illuminate\Support\Str;

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

// 'James-----'

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

// 'James     '

Str::password() {.collection-method}

Str::password方法可用于生成给定长度的安全随机密码。密码由字母、数字、符号和空格组成。默认情况下,密码长度为32位:

use Illuminate\Support\Str;

$password = Str::password();

// 'EbJo2vE-AS:U,$%_gkrV4n,q~1xy/-_4'

$password = Str::password(12);

// 'qwuar>#V|i]N'

Str::plural() {.collection-method}

Str::plural方法将单数形式的字符串转换为复数形式。此方法支持 Laravel 复数形式所支持的任何语言

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() {.collection-method}

Str::pluralStudly方法将以驼峰格式的单数字符串转化为其复数形式。此方法支持 Laravel 复数形式所支持的任何语言

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() {.collection-method}

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

use Illuminate\Support\Str;

$random = Str::random(40);

Str::remove() {.collection-method}

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() {.collection-method}

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

use Illuminate\Support\Str;

$string = 'Laravel 10.x';

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

// Laravel 10.x

Str::replaceArray() {.collection-method}

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

use Illuminate\Support\Str;

$string = '该活动将在 ? 至 ? 举行';

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

// 该活动将在 8:30 至 9:00 举行

Str::replaceFirst() {.collection-method}

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() {.collection-method}

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() {.collection-method}

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

use Illuminate\Support\Str;

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

// dlroW olleH

Str::singular() {.collection-method}

Str::singular 方法将字符串转换为单数形式。此方法支持 Laravel 复数形式所支持的任何语言

use Illuminate\Support\Str;

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

// car

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

// child

Str::slug() {.collection-method}

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

use Illuminate\Support\Str;

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

// laravel-10-framework

Str::snake() {.collection-method}

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

use Illuminate\Support\Str;

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

// foo_bar

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

// foo-bar

Str::squish() {.collection-method}

Str::squish方法删除字符串中所有多余的空白,包括单词之间多余的空白:

use Illuminate\Support\Str;

$string = Str::squish('    laravel    framework    ');

// laravel framework

Str::start() {.collection-method}

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

use Illuminate\Support\Str;

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

// /this/string

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

// /this/string

Str::startsWith() {.collection-method}

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() {.collection-method}

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

use Illuminate\Support\Str;

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

// FooBar

Str::substr() {.collection-method}

Str::substr方法返回由 start 和 length 参数指定的字符串部分:

use Illuminate\Support\Str;

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

// Laravel

Str::substrCount() {.collection-method}

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

use Illuminate\Support\Str;

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

// 2

Str::substrReplace() {.collection-method}

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

use Illuminate\Support\Str;

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

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

Str::swap() {.collection-method}

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

use Illuminate\Support\Str;

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

// Burritos are fantastic!

Str::title() {.collection-method}

Str::title 方法将给定的字符串转换为 Title Case

use Illuminate\Support\Str;

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

// A Nice Title Uses The Correct Case

Str::toHtmlString() {.collection-method}

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

use Illuminate\Support\Str;

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

Str::ucfirst() {.collection-method}

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

use Illuminate\Support\Str;

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

// Foo bar

Str::ucsplit() {.collection-method}

Str::ucsplit 方法将给定的字符串按大写字符拆分为数组:

use Illuminate\Support\Str;

$segments = Str::ucsplit('FooBar');

// [0 => 'Foo', 1 => 'Bar']

Str::upper() {.collection-method}

Str::upper 方法将给定的字符串转换为大写:

use Illuminate\Support\Str;

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

// LARAVEL

Str::ulid() {.collection-method}

Str::ulid 方法生成一个 ULID:

use Illuminate\Support\Str;

return (string) Str::ulid();

// 01gd6r360bp37zj17nxb55yv40

Str::uuid() {.collection-method}

Str::uuid 方法生成一个 UUID(版本 4):

use Illuminate\Support\Str;

return (string) Str::uuid();

Str::wordCount() {.collection-method}

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

use Illuminate\Support\Str;

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

Str::words() {.collection-method}

Str::words 方法限制字符串中的单词数。 可以通过其第三个参数将附加字符串传递给此方法,以指定应将这个字符串附加到截断后的字符串末尾:

use Illuminate\Support\Str;

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

// Perfectly balanced, as >>>

str() {.collection-method}

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

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

// 'Taylor Otwell'

如果没有为 str 函数提供参数,该函数将返回 Illuminate\Support\Str 的实例:

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

// 'foo_bar'

trans() {.collection-method}

trans 函数使用你的 语言文件 翻译给定的翻译键:

     echo trans('messages.welcome');

如果指定的翻译键不存在,trans 函数将返回给定的键。 因此,使用上面的示例,如果翻译键不存在,trans 函数将返回 messages.welcome

trans_choice() {.collection-method}

trans_choice 函数用词形变化翻译给定的翻译键:

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

如果指定的翻译键不存在,trans_choice 函数将返回给定的键。 因此,使用上面的示例,如果翻译键不存在,trans_choice 函数将返回 messages.notifications

字符流处理

Fluent strings 提供了一个更流畅的、面向对象的接口来处理字符串值,与传统的字符串操作相比,允许你使用更易读的语法将多个字符串操作链接在一起。

after {.collection-method}

after 方法返回字符串中给定值之后的所有内容。 如果字符串中不存在该值,则将返回整个字符串:

use Illuminate\Support\Str;

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

// ' my name'

afterLast {.collection-method}

afterLast 方法返回字符串中最后一次出现给定值之后的所有内容。 如果字符串中不存在该值,则将返回整个字符串

use Illuminate\Support\Str;

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

// 'Controller'

append {.collection-method}

append 方法将给定的值附加到字符串:

use Illuminate\Support\Str;

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

// 'Taylor Otwell'

ascii {.collection-method}

ascii 方法将尝试将字符串音译为 ASCII 值:

use Illuminate\Support\Str;

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

// 'u'

basename {.collection-method}

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 {.collection-method}

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

use Illuminate\Support\Str;

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

// 'This is '

beforeLast {.collection-method}

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

use Illuminate\Support\Str;

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

// 'This '

between {.collection-method}

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

use Illuminate\Support\Str;

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

// ' is my '

betweenFirst {.collection-method}

betweenFirst 方法返回两个值之间字符串的最小可能部分:

use Illuminate\Support\Str;

$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');

// 'a'

camel {.collection-method}

camel 方法将给定的字符串转换为 camelCase

use Illuminate\Support\Str;

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

// fooBar

classBasename {.collection-method}

classBasename 方法返回给定类的类名,删除了类的命名空间:

use Illuminate\Support\Str;

$class = Str::of('Foo\Bar\Baz')->classBasename();

// Baz

contains {.collection-method}

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 {.collection-method}

containsAll 方法确定给定字符串是否包含给定数组中的所有值:

use Illuminate\Support\Str;

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

// true

dirname {.collection-method}

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 {.collection-method}

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 {.collection-method}

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 {.collection-method}

exactly 方法确定给定的字符串是否与另一个字符串完全匹配:

use Illuminate\Support\Str;

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

// true

explode {.collection-method}

explode 方法按给定的分隔符拆分字符串并返回包含拆分字符串的每个部分的集合:

use Illuminate\Support\Str;

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

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

finish {.collection-method}

finish 方法将给定值的单个实例添加到字符串中(如果它尚未以该值结尾):
use Illuminate\Support\Str;

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

// this/string/

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

// this/string/

headline {.collection-method}

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

use Illuminate\Support\Str;

$headline = Str::of('taylor_otwell')->headline();

// Taylor Otwell

$headline = Str::of('EmailNotificationSent')->headline();

// Email Notification Sent

inlineMarkdown {.collection-method}

inlineMarkdown 方法使用 CommonMark 将 GitHub 风格的 Markdown 转换为内联 HTML。 但是,与 markdown 方法不同,它不会将所有生成的 HTML 包装在块级元素中:

use Illuminate\Support\Str;

$html = Str::of('**Laravel**')->inlineMarkdown();

// <strong>Laravel</strong>

is {.collection-method}

is 方法确定给定字符串是否与给定模式匹配。 星号可用作通配符值

use Illuminate\Support\Str;

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

// true

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

// false

isAscii {.collection-method}

isAscii 方法确定给定字符串是否为 ASCII 字符串:

use Illuminate\Support\Str;

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

// true

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

// false

isEmpty {.collection-method}

isEmpty 方法确定给定的字符串是否为空:

use Illuminate\Support\Str;

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

// true

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

// false

isNotEmpty {.collection-method}

isNotEmpty 方法确定给定的字符串是否不为空:

use Illuminate\Support\Str;

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

// false

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

// true

isJson {.collection-method}

isJson 方法确定给定的字符串是否是有效的 JSON:

use Illuminate\Support\Str;

$result = Str::of('[1,2,3]')->isJson();

// true

$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();

// true

$result = Str::of('{first: "John", last: "Doe"}')->isJson();

// false

isUlid {.collection-method}

isUlid 方法确定给定的字符串是否一个 ULID:

use Illuminate\Support\Str;

$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();

// true

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

// false

isUuid {.collection-method}

isUuid 方法确定给定的字符串是否是一个 UUID:

use Illuminate\Support\Str;

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

// true

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

// false

kebab {.collection-method}

kebab 方法转变给定的字符串为 kebab-case:

use Illuminate\Support\Str;

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

// foo-bar

lcfirst {.collection-method}

lcfirst 方法返回给定的字符串的第一个字符为小写字母:

use Illuminate\Support\Str;

$string = Str::of('Foo Bar')->lcfirst();

// foo Bar

length {.collection-method}

length 方法返回给定字符串的长度:

use Illuminate\Support\Str;

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

// 7

limit {.collection-method}

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 {.collection-method}

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

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

// tayl**********.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']);

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

isMatch

isMatch 方法用于判断给定的字符串是否与正则表达式匹配:

use Illuminate\Support\Str;

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

// true

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

// false

newLine

newLine 方法将给字符串追加换行的字符:

use Illuminate\Support\Str;

$padded = Str::of('Laravel')->newLine()->append('Framework');

// 'Laravel
//  Framework'

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;
use Illuminate\Support\Stringable;

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

// 'Checksum: a5c95b86291ea299fcbe64458ed12702'

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

// 'bar'

plural

plural 方法将单数形式的字符串转换为复数形式。该此函数支持 Laravel的复数化器支持的任何语言

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 9.x')->replace('9.x', '10.x');

// Laravel 10.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;
use Illuminate\Support\Stringable;

$replaced = Str::of('123')->replaceMatches('/\d/', function (Stringable $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 方法根据 PHP 函数 sscanf 支持的格式把字符串中的输入解析为集合:

use Illuminate\Support\Str;

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

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

singular

singular 方法将字符串转换为其单数形式。此函数支持 Laravel的复数化器支持的任何语言

use Illuminate\Support\Str;

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

// car

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

// child

slug {.collection-method}

slug 方法从给定字符串生成 URL 友好的 “slug”:

use Illuminate\Support\Str;

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

// laravel-framework

snake {.collection-method}

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

use Illuminate\Support\Str;

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

// foo_bar

split {.collection-method}

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

use Illuminate\Support\Str;

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

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

squish {.collection-method}

squish 方法删除字符串中所有无关紧要的空白,包括字符串之间的空白:

use Illuminate\Support\Str;

$string = Str::of('    laravel    framework    ')->squish();

// laravel framework

start {.collection-method}

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

use Illuminate\Support\Str;

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

// /this/string

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

// /this/string

startsWith {.collection-method}

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

use Illuminate\Support\Str;

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

// true

studly {.collection-method}

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

use Illuminate\Support\Str;

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

// FooBar

substr {.collection-method}

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

use Illuminate\Support\Str;

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

// Framework

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

// Frame

substrReplace {.collection-method}

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 {.collection-method}

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

use Illuminate\Support\Str;

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

// Burritos are fantastic!

tap {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// LARAVEL FRAMEWORK

test {.collection-method}

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

use Illuminate\Support\Str;

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

// true

title {.collection-method}

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 {.collection-method}

trim 方法修剪给定字符串:

use Illuminate\Support\Str;

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

// 'Laravel'

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

// 'Laravel'

ucfirst {.collection-method}

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

use Illuminate\Support\Str;

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

// Foo bar

ucsplit {.collection-method}

ucsplit 方法将给定的字符串按大写字符分割为一个集合:

use Illuminate\Support\Str;

$string = Str::of('Foo Bar')->ucsplit();

// collect(['Foo', 'Bar'])

upper {.collection-method}

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

use Illuminate\Support\Str;

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

// LARAVEL

when {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Taylor Otwell'

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

whenContains {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Tony Stark'

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

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// Tony Stark

whenContainsAll {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Tony Stark'

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

whenEmpty {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Laravel'

whenNotEmpty {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Laravel Framework'

whenStartsWith {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Disney World'

whenEndsWith {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Disney World'

whenExactly {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Laravel'

whenNotExactly {.collection-method}

如果字符串与给定字符串不完全匹配,whenNotExactly方法将调用给定的闭包。闭包将接收字符流处理实例:

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Framework'

whenIs {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'foo/bar/baz'

whenIsAscii {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Laravel'

whenIsUlid {.collection-method}

如果字符串是有效的 ULID,whenIsUlid 方法会调用给定的闭包。闭包将接收字符流处理实例:

use Illuminate\Support\Str;

$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
    return $string->substr(0, 8);
});

// '01gd6r36'

whenIsUuid {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'a0a2a2d2'

whenTest {.collection-method}

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

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

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

// 'Laravel Framework'

wordCount {.collection-method}

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

use Illuminate\Support\Str;

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

words {.collection-method}

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

use Illuminate\Support\Str;

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

// Perfectly balanced, as >>>

URLs

action() {.collection-method}

action 函数为给定的控制器操作生成 URL:

use App\Http\Controllers\HomeController;

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

如果该方法接受路由参数,则可以将它们作为第二个参数传递给该方法:

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

asset() {.collection-method}

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() {.collection-method}

route 函数为给定的 命名路由

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

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

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

默认情况下,route 函数会生成一个绝对路径的 URL。 如果想生成一个相对路径 URL,你可以传递 false 作为函数的第三个参数:

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

secure_asset() {.collection-method}

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

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

secure_url() {.collection-method}

secure_url 函数生成给定路径的完全限定 HTTPS URL。 可以在函数的第二个参数中传递额外的 URL 段:

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

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

to_route() {.collection-method}

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() {.collection-method}

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

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

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

如果未提供路径,则返回一个 Illuminate\Routing\UrlGenerator 实例:

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

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

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

杂项

abort() {.collection-method}

使用abort 函数抛出一个 HTTP 异常 交给 异常处理

abort(403);

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

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

abort_if() {.collection-method}

如果给定的布尔表达式的计算结果为 true,则 abort_if 函数会抛出 HTTP 异常:

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

abort 方法一样,你还可以提供异常的响应文本作为函数的第三个参数,并提供自定义响应标头数组作为函数的第四个参数。

abort_unless() {.collection-method}

如果给定的布尔表达式的计算结果为 false,则 abort_unless 函数会抛出 HTTP 异常:

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

abort 方法一样,你还可以提供异常的响应文本作为函数的第三个参数,并提供自定义响应标头数组作为函数的第四个参数。

app() {.collection-method}

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

$container = app();

你可以传递一个类或接口名称以从容器中解析它:

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

auth() {.collection-method}

auth 函数返回一个 authenticator 实例。 你可以将它用作 Auth 门面的替代品:

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

如果需要,你可以指定要访问的守卫实例:

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

back() {.collection-method}

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

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

return back();

bcrypt() {.collection-method}

bcrypt 函数 hashes 使用 Bcrypt 的给定值。 您可以使用此函数作为 Hash 门面的替代方法:

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

blank() {.collection-method}

blank 函数确定给定值是否为「空白」:

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

// true

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

// false

对于 blank 的反转,请参阅 filled 方法。

broadcast() {.collection-method}

broadcast 函数 broadcasts 给定的 event 给它的听众:

broadcast(new UserRegistered($user));

broadcast(new UserRegistered($user))->toOthers();

cache() {.collection-method}

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

$value = cache('key');

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

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

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

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

class_uses_recursive() {.collection-method}

class_uses_recursive 函数返回一个类使用的所有特征,包括其所有父类使用的特征:

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

collect() {.collection-method}

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

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

config() {.collection-method}

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

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

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

你可以通过传递键/值对数组在运行时设置配置变量。 但是请注意,此函数只会影响当前请求的配置值,不会更新您的实际配置值:

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

cookie() {.collection-method}

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

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

csrf_field() {.collection-method}

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

{{ csrf_field() }}

csrf_token() {.collection-method}

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

$token = csrf_token();

decrypt() {.collection-method}

decrypt 函数 解密 给定的值。 你可以使用此函数作为 Crypt 门面的替代方法:

$password = decrypt($value);

dd() {.collection-method}

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

dd($value);

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

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

dispatch() {.collection-method}

dispatch 函数将给定的 job 推送到 Laravel job queue

dispatch(new App\Jobs\SendEmails);

dump() {.collection-method}

dump 函数转储给定的变量:

dump($value);

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

如果要在转储变量后停止执行脚本,请改用 dd 函数。

encrypt() {.collection-method}

encrypt 函数 encrypts 给定值。 你可以使用此函数作为 Crypt 门面的替代方法:

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

env() {.collection-method}

env 函数检索 环境变量 的值或返回默认值:

$env = env('APP_ENV');

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

警告
如果你在部署过程中执行 config:cache 命令,你应该确保只从配置文件中调用 env 函数。 一旦配置被缓存,.env 文件将不会被加载,所有对 env 函数的调用都将返回 null

event() {.collection-method}

event 函数将给定的 event 分派给它的监听器:

event(new UserRegistered($user));

fake() {.collection-method}

fake 函数解析容器中的 Faker 单例,这在模型工厂、数据库填充、测试和原型视图中创建假数据时非常有用:

@for($i = 0; $i < 10; $i++)
    <dl>
        <dt>Name</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>Email</dt>
        <dd>{{ fake()->unique()->safeEmail() }}</dd>
    </dl>
@endfor

默认情况下,fake 函数将使用 config/app.php 配置文件中的 app.faker_locale 配置选项; 但是,你也可以通过将语言环境传递给 fake 函数来指定语言环境。 每个语言环境将解析一个单独的单例:

fake('nl_NL')->name()

filled() {.collection-method}

filled 函数确定给定值是否不是「空白」:

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

// true

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

// false

对于 filled 的反转,请参阅 blank 方法。

info() {.collection-method}

info 函数会将信息写入应用程序的 log

info('Some helpful information!');

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

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

logger() {.collection-method}

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

logger('Debug message');

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

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

如果没有值传递给函数,将返回一个 logger 实例:

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

method_field() {.collection-method}

method_field 函数生成一个 HTML hidden 输入字段,其中包含表单 HTTP 谓词的欺骗值。 例如,使用 Blade 语法

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

now() {.collection-method}

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

$now = now();

old() {.collection-method}

old 函数 retrieves 一个 old input 值闪入Session :

$value = old('value');

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

由于作为 old 函数的第二个参数提供的「默认值」通常是 Eloquent 模型的一个属性,Laravel 允许你简单地将整个 Eloquent 模型作为第二个参数传递给 old 函数。 这样做时,Laravel 将假定提供给 old 函数的第一个参数是 Eloquent 属性的名称,该属性应被视为「默认值」:

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

// 相当于...

{{ old('name', $user) }}

optional() {.collection-method}

optional 函数接受任何参数并允许您访问该对象的属性或调用方法。 如果给定对象为「null」,属性和方法将返回「null」而不是导致错误:

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

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

optional 函数也接受一个闭包作为它的第二个参数。 如果作为第一个参数提供的值不为空,则将调用闭包:

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

policy() {.collection-method}

policy 方法检索给定类的 policy 实例:

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

redirect() {.collection-method}

redirect 函数返回一个重定向 HTTP 响应,或者如果不带参数调用则返回重定向器实例:

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

return redirect('/home');

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

report() {.collection-method}

report 函数将使用您的 异常处理程序 报告异常:

report($e);

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

report('Something went wrong.');

report_if() {.collection-method}

如果给定条件为「true」,「report_if」函数将使用您的 异常处理程序 报告异常:

report_if($shouldReport, $e);

report_if($shouldReport, 'Something went wrong.');

report_unless() {.collection-method}

如果给定条件为 falsereport_unless 函数将使用你的 异常处理程序 报告异常:

report_unless($reportingDisabled, $e);

report_unless($reportingDisabled, 'Something went wrong.');

request() {.collection-method}

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

$request = request();

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

rescue() {.collection-method}

rescue 函数执行给定的闭包并捕获其执行期间发生的任何异常。 捕获的所有异常都将发送到你的异常处理程序; 但是,请求将继续处理:

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

你还可以将第二个参数传递给「rescue」函数。 如果在执行闭包时发生异常,这个参数将是应该返回的「默认」值:

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

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

resolve() {.collection-method}

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

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

response() {.collection-method}

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

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

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

retry() {.collection-method}

retry 函数尝试执行给定的回调,直到达到给定的最大尝试阈值。 如果回调没有抛出异常,则返回它的返回值。 如果回调抛出异常,它会自动重试。 如果超过最大尝试次数,将抛出异常:

return retry(5, function () {
    // 尝试 5 次,两次尝试之间休息 100 ms...
}, 100);

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

use Exception;

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

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

return retry([100, 200], function () {
    // 第一次重试时休眠 100 ms,第二次重试时休眠 200 ms...
});

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

use Exception;

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

session() {.collection-method}

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

$value = session('key');

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

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

如果没有值传递给函数,会话存储将被返回:

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

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

tap() {.collection-method}

tap 函数接受两个参数:一个任意的 $value 和一个闭包。 $value 将传递给闭包,然后由 tap 函数返回。 闭包的返回值是无关紧要的:

$user = tap(User::first(), function (User $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 trait。 这个特征的 tap 方法接受一个闭包作为它唯一的参数。 对象实例本身将被传递给闭包,然后由 tap 方法返回:

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

throw_if() {.collection-method}

如果给定的布尔表达式的计算结果为「真」,则 throw_if 函数会抛出给定的异常:

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

throw_if(
    ! Auth::user()->isAdmin(),
    AuthorizationException::class,
    '你不允许访问此页面。'
);

throw_unless() {.collection-method}

如果给定的布尔表达式的计算结果为 false,则 throw_unless 函数会抛出给定的异常:

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

throw_unless(
    Auth::user()->isAdmin(),
    AuthorizationException::class,
    '你不允许访问此页面。'
);

today() {.collection-method}

today 函数根据当前日期创建新的 Illuminate\Support\Carbon 实例:

$today = today();

trait_uses_recursive() {.collection-method}

trait_uses_recursive 函数返回特征使用的所有 trait:

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

transform() {.collection-method}

如果值不是 blank,则 transform 函数会对给定值执行闭包,然后返回闭包的返回值:

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

$result = transform(5, $callback);

// 10

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

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

// The value is blank

validator() {.collection-method}

validator 函数使用给定的参数创建一个新的 validator 实例。 你可以将它用作 Validator 门面的替代品:

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

value() {.collection-method}

value 函数返回给定的值。 但是,如果将闭包传递给函数,则将执行闭包并返回其返回值:

$result = value(true);

// true

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

// false

可以将其他参数传递给「value」函数。 如果第一个参数是一个闭包,那么附加参数将作为参数传递给闭包,否则它们将被忽略:

$result = value(function (string $name) {
    return $name;
}, 'Taylor');

// 'Taylor'

view() {.collection-method}

view 函数检索一个 view 实例:

return view('auth.login');

with() {.collection-method}

with 函数返回给定的值。 如果将闭包作为函数的第二个参数传递,则将执行闭包并返回其返回值:

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

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5

其他

基准测试

有时你可能希望快速测试应用程序某些部分的性能。 在这些情况下,您可以使用 Benchmark 支持类来测量给定回调完成所需的毫秒数:

<?php

use App\Models\User;
use Illuminate\Support\Benchmark;

Benchmark::dd(fn () => User::find(1)); // 0.1 ms

Benchmark::dd([
    'Scenario 1' => fn () => User::count(), // 0.5 ms
    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);

默认情况下,给定的回调将执行一次(一次迭代),并且它们的持续时间将显示在浏览器/控制台中。

要多次调用回调,你可以将回调应调用的迭代次数指定为方法的第二个参数。 当多次执行回调时,「基准」类将返回在所有迭代中执行回调所花费的平均毫秒数:

Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms

管道

Laravel 的 Pipeline 门面提供了一种便捷的方式来通过一系列可调用类、闭包或可调用对象「管道」给定输入,让每个类都有机会检查或修改输入并调用管道中的下一个可调用对象:

use Closure;
use App\Models\User;
use Illuminate\Support\Facades\Pipeline;

$user = Pipeline::send($user)
        ->through([
            function (User $user, Closure $next) {
                // ...

                return $next($user);
            },
            function (User $user, Closure $next) {
                // ...

                return $next($user);
            },
        ])
        ->then(fn (User $user) => $user);

如你所见,管道中的每个可调用类或闭包都提供了输入和一个 $next 闭包。 调用 $next 闭包将调用管道中的下一个可调用对象。 你可能已经注意到,这与 middleware 非常相似。

当管道中的最后一个可调用对象调用 $next 闭包时,提供给 then 方法的可调用对象将被调用。 通常,此可调用对象将简单地返回给定的输入。

当然,如前所述,你不仅限于为管道提供闭包。 你还可以提供可调用的类。 如果提供了类名,该类将通过 Laravel 的 服务容器 实例化,允许将依赖项注入可调用类:

$user = Pipeline::send($user)
        ->through([
            GenerateProfilePhoto::class,
            ActivateSubscription::class,
            SendWelcomeEmail::class,
        ])
        ->then(fn (User $user) => $user);

彩票

Laravel 的 Lottery 类可用于根据一组给定的赔率执行回调。 当你只想为一定比例的传入请求执行代码时,这会特别有用:

use Illuminate\Support\Lottery;

Lottery::odds(1, 20)
    ->winner(fn () => $user->won())
    ->loser(fn () => $user->lost())
    ->choose();

你可以将 Laravel 的彩票类与其他 Laravel 功能结合使用。 例如,你可能希望只向异常处理程序报告一小部分慢速查询。 而且,由于 Lottery 类是可调用的,我们可以将类的实例传递给任何接受可调用对象的方法:

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;

DB::whenQueryingForLongerThan(
    CarbonInterval::seconds(2),
    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);

测试彩票

Laravel 提供了一些简单的方法来让你轻松测试应用程序的 Lottery 调用:

// 彩票总是取胜...
Lottery::alwaysWin();

// 彩票总是获败...
Lottery::alwaysLose();

// 彩票会先赢后输,最后恢复到正常行为...
Lottery::fix([true, false]);

// 彩票将恢复到正常行为...
Lottery::determineResultsNormally();

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/laravel/10.x/he...

译文地址:https://learnku.com/docs/laravel/10.x/he...

上一篇 下一篇
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
贡献者:16
讨论数量: 0
发起讨论 只看当前版本


暂无话题~