ヘルパ 10.x Laravel

イントロダクション

Laravelはさまざまな、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。

使用可能なメソッド

配列とオブジェクト

パス

app_path base_path config_path database_path lang_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::betweenFirst Str::camel Str::contains Str::containsAll Str::endsWith Str::excerpt Str::finish Str::headline Str::inlineMarkdown Str::is Str::isAscii Str::isJson Str::isUlid Str::isUuid Str::kebab Str::lcfirst Str::length Str::limit Str::lower Str::markdown Str::mask Str::orderedUuid Str::padBoth Str::padLeft Str::padRight Str::password Str::plural Str::pluralStudly Str::random Str::remove Str::replace Str::replaceArray Str::replaceFirst Str::replaceLast Str::reverse Str::singular Str::slug Str::snake Str::squish Str::start Str::startsWith Str::studly Str::substr Str::substrCount Str::substrReplace Str::swap Str::title Str::toHtmlString Str::ucfirst Str::ucsplit Str::upper Str::ulid Str::uuid Str::wordCount Str::words str trans trans_choice

Fluent文字列

URL

action asset route secure_asset secure_url to_route url

その他

メソッド一覧

配列とオブジェクト

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

Arr::addメソッドは指定キー／値のペアをそのキーが存在していない場合とnullがセットされている場合に、配列に追加します。

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 (int $value, int $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を返します。配列が0から始まる連続したキーを持たない場合、その配列を「連想配列」であると見なします。

use Illuminate\Support\Arr;

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

// true

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

// false

`Arr::isList()`

Arr::isListメソッドは、指定した配列のキーが0から始まる連続した整数である場合、trueを返します。

use Illuminate\Support\Arr;

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

// true

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

// false

`Arr::join()`

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

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

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

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

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

Arr::prependKeysWithは、連想配列のすべてのキー名の前に、指定したプレフィックスを付加します。

use Illuminate\Support\Arr;

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

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

/*
    [
        'product.name' => 'Desk',
        'product.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] - (無作為に入れ替えた結果)

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

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

`Arr::sortDesc()`

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

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クラス文字列を条件付きでコンパイルします。この方法はクラスの配列を引数に取り、配列キーに追加したいクラス、値は論理式です。配列要素に数字キーがある場合は、レンダするクラスリストへ常に含めます。

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

このメソッドは、Bladeコンポーネントのアトリビュートバッグを使ったクラスのマージと、@class Bladeディレクティブを提供するLaravelの機能を強化します。

`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 (string|int $value, int $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

data_get関数は、指定したキーが存在しない場合に返す、デフォルト値も指定できます。

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

// 0

配列やオブジェクトのいずれのキーにもマッチする、ワイルドカードとしてアスタリスクも使用できます。

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

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

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

`data_set()`

data_set関数は「ドット」記法を使用し、ネストした配列やオブジェクトに値をセットします。

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

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

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

この関数は、アスタリスクを使用したワイルドカードも受け入れ、それに応じてターゲットに値を設定します。

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

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

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

デフォルトでは、既存の値はすべて上書きされます。値が存在しない場合にのみ値をセットする場合は、関数の4番目の引数に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');

`lang_path()`

lang_path関数は、アプリケーションのlangディレクトリの完全修飾パスを返します。また、lang_path関数を使用して、ディレクトリ内の指定したファイルの完全修飾パスを生成することもできます。

$path = lang_path();

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

Note: Laravelアプリケーションのスケルトンは、デフォルトでlangディレクトリを用意していません。Laravelの言語ファイルをカスタマイズしたい場合は、lang:publish Artisanコマンドでリソース公開することができます。

`mix()`

mix関数は、バージョンつけしたMixファイルのパスを取得します。

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

`public_path()`

public_path関数は、アプリケーションのpublicディレクトリへの完全修飾パスを返します。public_path関数を使用して、パブリックディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。

$path = public_path();

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

`resource_path()`

resource_path関数は、アプリケーションのresourcesディレクトリへの完全修飾パスを返します。resource_path関数を使用して、リソースディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。

$path = resource_path();

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

`storage_path()`

storage_path関数は、アプリケーションのstorageディレクトリへの完全修飾パスを返します。storage_path関数を使用して、ストレージディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。

$path = storage_path();

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

文字列

`__()`

__関数は、指定する翻訳文字列や翻訳キーを言語ファイルを使って翻訳します。

echo __('Welcome to our application');

echo __('messages.welcome');

指定した翻訳文字列や翻訳キーが存在しない場合、__関数は指定値をそのまま返します。たとえば、上記の場合に翻訳キーが存在しなければ、__関数はmessages.welcomeを返します。

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

Str::betweenFirstメソッドは、２つの値の間にある文字列のうち、可能な限り小さい部分を返します。

use Illuminate\Support\Str;

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

// 'a'

`Str::camel()`

Str::camelメソッドは、文字列をキャメルケース（camelCase）へ変換します。

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

Str::inlineMarkdownメソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdownメソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。

use Illuminate\Support\Str;

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

// <strong>Laravel</strong>

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

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

Str::isUlidメソッドは、指定文字列が有効なULIDであることを判定します。

use Illuminate\Support\Str;

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

// true

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

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

Str::lcfirstメソッドは、指定した文字列の最初の文字を小文字に変換して返します。

use Illuminate\Support\Str;

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

// 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風なマークダウンをHTMLへ、CommonMarkを用い変換します。

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

String::padLeftメソッドは、PHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。

use Illuminate\Support\Str;

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

// '-=-=-James'

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

// '     James'

`Str::padRight()`

String::padRightメソッドは、PHPのstr_pad関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。

use Illuminate\Support\Str;

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

// 'James-----'

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

// 'James     '

`Str::password()`

Str::passwordメソッドは、指定した長さの安全でランダムなパスワードを生成します。パスワードは文字、数字、シンボル、スペースの組み合わせで構成します。パスワードの長さは、デフォルトで３２文字です。

use Illuminate\Support\Str;

$password = Str::password();

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

$password = Str::password(12);

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

`Str::plural()`

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

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

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.

文字列を削除するときにケースを無視するには、removeメソッドの３番目の引数にfalseを渡してください。

`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メソッドは複数形を単数形へ変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。

use Illuminate\Support\Str;

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

// car

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

// child

`Str::slug()`

Str::slugメソッドは指定された文字列から、URLフレンドリーな「スラグ」を生成します。

use Illuminate\Support\Str;

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

// laravel-5-framework

`Str::snake()`

Str::snakeメソッドは文字列をスネークケース（snake_case）に変換します。

use Illuminate\Support\Str;

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

// foo_bar

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

// foo-bar

`Str::squish()`

Str::squishメソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。

use Illuminate\Support\Str;

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

// laravel framework

`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メソッドは文字列をアッパーキャメルケース（StudlyCase）に変換します。

use Illuminate\Support\Str;

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

// FooBar

`Str::substr()`

Str::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メソッドは、指定された文字列をタイトルケース（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()`

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

Str::ucsplitメソッドは、指定した文字列を文字列を大文字で分割して配列にします。

use Illuminate\Support\Str;

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

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

`Str::upper()`

Str::upperメソッドは、指定文字列を大文字に変換します。

use Illuminate\Support\Str;

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

// LARAVEL

`Str::ulid()`

Str::ulidメソッドは、ULIDを生成します。

use Illuminate\Support\Str;

return (string) Str::ulid();

// 01gd6r360bp37zj17nxb55yv40

`Str::uuid()`

Str::uuidメソッドは、UUID（バージョン４）を生成します。

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メソッドは、文字列内の単語数を制限します。3番目の引数で、切り捨てた文字列の末尾に追加する文字列を指定できます。

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

trans関数は、指定した翻訳キーを言語ファイルを使い、翻訳します。

echo trans('messages.welcome');

指定した翻訳キーが存在しない場合、trans関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcomeが返ります。

`trans_choice()`

trans_choice関数は、数値をもとにし、指定翻訳キーを翻訳します。

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

指定した翻訳キーが存在しない場合、trans_choice関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcomeが返ります。

Fluent文字列

Fluent文字列は読み書きしやすい（fluent）、オブジェクト指向で、複数の文字列操作をチェーンできるインターフェイスを提供します。古典的な文字列操作に比較すると、複数の文字列操作を読みやすい文法で使用できます。

`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メソッドは、文字列をアスキー値への変換を試みます。

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 '

`betweenFirst`

betweenFirstメソッドは、2つの値の間にある文字列のうち、可能な限り小さい部分を返します。

use Illuminate\Support\Str;

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

// 'a'

`camel`

camelメソッドは、文字列をキャメルケース（camelCase）へ変換します

use Illuminate\Support\Str;

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

// fooBar

`classBasename`

classBasenameメソッドは、指定したクラスから名前空間を削除したクラス名を返す。

use Illuminate\Support\Str;

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

// Baz

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

`headline`

headlineメソッドは、大小文字、ハイフン、アンダースコアで区切られた文字列の各単語の頭文字を大文字にし、スペースで区切った文字列へ変換します。

use Illuminate\Support\Str;

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

// Taylor Otwell

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

// Email Notification Sent

`inlineMarkdown`

inlineMarkdownメソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdownメソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。

use Illuminate\Support\Str;

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

// <strong>Laravel</strong>

`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

`isJson`

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`

isUlidメソッドは、指定文字列が有効なULIDであることを判定します。

use Illuminate\Support\Str;

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

// true

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

// false

`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

`lcfirst`

lcfirstメソッドは、指定した文字列の最初の文字を小文字にしたものを返します。

use Illuminate\Support\Str;

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

// 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風マークダウンを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'])

正規表現にマッチンググループを指定した場合は、そのグループに一致するコレクションを返します。

use Illuminate\Support\Str;

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

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

一致しなかった場合は、空のコレクションを返します。

`isMatch`

isMatchメソッドは、文字列が指定正規表現にマッチした場合にtrueを返します。

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`

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メソッドは、現在の値を指定Callableへ渡すことで、文字列を変換します。

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 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;
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 メソッドは、sscanf PHP関数がサポートするフォーマットに従い、文字列からコレクションへの入力をパースします。

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`

slugメソッドは、文字列をURLフレンドリーな「スラグ」へ変換します。

use Illuminate\Support\Str;

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

// laravel-framework

`snake`

The snake method converts the given string to 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"])

`squish`

squishメソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。

use Illuminate\Support\Str;

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

// laravel framework

`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メソッドは、文字列の一部分のテキストを置き換えるもので、第２引数で指定した位置から始まり、第３引数で指定した文字数分を置き換えます。このメソッドの第3引数に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;
use Illuminate\Support\Stringable;

$string = Str::of('Laravel')
    ->append(' Framework')
    ->tap(function (Stringable $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

`ucsplit`

ucsplitメソッドは、指定した文字列を文字列を大文字で分割して配列にします。

use Illuminate\Support\Str;

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

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

`upper`

upperメソッドは、文字列を大文字に変換します。

use Illuminate\Support\Str;

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

// LARAVEL

`when`

whenメソッドは指定条件がtrueの場合、指定したクロージャを呼び出します。クロージャは、fluent文字列インスタンスを受け取ります。

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`

whenContainsメソッドは、文字列が指定値を含んでいる場合に、渡したクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。

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

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

// 'Tony Stark'

必要であれば、whenメソッドの第３パラメータへ、もう一つクロージャを渡せます。このクロージャは、文字列が指定値を含んでいない場合に実行されます。

値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。

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`

whenContainsAllメソッドは、文字列が指定する部分文字列をすべて含んでいる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。

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

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

// 'Tony Stark'

`whenEmpty`

文字列が空の場合、whenEmptyメソッドは指定されたクロージャを呼び出します。クロージャが値を返す場合、その値をwhenEmptyメソッドも返します。クロージャが値を返さない場合、fluent文字列インスタンスを返します。

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

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

// 'Laravel'

`whenNotEmpty`

whenNotEmptyメソッドは文字列が空でない場合、指定するクロージャを呼び出します。クロージャが値を返す場合は、whenNotEmptyメソッドもその値を返します。クロージャが値を返さない場合は、Fluent文字列インスタンスを返します。

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

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

// 'Laravel Framework'

`whenStartsWith`

whenStartsWithメソッドは、文字列が指定する部分文字列から始まる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。

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

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

// 'Disney World'

`whenEndsWith`

whenEndsWithメソッドは、文字列が指定した部分文字列で終了する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。

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

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

// 'Disney World'

`whenExactly`

whenExactlyメソッドは、文字列が指定文字列と厳密に一致する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。

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

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

// 'Laravel'

`whenNotExactly`

whenNotExactlyメソッドは、文字列が指定文字列と厳密に一致しない場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。

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

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

// 'Framework'

`whenIs`

whenIsメソッドは、文字列が与えられたパターンにマッチする場合、指定クロージャを呼び出します。アスタリスクはワイルドカードとして使用できます。クロージャはFluent文字列インスタンスを受け取ります。

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`

whenIsAsciiメソッドは、文字列が7bitのASCIIの場合、クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。

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

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

// 'Laravel'

`whenIsUlid`

whenIsUlidメソッドは、文字列が有効なULIDである場合、指定するクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。

use Illuminate\Support\Str;

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

// '01gd6r36'

`whenIsUuid`

whenIsUuidメソッドは、文字列が有効なUUIDである場合、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。

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`

whenTestメソッドは、文字列が正規表現にマッチする場合、指定クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。

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

$string = Str::of('laravel framework')->whenTest('/laravel/', function (Stringable $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 >>>

URL

`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ホストを設定できます。これは、AmazonS3や別のCDNなどの外部サービスでアセットをホストする場合に役立ちます。

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

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

`route()`

route関数は、指定した名前付きルートのURLを生成します。

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

ルートがパラメーターを受け入れる場合は、それらを関数の２番目の引数として渡すことができます。

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

デフォルトでは、route関数は絶対URLを生成します。相対URLを生成する場合は、関数の３番目の引数としてfalseを渡してください。

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

`secure_asset()`

secure_asset関数はHTTPSを使い、アセットへのURLを生成します。

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

必要であれば、to_routeメソッドの第３，第４引数へ、リダイレクトに割り当てるHTTPステータスコードと、追加のレスポンスヘッダを指定できます。

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

abort_if関数は、指定された論理値がtrueと評価された場合に、HTTP例外を投げます。

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

abortメソッドと同様に、例外の応答テキストを３番目の引数として指定し、カスタム応答ヘッダの配列を４番目の引数として関数に指定することもできます。

`abort_unless()`

abort_unless関数は、指定した論理値がfalseと評価された場合に、HTTP例外を投げます。

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

`app()`

app関数は、サービスコンテナのインスタンスを返します。

$container = app();

コンテナにより依存解決する、クラス名かインターフェイス名を渡すこともできます。

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

`auth()`

auth関数は、Authenticatorインスタンスを返します。Authファサードの代わりに使用できます。

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

必要であれば、アクセスしたいガードインスタンスを指定することもできます。

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

`back()`

back関数はユーザーの直前のロケーションへのリダイレクトHTTPレスポンスを生成します。

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

return back();

`bcrypt()`

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 = class_uses_recursive(App\Models\User::class);

`collect()`

collect関数は、指定値からコレクションインスタンスを生成します。

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

`config()`

config関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。

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

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

キー／値ペアの配列を渡すことにより、実行時に設定変数を設定できます。ただし、この関数は現在のリクエストの設定値にのみ影響し、実際の設定値は更新しないことに注意してください。

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

`cookie()`

cookie関数は新しいクッキーインスタンスを生成します。

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

`csrf_field()`

csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。

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

Warning!! 開発期間中にconfig:cacheコマンドを実行する場合は、設定ファイルの中で必ずenv関数だけを使用してください。設定ファイルがキャッシュされると、.envファイルはロードされなくなり、env関数の呼び出しはすべてnullを返します。

`event()`

event関数は、指定したイベントをリスナにディスパッチします。

event(new UserRegistered($user));

`fake()`

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

filled関数は、指定された値が「空白」でないかどうかを判別します。

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

// true

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

// false

filledの逆の動作は、blankメソッドです。

`info()`

info関数は、アプリケーションのログへ情報を書き込みます。

info('Some helpful information!');

関連情報の配列を関数へ渡すこともできます。

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

`logger()`

logger関数は、debugレベルのメッセージをログへ書き出します。

logger('Debug message');

関連情報の配列を関数へ渡すこともできます。

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

関数に値を渡さない場合は、ロガーインスタンスが返されます。

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

`method_field()`

method_field関数はフォームのHTTP動詞の見せかけの値を保持する「隠し」HTTP入力フィールドを生成します。Blade記法を使う例です。

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

`now()`

now関数は、現時点を表す新しいIlluminate\Support\Carbonインスタンスを生成します。

$now = now();

`old()`

old関数はセッションに一時保持データーとして保存されている直前の入力値を取得します。

$value = old('value');

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

old関数の第２引数として指定される「デフォルト値」は、Eloquentモデルの属性であることが多いため、LaravelではEloquentモデル全体をold関数の第２引数として渡せるようになっています。この場合、Laravelはold関数に渡された最初の引数を「デフォルト値」とみなすべきEloquent属性の名前として扱います。

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

// 上記は下記と同じ

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

`optional()`

optional関数はどんな引数も指定でき、そのオブジェクトのプロパティへアクセスするか、メソッドを呼び出せます。指定したオブジェクトがnullだった場合、エラーを発生させる代わりに、プロパティとメソッドはnullを返します。

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

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

optional関数は、２番目の引数としてクロージャも受け入れます。最初の引数として指定された値がnullでない場合、クロージャが呼び出されます。

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

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

report関数は文字列を引数に取ります。関数に文字列が与えられると、関数は指定する文字列をメッセージとする例外を作成します。

report('Something went wrong.');

`report_if()`

report_if関数は、指定条件がtrueであれば、あなたの例外ハンドラを使って例外を報告します。

report_if($shouldReport, $e);

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

`report_unless()`

report_unless関数は、指定条件がfalseであれば、あなたの例外ハンドラを使って例外を報告します。

report_unless($reportingDisabled, $e);

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

`request()`

request関数は、現在のrequestインスタンスを返すか、現在のリクエストから入力フィールドの値を取得します。

$request = request();

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

`rescue()`

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

resolve関数は、サービスコンテナを使用して、指定したクラスまたはインターフェイス名をインスタンスへ依存解決します。

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

`response()`

response関数はresponseインスタンスを返すか、レスポンスファクトリのインスタンスを取得します。

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

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

`retry()`

retry関数は指定された最大試行回数を過ぎるまで、指定されたコールバックを実行します。コールバックが例外を投げなければ、返却値を返します。コールバックが例外を投げた場合は、自動的にリトライします。最大試行回数を超えると、例外を投げます。

return retry(5, function () {
    // 試行間に100ms待ち、5回試みる
}, 100);

もし、試行間隔を何ミリ秒にするかを手作業で計算したい場合は、retry関数の第３引数へクロージャを渡します。

use Exception;

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

便利なように、retry関数の最初の引数には配列を指定することもできます。この配列は、次の再試行の間に何ミリ秒スリープさせるかを決定するために使用されます。

return retry([100, 200], function () {
    // 最初に100ms、２回目に200msスリープする
});

特定条件下でのみ再試行するには、retry関数への4番目の引数としてクロージャを渡せます。

use Exception;

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

`session()`

session関数はセッションへ値を設定、もしくは取得するために使用します。

$value = session('key');

キー／値ペアの配列を渡し、値を設定できます。

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

関数に引数を渡さない場合は、セッション保存域が返されます。

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

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

`tap()`

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トレイトをそのクラスへ追加してください。このトレイトのtapメソッドはクロージャだけを引数に受け取ります。オブジェクトインスタンス自身がクロージャに渡され、tapメソッドによりリターンされます。

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

`throw_if()`

throw_if関数は、指定した論理式がtrueと評価された場合に、指定した例外を投げます。

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

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

`throw_unless()`

throw_unless関数は、指定した論理式がfalseと評価された場合に、指定した例外を投げます。

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

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

`today()`

today関数は、現在の日付を表す新しいIlluminate\Support\Carbonインスタンスを生成します。

$today = today();

`trait_uses_recursive()`

trait_uses_recursive関数は、そのトレイトで使用されている全トレイトを返します。

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

`transform()`

transform関数は、値が空白でない場合、指定値に対してクロージャを実行し、クロージャの戻り値を返します。

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

$result = transform(5, $callback);

// 10

デフォルト値またはクロージャは、関数の３番目の引数として渡せます。指定値が空白の場合、この値をが返します。

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

// 値は空白

`validator()`

validator関数は、引数を使用して新しいバリデータインスタンスを作成します。Validatorファサードの代わりに使用できます。

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

`value()`

value関数は、指定値を返します。ただし、関数へクロージャを渡すと、そのクロージャを実行し、その戻り値を返します。

$result = value(true);

// true

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

// false

value関数に追加の引数を渡すこともできます。最初の引数がクロージャであれば、追加した引数はクロージャの引数として渡されます。クロージャでなければ、無視します。

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

// 'Taylor'

`view()`

view関数はviewインスタンスを返します。

return view('auth.login');

`with()`

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クラスはコールバックの実行にかかった平均ミリ秒を返します。

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

パイプライン

LaravelのPipelineファサードは、指定する入力を一連の呼び出し可能なクラス、クロージャ、Callableを通して、「パイプ」接続する便利な方法を提供し、各クラスに入力を検査または修正する機会を与え、パイプラインの次のCallableを呼び出します。

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クロージャが呼び出されると、パイプラインの次の呼び出し可能なクラスを呼び出します。お気づきかもしれませんが、これはミドルウェアと非常によく似ています。

パイプラインの最後のCallableが$nextクロージャを呼び出すと、thenメソッドに渡されたCallableを呼び出します。一般的に、このCallableは単に与えられた入力を返すだけです。

もちろん、前述したように、パイプラインに渡すのは、クロージャに限定されません。呼び出し可能なクラスを提供することもできます。クラス名が提供された場合、そのクラスはLaravelのサービスコンテナを通じてインスタンス化し、呼び出し可能なクラスへ依存関係を注入します。

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

抽選

Laravelの抽選クラスは、指定する一組のオッズに基づいて、コールバックを実行するために使用します。これは、受信リクエストの数パーセントに対してのみコードを実行したい場合、特に便利です。

use Illuminate\Support\Lottery;

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

Laravelの抽選クラスと他のLaravelの機能を組み合わせることも可能です。例えば、スロークエリの一部だけを例外ハンドラへ報告するようにしたい場合です。また、抽選クラスはCallableなため、Callableのメソッドを引数に取るクラスへインスタンスを渡せます。

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

// 常に外れる
Lottery::alwaysLose();

// 当選し、次に外れたあとは、通常の振る舞いをする
Lottery::fix([true, false]);

// 通常の振る舞いで抽選する
Lottery::determineResultsNormally();

Laravel 10.x ヘルパ

イントロダクション

使用可能なメソッド

配列とオブジェクト

パス

文字列

Fluent文字列

URL

その他

メソッド一覧

配列とオブジェクト

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

Arr::keyBy()

Arr::last()

Arr::map()

Arr::only()

Arr::pluck()

Arr::prepend()

Arr::prependKeysWith()

Arr::pull()

Arr::query()

Arr::random()

Arr::set()

Arr::shuffle()

Arr::sort()

Arr::sortDesc()

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

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

Str::camel()

Str::contains()

Str::containsAll()

Str::endsWith()

Str::excerpt()

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

`Arr::keyBy()`

`Arr::last()`

`Arr::map()`

`Arr::only()`

`Arr::pluck()`

`Arr::prepend()`

`Arr::prependKeysWith()`

`Arr::pull()`

`Arr::query()`

`Arr::random()`

`Arr::set()`

`Arr::shuffle()`

`Arr::sort()`

`Arr::sortDesc()`

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

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

`Str::camel()`

`Str::contains()`

`Str::containsAll()`

`Str::endsWith()`

`Str::excerpt()`

`Str::finish()`

`Str::headline()`

`Str::inlineMarkdown()`

`Str::is()`

`Str::isAscii()`

`Str::isJson()`

`Str::isUlid()`

`Str::isUuid()`

`Str::kebab()`

`Str::lcfirst()`

`Str::length()`

`Str::limit()`

`Str::lower()`