Laravel 10.x ヘルパ

イントロダクション

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

使用可能なメソッド

配列とオブジェクト

パス

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

Arr::mapWithKeysメソッドは、配列を繰り返し処理し、各値を指定したコールバックへ渡します。コールバックは、キー／値のペアを１つ含む連想配列を返す必要があります。

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => 'john@example.com',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => 'jane@example.com',
    ]
];

$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
    return [$item['email'] => $item['name']];
});

/*
    [
        'john@example.com' => 'John',
        'jane@example.com' => 'Jane',
    ]
*/

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::sortRecursiveDescメソッドを使用します。

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

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

Arr::toCssStyles()

Arr::toCssStylesは、CSSスタイルの文字列を条件付きでコンパイルします。このメソッドはクラスの配列を受け付けます。配列のキーには追加するクラスを含め、値には論理値を指定します。配列のキーが数値の場合は、レンダーするクラスのリストへ常に含めます。

$hasColor = true;

$array = ['background-color: blue', 'color: blue' => $hasColor];

$classes = Arr::toCssStyles($array);

/*
    'background-color: blue; color: blue;'
*/

このメソッドは、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]]]

data_forget()

data_forget関数は「ドット」記法を使い、ネストした配列やオブジェクト内の値を削除します。

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

data_forget($data, 'products.desk.price');

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

この関数は、アスタリスクを使ったワイルドカードも受け付け、適応するターゲットの値を削除します。

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

data_forget($data, 'products.*.price');

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

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

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

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

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

dispatch_sync()

dispatch_sync`関数は、指定ジョブを即時処理するsyncキューへ投入します。

dispatch_sync(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();
});

例外をreport関数でレポートするかを決定するために、rescue関数にreport引数を指定できます。

return rescue(function () {
    return $this->method();
}, report: function (Throwable $throwable) {
    return $throwable instanceof InvalidArgumentException;
});

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

コールバックが返す値を取得しながら、コールバックの実行をベンチマークしたい場合もあるでしょう。valueメソッドはコールバックが返した値と、コールバックの実行にかかったミリ秒数を含むタプルを返します：

[$count, $duration] = Benchmark::value(fn () => User::count());

日付

Laravelは、強力な日付と時間の操作ライブラリであるCarbonを含んでいます。新しいCarbonインスタンスを作成するには、now関数を呼び出してください。この関数はLaravelアプリケーション内でグローバルに利用可能です。

$now = now();

もしくは、Illuminate\Support\Carbonクラスを使い、新しいCarbonインスタンスを作成できます。

use Illuminate\Support\Carbon;

$now = Carbon::now();

Carbonの概要や特徴については、Carbon公式ドキュメントを参照してください。

抽選

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の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のSleepクラスは、PHPネイティブのsleepとusleep関数の軽量ラッパーで、テスト性を高めるとともに、開発者に優しい時間操作のためのAPIを公開しています。

use Illuminate\Support\Sleep;

$waiting = true;

while ($waiting) {
    Sleep::for(1)->second();

    $waiting = /* ... */;
}

Sleepクラスは、異なる時間単位を扱う様々なメソッドを提供しています。

// 実行を９０秒停止
Sleep::for(1.5)->minutes();

// 実行を２秒停止
Sleep::for(2)->seconds();

// 実行を５００ミリ秒停止
Sleep::for(500)->milliseconds();

// 実行を５０００マイクロ秒停止
Sleep::for(5000)->microseconds();

// 実行を指定時間まで停止
Sleep::until(now()->addMinute());

// PHPネイティブの"sleep"関数のエイリアス
Sleep::sleep(2);

// PHPネイティブの"usleep"関数のエイリアス
Sleep::usleep(5000);

時間の単位を簡単に組み合わせるには、andメソッドを使用します。

Sleep::for(1)->second()->and(10)->milliseconds();

スリープのテスト

SleepクラスやPHPネイティブのスリープ関数を使用するコードをテストする場合、テストの実行は一時停止します。皆さんの予想通り、これはテストスイートの速度を著しく低下させます。たとえば、次のようなコードをテストしているとしましょう：

$waiting = /* ... */;

$seconds = 1;

while ($waiting) {
    Sleep::for($seconds++)->seconds();

    $waiting = /* ... */;
}

通常、このコードのテストは最低でも１秒かかるでしょう。幸運なことに、Sleepクラスは、テストスイートを高速に保つために、スリープを「Fake」できます。

public function test_it_waits_until_ready()
{
    Sleep::fake();

    // ...
}

SleepクラスをFakeする場合、実際の実行の一時停止はバイパスされるため、テストが大幅に高速化されます。

一度SleepクラスをFakeすると、本来発生するはずの「スリープ」に対してアサートできるようになります。これを説明するために、実行を３回一時停止するコードをテストしていると仮定します。（各停止時間は１秒ずつ増加させます。）assertSequenceメソッドを使用すると、テストの速度を維持したまま、適切な時間だけコードが「スリープ」したことをアサートできます：

public function test_it_checks_if_ready_four_times()
{
    Sleep::fake();

    // ...

    Sleep::assertSequence([
        Sleep::for(1)->second(),
        Sleep::for(2)->seconds(),
        Sleep::for(3)->seconds(),
    ]);
}

もちろん、Sleepクラスには、テスト時に使用する他の様々なアサーションを用意しています。

use Carbon\CarbonInterval as Duration;
use Illuminate\Support\Sleep;

// ３回スリープすることをアサート
Sleep::assertSleptTimes(3);

// スリープ時間をアサート
Sleep::assertSlept(function (Duration $duration): bool {
    return /* ... */;
}, times: 1);

// Sleepクラスが起動されないことをアサート
Sleep::assertNeverSlept();

// Sleepが呼び出されても、実行が中断されないことをアサート
Sleep::assertInsomniac();

アプリケーションコードで、Fakeスリープが発生するたびに、アクションを実行できれば便利な場合が時々あるでしょう。これを行うには、whenFakingSleepメソッドへコールバックを渡します。以下の例では、Laravelの時間操作ヘルパを使い、Sleepの間隔ごとで、瞬時に時間を進めています。

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

Sleep::whenFakingSleep(function (Duration $duration) {
    // SleepをFakeした時点で、時間を進める
    $this->travel($duration->totalMilliseconds)->milliseconds();
});

Laravelは実行を一時停止するとき、にいつでも内部的にSleepクラスを使用しています。例えば、retryヘルパはスリープ時にSleepクラスを使用し、そのヘルパを使用する際のテストの実行性を上げています。