Laravel 10.x ヘルパ

イントロダクションIntroduction

Laravelはさまざまな、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。Laravel includes a variety of global "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.

使用可能なメソッドAvailable Methods

配列とオブジェクトArrays & Objects

数値Numbers

パスPaths

URLURLs

その他Miscellaneous

配列とオブジェクトArrays & Objects

Arr::accessible() Arr::accessible()

Arr::accessibleメソッドは、指定した値が配列アクセス可能かを判別します。The Arr::accessible method determines if the given value is array 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()

Arr::addメソッドは指定キー／値のペアをそのキーが存在していない場合とnullがセットされている場合に、配列に追加します。The Arr::add method adds a given key / value pair to an array if the given key doesn't already exist in the array or is set to 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()

Arr::collapseメソッドは配列の配列を一次元の配列へ展開します。The Arr::collapse method collapses an array of arrays into a single array:

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

Arr::crossJoinメソッドは指定配列をクロス結合し、可能性があるすべての順列の直積集合を返します。The Arr::crossJoin method cross joins the given arrays, returning a Cartesian product with all possible permutations:

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

Arr::divideメソッドは２つの配列を返します。１つは指定した配列のキーを含み、もう１つは値を含みます。The Arr::divide method returns two arrays: one containing the keys and the other containing the values of the given array:

use Illuminate\Support\Arr;

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

// $keys: ['name']

// $values: ['Desk']

Arr::dot() Arr::dot()

Arr::dotメソッドは多次元配列を「ドット」記法で深さを表した一次元配列に変換します。The Arr::dot method flattens a multi-dimensional array into a single level array that uses "dot" notation to indicate depth:

use Illuminate\Support\Arr;

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

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

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

Arr::except() Arr::except()

Arr::exceptメソッドは指定キー／値ペアを配列から削除します。The Arr::except method removes the given key / value pairs from an array:

use Illuminate\Support\Arr;

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

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

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

Arr::exists() Arr::exists()

Arr::existsメソッドは指定キーが指定配列に存在するかをチェックします。The Arr::exists method checks that the given key exists in the provided array:

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

Arr::firstメソッドは指定したテストにパスした最初の要素を返します。The Arr::first method returns the first element of an array passing a given truth test:

use Illuminate\Support\Arr;

$array = [100, 200, 300];

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

// 200

デフォルト値を３つ目の引数で指定することもできます。この値はどの値もテストへパスしない場合に返されます。A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:

use Illuminate\Support\Arr;

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

Arr::flatten() Arr::flatten()

Arr::flattenメソッドは、多次元配列を一次元配列へ変換します。The Arr::flatten method flattens a multi-dimensional array into a single level array:

use Illuminate\Support\Arr;

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

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

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

Arr::forget() Arr::forget()

Arr::forgetメソッドは「ドット記法」で指定キー／値のペアを深くネストされた配列から取り除きます。The Arr::forget method removes a given key / value pair from a deeply nested array using "dot" notation:

use Illuminate\Support\Arr;

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

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

// ['products' => []]

Arr::get() Arr::get()

Arr::getメソッドは「ドット」記法で指定した値を深くネストされた配列から取得します。The Arr::get method retrieves a value from a deeply nested array using "dot" notation:

use Illuminate\Support\Arr;

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

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

// 100

Arr::getメソッドはデフォルト値も引数に取ります。これは、指定したキーが配列で存在しない場合に返されます。The Arr::get method also accepts a default value, which will be returned if the specified key is not present in the array:

use Illuminate\Support\Arr;

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

// 0

Arr::has() Arr::has()

Arr::hasメソッドは、「ドット」記法で指定したアイテムが配列に存在するかをチェックします。The Arr::has method checks whether a given item or items exists in an array using "dot" notation:

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

Arr::hasAnyメソッドは「ドット」記法を使い、配列中に一連のアイテムが存在するかを調べます。The Arr::hasAny method checks whether any item in a given set exists in an array using "dot" notation:

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

Arr::isAssocメソッドは、指定した配列が連想配列である場合、trueを返します。配列が0から始まる連続したキーを持たない場合、その配列を「連想配列」であると見なします。The Arr::isAssoc method returns true if the given array is an associative array. An array is considered "associative" if it doesn't have sequential numerical keys beginning with zero:

use Illuminate\Support\Arr;

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

// true

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

// false

Arr::isList() Arr::isList()

Arr::isListメソッドは、指定した配列のキーが0から始まる連続した整数である場合、trueを返します。The Arr::isList method returns true if the given array's keys are sequential integers beginning from zero:

use Illuminate\Support\Arr;

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

// true

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

// false

Arr::join() Arr::join()

Arr::joinメソッドは、配列の要素を文字列として結合します。このメソッドに第２引数を使用し、配列の最後の要素前に挿入する文字列を指定できます。The Arr::join method joins array elements with a string. Using this method's second argument, you may also specify the joining string for the final element of the array:

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

Arr::keyByメソッドは、指定したキーで配列へキーを設定します。複数のアイテムが同じキーを持つ場合、最後のものだけを新しい配列に残します。The Arr::keyBy method keys the array by the given key. If multiple items have the same key, only the last one will appear in the new array:

use Illuminate\Support\Arr;

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

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

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

Arr::last() Arr::last()

Arr::lastメソッドは、テストでパスした最後の配列要素を返します。The Arr::last method returns the last element of an array passing a given truth test:

use Illuminate\Support\Arr;

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

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

// 300

メソッドの第３引数には、デフォルト値を渡します。テストでパスする値がない場合に、返されます。A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:

use Illuminate\Support\Arr;

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

Arr::map() Arr::map()

Arr::mapメソッドは配列を繰り返し処理し、それぞれの値とキーを指定したコールバックへ渡します。配列の値は、コールバックの返却値で置き換えます。The Arr::map method iterates through the array and passes each value and key to the given callback. The array value is replaced by the value returned by the callback:

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

Arr::mapWithKeysメソッドは、配列を繰り返し処理し、各値を指定したコールバックへ渡します。コールバックは、キー／値のペアを１つ含む連想配列を返す必要があります。The Arr::mapWithKeys method iterates through the array and passes each value to the given callback. The callback should return an associative array containing a single key / value pair:

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

Arr::onlyメソッドは配列中に存在する、指定したキー／値ペアのアイテムのみを返します。The Arr::only method returns only the specified key / value pairs from the given array:

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

Arr::pluckメソッドは配列中の指定キーに対する値をすべて取得します。The Arr::pluck method retrieves all of the values for a given key from an array:

use Illuminate\Support\Arr;

$array = [
    ['developer' => ['id' => 1, 'name' => 'Taylor']],
    ['developer' => ['id' => 2, 'name' => 'Abigail']],
];

$names = Arr::pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

さらに、結果のリストのキー項目も指定できます。You may also specify how you wish the resulting list to be keyed:

use Illuminate\Support\Arr;

$names = Arr::pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail']

Arr::prepend() Arr::prepend()

Arr::prependメソッドは配列の先頭にアイテムを追加します。The Arr::prepend method will push an item onto the beginning of an array:

use Illuminate\Support\Arr;

$array = ['one', 'two', 'three', 'four'];

$array = Arr::prepend($array, 'zero');

// ['zero', 'one', 'two', 'three', 'four']

必要であれば、値に対するキーを指定できます。If needed, you may specify the key that should be used for the value:

use Illuminate\Support\Arr;

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

$array = Arr::prepend($array, 'Desk', 'name');

// ['name' => 'Desk', 'price' => 100]

Arr::prependKeysWith() Arr::prependKeysWith()

Arr::prependKeysWithは、連想配列のすべてのキー名の前に、指定したプレフィックスを付加します。The Arr::prependKeysWith prepends all key names of an associative array with the given prefix:

use Illuminate\Support\Arr;

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

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

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

Arr::pull() Arr::pull()

Arr::pullメソッドは配列から指定キー／値ペアを取得し、同時に削除します。The Arr::pull method returns and removes a key / value pair from an array:

use Illuminate\Support\Arr;

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

$name = Arr::pull($array, 'name');

// $name: Desk

// $array: ['price' => 100]

メソッドの第３引数として、デフォルト値を渡せます。この値はキーが存在しない場合に返されます。A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:

use Illuminate\Support\Arr;

$value = Arr::pull($array, $key, $default);

Arr::query() Arr::query()

Arr::queryメソッドは配列をクエリ文字列へ変換します。The Arr::query method converts the array into a query string:

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

Arr::randomメソッドは配列からランダムに値を返します。The Arr::random method returns a random value from an array:

use Illuminate\Support\Arr;

$array = [1, 2, 3, 4, 5];

$random = Arr::random($array);

// 4 - (retrieved randomly)

オプションの２番目の引数に返すアイテム数を指定することもできます。この引数を指定すると、アイテムが１つだけ必要な場合でも、配列が返されることに注意してください。You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array even if only one item is desired:

use Illuminate\Support\Arr;

$items = Arr::random($array, 2);

// [2, 5] - (retrieved randomly)

Arr::set() Arr::set()

Arr::setメソッドは「ドット」記法を使用し、深くネストした配列に値をセットします。The Arr::set method sets a value within a deeply nested array using "dot" notation:

use Illuminate\Support\Arr;

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

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

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

Arr::shuffle() Arr::shuffle()

Arr::shuffleメソッドは、配列中のアイテムをランダムにシャッフルします。The Arr::shuffle method randomly shuffles the items in the array:

use Illuminate\Support\Arr;

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

// [3, 2, 5, 1, 4] - (無作為に入れ替えた結果)

Arr::sort() Arr::sort()

Arr::sortメソッドは、配列の値に基づきソートします。The Arr::sort method sorts an array by its values:

use Illuminate\Support\Arr;

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

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

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

指定するクロージャの結果で配列を並べ替えることもできます。You may also sort the array by the results of a given closure:

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

Arr::sortDescメソッドは、配列を値の降順でソートします。The Arr::sortDesc method sorts an array in descending order by its values:

use Illuminate\Support\Arr;

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

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

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

指定するクロージャの結果で配列を並べ替えることもできます。You may also sort the array by the results of a given closure:

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

Arr::sortRecursiveメソッドは、数値インデックス付きサブ配列の場合はsort関数を使用し、連想サブ配列の場合はksort関数を使用して、配列を再帰的に並べ替えます。The Arr::sortRecursive method recursively sorts an array using the sort function for numerically indexed sub-arrays and the ksort function for associative sub-arrays:

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メソッドを使用します。If you would like the results sorted in descending order, you may use the Arr::sortRecursiveDesc method.

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

Arr::take() Arr::take()

Arr::takeメソッドは、指定数のアイテムを持つ新しい配列を返します。The Arr::take method returns a new array with the specified number of items:

use Illuminate\Support\Arr;

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, 3);

// [0, 1, 2]

負の整数を渡し、配列の末尾から指定数の項目を取り出すこともできます。You may also pass a negative integer to take the specified number of items from the end of the array:

$array = [0, 1, 2, 3, 4, 5];

$chunk = Arr::take($array, -2);

// [4, 5]

Arr::toCssClasses() Arr::toCssClasses()

Arr::toCssClassesメソッドは、CSSクラス文字列を条件付きでコンパイルします。この方法はクラスの配列を引数に取り、配列キーに追加したいクラス、値は論理式です。配列要素に数字キーがある場合は、レンダするクラスリストへ常に含めます。The Arr::toCssClasses method conditionally compiles a CSS class string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

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

Arr::toCssStylesは、CSSスタイルの文字列を条件付きでコンパイルします。このメソッドはクラスの配列を受け付けます。配列のキーには追加するクラスを含め、値には論理値を指定します。配列のキーが数値の場合は、レンダーするクラスのリストへ常に含めます。The Arr::toCssStyles conditionally compiles a CSS style string. The method accepts an array of classes where the array key contains the class or classes you wish to add, while the value is a boolean expression. If the array element has a numeric key, it will always be included in the rendered class list:

use Illuminate\Support\Arr;

$hasColor = true;

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

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

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

このメソッドは、Bladeコンポーネントのアトリビュートバッグを使ったクラスのマージと、@class Bladeディレクティブを提供するLaravelの機能を強化します。This method powers Laravel's functionality allowing merging classes with a Blade component's attribute bag[/docs/{{version}}/blade#conditionally-merge-classes] as well as the @class Blade directive[/docs/{{version}}/blade#conditional-classes].

Arr::undot() Arr::undot()

Arr::undotメソッドは、「ドット」記法を用いた一次元配列を多次元配列へ展開します。The Arr::undot method expands a single-dimensional array that uses "dot" notation into a multi-dimensional array:

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

Arr::whereメソッドは、指定したクロージャを使用して配列をフィルタリングします。The Arr::where method filters an array using the given closure:

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

Arr::whereNotNullメソッドは、指定する配列からすべてのnull値を削除します。The Arr::whereNotNull method removes all null values from the given array:

use Illuminate\Support\Arr;

$array = [0, null];

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

// [0 => 0]

Arr::wrap() Arr::wrap()

Arr::wrapメソッドは、指定した値を配列にラップします。指定した値がすでに配列にある場合は、変更せずに返します。The Arr::wrap method wraps the given value in an array. If the given value is already an array it will be returned without modification:

use Illuminate\Support\Arr;

$string = 'Laravel';

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

// ['Laravel']

指定値がnullの場合、空の配列を返します。If the given value is null, an empty array will be returned:

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

data_fill() data_fill()

data_fill関数は「ドット」記法を使用し、ターゲットの配列やオブジェクトへ足りない値をセットします。The data_fill function sets a missing value within a nested array or object using "dot" notation:

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

この関数はアスタリスクもワイルドカードとして受け取り、それに応じてターゲットにデータを埋め込みます。This function also accepts asterisks as wildcards and will fill the target accordingly:

$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_get関数は「ドット」記法を使用し、ネストした配列やオブジェクトから値を取得します。The data_get function retrieves a value from a nested array or object using "dot" notation:

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

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

// 100

data_get関数は、指定したキーが存在しない場合に返す、デフォルト値も指定できます。The data_get function also accepts a default value, which will be returned if the specified key is not found:

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

// 0

配列やオブジェクトのいずれのキーにもマッチする、ワイルドカードとしてアスタリスクも使用できます。The function also accepts wildcards using asterisks, which may target any key of the array or object:

$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_set関数は「ドット」記法を使用し、ネストした配列やオブジェクトに値をセットします。The data_set function sets a value within a nested array or object using "dot" notation:

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

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

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

この関数は、アスタリスクを使用したワイルドカードも受け入れ、それに応じてターゲットに値を設定します。This function also accepts wildcards using asterisks and will set values on the target accordingly:

$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を渡してください。By default, any existing values are overwritten. If you wish to only set a value if it doesn't exist, you may pass false as the fourth argument to the function:

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

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

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

data_forget() data_forget()

data_forget関数は「ドット」記法を使い、ネストした配列やオブジェクト内の値を削除します。The data_forget function removes a value within a nested array or object using "dot" notation:

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

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

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

この関数は、アスタリスクを使ったワイルドカードも受け付け、適応するターゲットの値を削除します。This function also accepts wildcards using asterisks and will remove values on the target accordingly:

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

head関数は、配列の最初の要素を返します。The head function returns the first element in the given array:

$array = [100, 200, 300];

$first = head($array);

// 100

last() last()

last関数は指定した配列の最後の要素を返します。The last function returns the last element in the given array:

$array = [100, 200, 300];

$last = last($array);

// 300

数値Numbers

Number::abbreviate() Number::abbreviate()

Number::abbreviateメソッドは、指定値を人間が読みやすい形式に、単位の週略系をつけて返します。The Number::abbreviate method returns the human-readable format of the provided numerical value, with an abbreviation for the units:

use Illuminate\Support\Number;

$number = Number::abbreviate(1000);

// 1K

$number = Number::abbreviate(489939);

// 490K

$number = Number::abbreviate(1230000, precision: 2);

// 1.23M

Number::clamp() Number::clamp()

Number::clampメソッドは、指定値を指定範囲内に収めます。数値が最小値より小さい場合は最小値を返します。数値が最大値より大きい場合は、最大値を返します。The Number::clamp method ensures a given number stays within a specified range. If the number is lower than the minimum, the minimum value is returned. If the number is higher than the maximum, the maximum value is returned:

use Illuminate\Support\Number;

$number = Number::clamp(105, min: 10, max: 100);

// 100

$number = Number::clamp(5, min: 10, max: 100);

// 10

$number = Number::clamp(10, min: 10, max: 100);

// 10

$number = Number::clamp(20, min: 10, max: 100);

// 20

Number::currency() Number::currency()

Number::currencyメソッドは、指定値の通貨表現を文字列として返します。The Number::currency method returns the currency representation of the given value as a string:

use Illuminate\Support\Number;

$currency = Number::currency(1000);

// $1,000

$currency = Number::currency(1000, in: 'EUR');

// €1,000

$currency = Number::currency(1000, in: 'EUR', locale: 'de');

// 1.000 €

Number::fileSize() Number::fileSize()

Number::fileSizeメソッドは、指定バイト値をファイルサイズ表現の文字列として返します。The Number::fileSize method returns the file size representation of the given byte value as a string:

use Illuminate\Support\Number;

$size = Number::fileSize(1024);

// 1 KB

$size = Number::fileSize(1024 * 1024);

// 1 MB

$size = Number::fileSize(1024, precision: 2);

// 1.00 KB

Number::forHumans() Number::forHumans()

Number::forHumansメソッドは、指定値を人間が読める形式で返します。The Number::forHumans method returns the human-readable format of the provided numerical value:

use Illuminate\Support\Number;

$number = Number::forHumans(1000);

// 1 thousand

$number = Number::forHumans(489939);

// 490 thousand

$number = Number::forHumans(1230000, precision: 2);

// 1.23 million

Number::format() Number::format()

Number::formatメソッドは、指定値をロケール固有の文字列に整形します。The Number::format method formats the given number into a locale specific string:

use Illuminate\Support\Number;

$number = Number::format(100000);

// 100,000

$number = Number::format(100000, precision: 2);

// 100,000.00

$number = Number::format(100000.123, maxPrecision: 2);

// 100,000.12

$number = Number::format(100000, locale: 'de');

// 100.000

Number::ordinal() Number::ordinal()

Number::ordinalメソッドは、数値の序数英語表現を返します。The Number::ordinal method returns a number's ordinal representation:

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

Number::percentage() Number::percentage()

Number::percentageメソッドは、指定値のパーセンテージ表現を文字列で返します。The Number::percentage method returns the percentage representation of the given value as a string:

use Illuminate\Support\Number;

$percentage = Number::percentage(10);

// 10%

$percentage = Number::percentage(10, precision: 2);

// 10.00%

$percentage = Number::percentage(10.123, maxPrecision: 2);

// 10.12%

$percentage = Number::percentage(10, precision: 2, locale: 'de');

// 10,00%

Number::spell() Number::spell()

Number::spell`メソッドは、指定する数字を単語の文字列へ変換します。The Number::spell method transforms the given number into a string of words:

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

$number = Number::spell(88, locale: 'fr');

// quatre-vingt-huit

after引数は、これより大きい数字は文字へ変換する値を指定します。The after argument allows you to specify a value after which all numbers should be spelled out:

$number = Number::spell(10, after: 10);

// 10

$number = Number::spell(11, after: 10);

// eleven

until引数は、これより大きい数字は文字へ変換する値を指定します。The until argument allows you to specify a value before which all numbers should be spelled out:

$number = Number::spell(5, until: 10);

// five

$number = Number::spell(10, until: 10);

// 10

Number::useLocale() Number::useLocale()

Number::useLocaleメソッドはデフォルトの数値ロケールをグローバルに指定します。この指定は、以降に実行するNumberクラスのメソッドの数字や金額のフォーマットに影響を与えます。The Number::useLocale method sets the default number locale globally, which affects how numbers and currency are formatted by subsequent invocations to the Number class's methods:

use Illuminate\Support\Number;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Number::useLocale('de');
}

Number::withLocale() Number::withLocale()

Number::withLocaleメソッドは、指定ロケールを用いてクロージャを実行し、コールバック実行後に元のロケールに戻します。The Number::withLocale method executes the given closure using the specified locale and then restores the original locale after the callback has executed:

use Illuminate\Support\Number;

$number = Number::withLocale('de', function () {
    return Number::format(1500);
});

パスPaths

app_path() app_path()

app_path関数は、アプリケーションのappディレクトリの完全修飾パスを返します。app_path関数を使用して、アプリケーションディレクトリに関連するファイルへの完全修飾パスを生成することもできます。The app_path function returns the fully qualified path to your application's app directory. You may also use the app_path function to generate a fully qualified path to a file relative to the application directory:

$path = app_path();

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

base_path() base_path()

base_path関数は、アプリケーションのルートディレクトリへの完全修飾パスを返します。base_path関数を使用して、プロジェクトのルートディレクトリに関連する特定のファイルへの完全修飾パスを生成することもできます。The base_path function returns the fully qualified path to your application's root directory. You may also use the base_path function to generate a fully qualified path to a given file relative to the project root directory:

$path = base_path();

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

config_path() config_path()

config_path関数は、アプリケーションのconfigディレクトリへの完全修飾パスを返します。config_path関数を使用して、アプリケーションの構成ディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。The config_path function returns the fully qualified path to your application's config directory. You may also use the config_path function to generate a fully qualified path to a given file within the application's configuration directory:

$path = config_path();

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

database_path() database_path()

database_path関数は、アプリケーションのdatabaseディレクトリへの完全修飾パスを返します。database_path関数を使用して、データベースディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。The database_path function returns the fully qualified path to your application's database directory. You may also use the database_path function to generate a fully qualified path to a given file within the database directory:

$path = database_path();

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

lang_path() lang_path()

lang_path関数は、アプリケーションのlangディレクトリの完全修飾パスを返します。また、lang_path関数を使用して、ディレクトリ内の指定したファイルの完全修飾パスを生成することもできます。The lang_path function returns the fully qualified path to your application's lang directory. You may also use the lang_path function to generate a fully qualified path to a given file within the directory:

$path = lang_path();

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

lightbulb Note: Laravelアプリケーションのスケルトンは、デフォルトでlangディレクトリを用意していません。Laravelの言語ファイルをカスタマイズしたい場合は、lang:publish Artisanコマンドでリソース公開することができます。[!NOTE]
By default, the Laravel application skeleton does not include the lang directory. If you would like to customize Laravel's language files, you may publish them via the lang:publish Artisan command.

mix() mix()

mix関数は、バージョンつけしたMixファイルのパスを取得します。The mix function returns the path to a versioned Mix file[/docs/{{version}}/mix]:

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

public_path() public_path()

public_path関数は、アプリケーションのpublicディレクトリへの完全修飾パスを返します。public_path関数を使用して、パブリックディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。The public_path function returns the fully qualified path to your application's public directory. You may also use the public_path function to generate a fully qualified path to a given file within the public directory:

$path = public_path();

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

resource_path() resource_path()

resource_path関数は、アプリケーションのresourcesディレクトリへの完全修飾パスを返します。resource_path関数を使用して、リソースディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。The resource_path function returns the fully qualified path to your application's resources directory. You may also use the resource_path function to generate a fully qualified path to a given file within the resources directory:

$path = resource_path();

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

storage_path() storage_path()

storage_path関数は、アプリケーションのstorageディレクトリへの完全修飾パスを返します。storage_path関数を使用して、ストレージディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。The storage_path function returns the fully qualified path to your application's storage directory. You may also use the storage_path function to generate a fully qualified path to a given file within the storage directory:

$path = storage_path();

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

URLURLs

action() action()

action関数は、指定されたコントローラアクションのURLを生成します。The action function generates a URL for the given controller action:

use App\Http\Controllers\HomeController;

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

メソッドがルートパラメーターを受け付ける場合は、第２引数で指定してください。If the method accepts route parameters, you may pass them as the second argument to the method:

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

asset() asset()

asset関数は、現在のリクエストのスキーマ（HTTPかHTTPS）を使い、アセットへのURLを生成します。The asset function generates a URL for an asset using the current scheme of the request (HTTP or HTTPS):

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

.envファイルでASSET_URL変数を設定することにより、アセットURLホストを設定できます。これは、AmazonS3や別のCDNなどの外部サービスでアセットをホストする場合に役立ちます。You can configure the asset URL host by setting the ASSET_URL variable in your .env file. This can be useful if you host your assets on an external service like Amazon S3 or another CDN:

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

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

route() route()

route関数は、指定した名前付きルートのURLを生成します。The route function generates a URL for a given named route[/docs/{{version}}/routing#named-routes]:

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

ルートがパラメーターを受け入れる場合は、それらを関数の２番目の引数として渡すことができます。If the route accepts parameters, you may pass them as the second argument to the function:

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

デフォルトでは、route関数は絶対URLを生成します。相対URLを生成する場合は、関数の３番目の引数としてfalseを渡してください。By default, the route function generates an absolute URL. If you wish to generate a relative URL, you may pass false as the third argument to the function:

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

secure_asset() secure_asset()

secure_asset関数はHTTPSを使い、アセットへのURLを生成します。The secure_asset function generates a URL for an asset using HTTPS:

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

secure_url() secure_url()

secure_url関数は、指定されたパスへの完全修飾HTTPS URLを生成します。関数の２番目の引数で追加のURLセグメントを渡すことができます。The secure_url function generates a fully qualified HTTPS URL to the given path. Additional URL segments may be passed in the function's second argument:

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

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

to_route() to_route()

to_route関数は、指定した名前付きルートに対して、リダイレクトHTTPレスポンスを生成します。The to_route function generates a redirect HTTP response[/docs/{{version}}/responses#redirects] for a given named route[/docs/{{version}}/routing#named-routes]:

return to_route('users.show', ['user' => 1]);

必要であれば、to_routeメソッドの第３，第４引数へ、リダイレクトに割り当てるHTTPステータスコードと、追加のレスポンスヘッダを指定できます。If necessary, you may pass the HTTP status code that should be assigned to the redirect and any additional response headers as the third and fourth arguments to the to_route method:

return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);

url() url()

url関数は指定したパスへの完全なURLを生成します。The url function generates a fully qualified URL to the given path:

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

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

パスを指定しない場合は、Illuminate\Routing\UrlGeneratorインスタンスを返します。If no path is provided, an Illuminate\Routing\UrlGenerator instance is returned:

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

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

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

その他Miscellaneous

abort() abort()

abort関数は、例外ハンドラによりレンダされるであろう、HTTP例外を投げます。The abort function throws an HTTP exception[/docs/{{version}}/errors#http-exceptions] which will be rendered by the exception handler[/docs/{{version}}/errors#the-exception-handler]:

abort(403);

ブラウザに送信する必要のある例外のメッセージとカスタムHTTP応答ヘッダを指定することもできます。You may also provide the exception's message and custom HTTP response headers that should be sent to the browser:

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

abort_if() abort_if()

abort_if関数は、指定された論理値がtrueと評価された場合に、HTTP例外を投げます。The abort_if function throws an HTTP exception if a given boolean expression evaluates to true:

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

abortメソッドと同様に、例外の応答テキストを３番目の引数として指定し、カスタム応答ヘッダの配列を４番目の引数として関数に指定することもできます。Like the abort method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument to the function.

abort_unless() abort_unless()

abort_unless関数は、指定した論理値がfalseと評価された場合に、HTTP例外を投げます。The abort_unless function throws an HTTP exception if a given boolean expression evaluates to false:

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

abortメソッドと同様に、例外の応答テキストを３番目の引数として指定し、カスタム応答ヘッダの配列を４番目の引数として関数に指定することもできます。Like the abort method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument to the function.

app() app()

app関数は、サービスコンテナのインスタンスを返します。The app function returns the service container[/docs/{{version}}/container] instance:

$container = app();

コンテナにより依存解決する、クラス名かインターフェイス名を渡すこともできます。You may pass a class or interface name to resolve it from the container:

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

auth() auth()

auth関数は、Authenticatorインスタンスを返します。Authファサードの代わりに使用できます。The auth function returns an authenticator[/docs/{{version}}/authentication] instance. You may use it as an alternative to the Auth facade:

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

必要であれば、アクセスしたいガードインスタンスを指定することもできます。If needed, you may specify which guard instance you would like to access:

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

back() back()

back関数はユーザーの直前のロケーションへのリダイレクトHTTPレスポンスを生成します。The back function generates a redirect HTTP response[/docs/{{version}}/responses#redirects] to the user's previous location:

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

return back();

bcrypt() bcrypt()

bcrypt関数はBcryptを使用して指定された値をハッシュします。この関数は、Hashファサードの代わりに使用できます。The bcrypt function hashes[/docs/{{version}}/hashing] the given value using Bcrypt. You may use this function as an alternative to the Hash facade:

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

blank() blank()

blank関数は、指定された値が「空白」であるかどうかを判別します。The blank function determines whether the given value is "blank":

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

// true

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

// false

blankの逆の動作は、filledメソッドです。For the inverse of blank, see the filled[#method-filled] method.

broadcast() broadcast()

broadcast関数は、指定したイベントをリスナへブロードキャストします。The broadcast function broadcasts[/docs/{{version}}/broadcasting] the given event[/docs/{{version}}/events] to its listeners:

broadcast(new UserRegistered($user));

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

cache() cache()

cache関数はキャッシュから値を取得するために使用します。キャッシュに指定したキーが存在しない場合、オプション値が返されます。The cache function may be used to get values from the cache[/docs/{{version}}/cache]. If the given key does not exist in the cache, an optional default value will be returned:

$value = cache('key');

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

関数にキー／値ペアの配列を渡すと、アイテムをキャッシュへ追加します。さらに秒数、もしくはキャッシュ値が有効であると推定される期限を渡すこともできます。You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of seconds or duration the cached value should be considered valid:

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

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

class_uses_recursive() class_uses_recursive()

class_uses_recursive関数は、すべての親で使われているものも含め、クラス中で使用されているトレイトをすべて返します。The class_uses_recursive function returns all traits used by a class, including traits used by all of its parent classes:

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

collect() collect()

collect関数は、指定値からコレクションインスタンスを生成します。The collect function creates a collection[/docs/{{version}}/collections] instance from the given value:

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

config() config()

config関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。The config function gets the value of a configuration[/docs/{{version}}/configuration] variable. The configuration values may be accessed using "dot" syntax, which includes the name of the file and the option you wish to access. A default value may be specified and is returned if the configuration option does not exist:

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

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

キー／値ペアの配列を渡すことにより、実行時に設定変数を設定できます。ただし、この関数は現在のリクエストの設定値にのみ影響し、実際の設定値は更新しないことに注意してください。You may set configuration variables at runtime by passing an array of key / value pairs. However, note that this function only affects the configuration value for the current request and does not update your actual configuration values:

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

cookie() cookie()

cookie関数は新しいクッキーインスタンスを生成します。The cookie function creates a new cookie[/docs/{{version}}/requests#cookies] instance:

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

csrf_field() csrf_field()

csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。The csrf_field function generates an HTML hidden input field containing the value of the CSRF token. For example, using Blade syntax[/docs/{{version}}/blade]:

{{ csrf_field() }}

csrf_token() csrf_token()

csrf_token関数は、現在のCSRFトークン値を取得します。The csrf_token function retrieves the value of the current CSRF token:

$token = csrf_token();

decrypt() decrypt()

decrypt関数は、指定した値を 復号化 します。この関数は、Cryptファサードの代わりとして使用できます。The decrypt function decrypts[/docs/{{version}}/encryption] the given value. You may use this function as an alternative to the Crypt facade:

$password = decrypt($value);

dd() dd()

dd関数は指定された変数の内容を表示し、スクリプトの実行を停止します。The dd function dumps the given variables and ends the execution of the script:

dd($value);

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

スクリプトの実行を停止したくない場合は、代わりにdump関数を使ってください。If you do not want to halt the execution of your script, use the dump[#method-dump] function instead.

dispatch() dispatch()

dispatch関数は、指定したジョブをLaravelのジョブキューへ投入します。The dispatch function pushes the given job[/docs/{{version}}/queues#creating-jobs] onto the Laravel job queue[/docs/{{version}}/queues]:

dispatch(new App\Jobs\SendEmails);

dispatch_sync() dispatch_sync()

dispatch_sync`関数は、指定ジョブを即時処理するsyncキューへ投入します。The dispatch_sync function pushes the given job to the sync[/docs/{{version}}/queues#synchronous-dispatching] queue so that it is processed immediately:

dispatch_sync(new App\Jobs\SendEmails);

dump() dump()

dump関数は指定した変数をダンプします。The dump function dumps the given variables:

dump($value);

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

変数の値をダンプした後に実行を停止したい場合は、代わりにdd関数を使用してください。If you want to stop executing the script after dumping the variables, use the dd[#method-dd] function instead.

encrypt() encrypt()

encrypt関数は、指定した値を暗号化します。この関数は、Cryptファサードの代わりに使用できます。The encrypt function encrypts[/docs/{{version}}/encryption] the given value. You may use this function as an alternative to the Crypt facade:

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

env() env()

env関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。The env function retrieves the value of an environment variable[/docs/{{version}}/configuration#environment-configuration] or returns a default value:

$env = env('APP_ENV');

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

warning Warning! 開発手順の中でconfig:cacheコマンドを実行する場合は、必ず設定ファイルの中からだけ、env関数を使用してください。設定ファイルがキャッシュされると、.envファイルはロードされなくなり、env関数の呼び出しはすべてnullを返します。[!WARNING]
If you execute the config:cache command during your deployment process, you should be sure that you are only calling the env function from within your configuration files. Once the configuration has been cached, the .env file will not be loaded and all calls to the env function will return null.

event() event()

event関数は、指定したイベントをリスナにディスパッチします。The event function dispatches the given event[/docs/{{version}}/events] to its listeners:

event(new UserRegistered($user));

fake() fake()

fake関数は、コンテナからFakerシングルトンを依存解決します。これは、モデルファクトリ、データベース初期値設定、テスト、プロトタイピングビューでフェイクデータを作成する場合に便利です。The fake function resolves a Faker[https://github.com/FakerPHP/Faker] singleton from the container, which can be useful when creating fake data in model factories, database seeding, tests, and prototyping views:

@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関数でロケールを直接指定することもできます。各ロケールは個々のシングルトンを解決します:By default, the fake function will utilize the app.faker_locale configuration option in your config/app.php configuration file; however, you may also specify the locale by passing it to the fake function. Each locale will resolve an individual singleton:

fake('nl_NL')->name()

filled() filled()

filled期間関数は、指定された値が「空白」でないかどうかを判別します。The filled function determines whether the given value is not "blank":

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

// true

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

// false

filledの逆の動作は、blankメソッドです。For the inverse of filled, see the blank[#method-blank] method.

info() info()

info関数は、アプリケーションのログへ情報を書き込みます。The info function will write information to your application's log[/docs/{{version}}/logging]:

info('Some helpful information!');

関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:

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

logger() logger()

logger関数は、debugレベルのメッセージをログへ書き出します。The logger function can be used to write a debug level message to the log[/docs/{{version}}/logging]:

logger('Debug message');

関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:

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

関数に値を渡さない場合は、ロガーインスタンスが返されます。A logger[/docs/{{version}}/errors#logging] instance will be returned if no value is passed to the function:

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

method_field() method_field()

method_field関数はフォームのHTTP動詞の見せかけの値を保持する「隠し」HTTP入力フィールドを生成します。Blade記法を使う例です。The method_field function generates an HTML hidden input field containing the spoofed value of the form's HTTP verb. For example, using Blade syntax[/docs/{{version}}/blade]:

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

now() now()

now関数は、現時点を表す新しいIlluminate\Support\Carbonインスタンスを生成します。The now function creates a new Illuminate\Support\Carbon instance for the current time:

$now = now();

old() old()

old関数はセッションに一時保持データーとして保存されている直前の入力値を取得します。The old function retrieves[/docs/{{version}}/requests#retrieving-input] an old input[/docs/{{version}}/requests#old-input] value flashed into the session:

$value = old('value');

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

old関数の第２引数として指定される「デフォルト値」は、Eloquentモデルの属性であることが多いため、LaravelではEloquentモデル全体をold関数の第２引数として渡せるようになっています。この場合、Laravelはold関数に渡された最初の引数を「デフォルト値」とみなすべきEloquent属性の名前として扱います。Since the "default value" provided as the second argument to the old function is often an attribute of an Eloquent model, Laravel allows you to simply pass the entire Eloquent model as the second argument to the old function. When doing so, Laravel will assume the first argument provided to the old function is the name of the Eloquent attribute that should be considered the "default value":

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

// 上記は下記と同じ

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

optional() optional()

optional関数はどんな引数も指定でき、そのオブジェクトのプロパティへアクセスするか、メソッドを呼び出せます。指定したオブジェクトがnullだった場合、エラーを発生させる代わりに、プロパティとメソッドはnullを返します。The optional function accepts any argument and allows you to access properties or call methods on that object. If the given object is null, properties and methods will return null instead of causing an error:

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

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

optional関数は、２番目の引数としてクロージャも受け入れます。最初の引数として指定された値がnullでない場合、クロージャが呼び出されます。The optional function also accepts a closure as its second argument. The closure will be invoked if the value provided as the first argument is not null:

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

policy() policy()

policy関数は、指定クラスのポリシーインスタンスを取得します。The policy method retrieves a policy[/docs/{{version}}/authorization#creating-policies] instance for a given class:

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

redirect() redirect()

redirect関数は、リダイレクトHTTPレスポンスを返します。引数無しで呼び出した場合は、リダイレクタインスタンスを返します。The redirect function returns a redirect HTTP response[/docs/{{version}}/responses#redirects], or returns the redirector instance if called with no arguments:

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

return redirect('/home');

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

report() report()

report関数は例外ハンドラを使用して例外をレポートします。The report function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler]:

report($e);

report関数は文字列を引数に取ります。関数に文字列が与えられると、関数は指定する文字列をメッセージとする例外を作成します。The report function also accepts a string as an argument. When a string is given to the function, the function will create an exception with the given string as its message:

report('Something went wrong.');

report_if() report_if()

report_if関数は、指定条件がtrueであれば、あなたの例外ハンドラを使って例外を報告します。The report_if function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler] if the given condition is true:

report_if($shouldReport, $e);

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

report_unless() report_unless()

report_unless関数は、指定条件がfalseであれば、あなたの例外ハンドラを使って例外を報告します。The report_unless function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler] if the given condition is false:

report_unless($reportingDisabled, $e);

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

request() request()

request関数は、現在のrequestインスタンスを返すか、現在のリクエストから入力フィールドの値を取得します。The request function returns the current request[/docs/{{version}}/requests] instance or obtains an input field's value from the current request:

$request = request();

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

rescue() rescue()

rescue関数は指定されたクロージャを実行し、その実行中に発生した例外をすべてキャッチします。キャッチした例外はすべて例外ハンドラへ送られますが、リクエストの処理は続行されます。The rescue function executes the given closure and catches any exceptions that occur during its execution. All exceptions that are caught will be sent to your exception handler[/docs/{{version}}/errors#the-exception-handler]; however, the request will continue processing:

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

rescue関数に２番目の引数を渡すこともできます。この引数は、クロージャの実行で例外が発生した場合に返す「デフォルト」値です。You may also pass a second argument to the rescue function. This argument will be the "default" value that should be returned if an exception occurs while executing the closure:

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

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

例外をreport関数でレポートするかを決定するために、rescue関数にreport引数を指定できます。A report argument may be provided to the rescue function to determine if the exception should be reported via the report function:

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

resolve() resolve()

resolve関数は、サービスコンテナを使用して、指定したクラスまたはインターフェイス名をインスタンスへ依存解決します。The resolve function resolves a given class or interface name to an instance using the service container[/docs/{{version}}/container]:

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

response() response()

response関数はresponseインスタンスを返すか、レスポンスファクトリのインスタンスを取得します。The response function creates a response[/docs/{{version}}/responses] instance or obtains an instance of the response factory:

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

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

retry() retry()

retry関数は指定された最大試行回数を過ぎるまで、指定されたコールバックを実行します。コールバックが例外を投げなければ、返却値を返します。コールバックが例外を投げた場合は、自動的にリトライします。最大試行回数を超えると、例外を投げます。The retry function attempts to execute the given callback until the given maximum attempt threshold is met. If the callback does not throw an exception, its return value will be returned. If the callback throws an exception, it will automatically be retried. If the maximum attempt count is exceeded, the exception will be thrown:

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

もし、試行間隔を何ミリ秒にするかを手作業で計算したい場合は、retry関数の第３引数へクロージャを渡します。If you would like to manually calculate the number of milliseconds to sleep between attempts, you may pass a closure as the third argument to the retry function:

use Exception;

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

便利なように、retry関数の最初の引数には配列を指定することもできます。この配列は、次の再試行の間に何ミリ秒スリープさせるかを決定するために使用されます。For convenience, you may provide an array as the first argument to the retry function. This array will be used to determine how many milliseconds to sleep between subsequent attempts:

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

特定条件下でのみ再試行するには、retry関数への4番目の引数としてクロージャを渡せます。To only retry under specific conditions, you may pass a closure as the fourth argument to the retry function:

use Exception;

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

session() session()

session関数はセッションへ値を設定、もしくは取得するために使用します。The session function may be used to get or set session[/docs/{{version}}/session] values:

$value = session('key');

キー／値ペアの配列を渡し、値を設定できます。You may set values by passing an array of key / value pairs to the function:

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

関数に引数を渡さない場合は、セッション保存域が返されます。The session store will be returned if no value is passed to the function:

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

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

tap() tap()

tap関数は、任意の$valueとクロージャの２つの引数を受け入れます。$valueはクロージャに渡され、tap関数によって返されます。クロージャの戻り値は関係ありません。The tap function accepts two arguments: an arbitrary $value and a closure. The $value will be passed to the closure and then be returned by the tap function. The return value of the closure is irrelevant:

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

    $user->save();
});

tap関数にクロージャが渡されない場合は、指定した$valueで任意のメソッドを呼び出せます。呼び出すメソッドの戻り値は、メソッドがその定義で実際に何を返すかに関係なく、常に$valueになります。たとえば、Eloquentのupdateメソッドは通常、整数を返します。しかし、tap関数を介してupdateメソッド呼び出しをチェーンすることで、メソッドへモデル自体を返すように強制できます。If no closure is passed to the tap function, you may call any method on the given $value. The return value of the method you call will always be $value, regardless of what the method actually returns in its definition. For example, the Eloquent update method typically returns an integer. However, we can force the method to return the model itself by chaining the update method call through the tap function:

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

クラスへtapメソッドを追加するには、Illuminate\Support\Traits\Tappableトレイトをそのクラスへ追加してください。このトレイトのtapメソッドはクロージャだけを引数に受け取ります。オブジェクトインスタンス自身がクロージャに渡され、tapメソッドによりリターンされます。To add a tap method to a class, you may add the Illuminate\Support\Traits\Tappable trait to the class. The tap method of this trait accepts a Closure as its only argument. The object instance itself will be passed to the Closure and then be returned by the tap method:

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

throw_if() throw_if()

throw_if関数は、指定した論理式がtrueと評価された場合に、指定した例外を投げます。The throw_if function throws the given exception if a given boolean expression evaluates to 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()

throw_unless関数は、指定した論理式がfalseと評価された場合に、指定した例外を投げます。The throw_unless function throws the given exception if a given boolean expression evaluates to 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()

today関数は、現在の日付を表す新しいIlluminate\Support\Carbonインスタンスを生成します。The today function creates a new Illuminate\Support\Carbon instance for the current date:

$today = today();

trait_uses_recursive() trait_uses_recursive()

trait_uses_recursive関数は、そのトレイトで使用されている全トレイトを返します。The trait_uses_recursive function returns all traits used by a trait:

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

transform() transform()

transform関数は、値が空白でない場合、指定値に対してクロージャを実行し、クロージャの戻り値を返します。The transform function executes a closure on a given value if the value is not blank[#method-blank] and then returns the return value of the closure:

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

$result = transform(5, $callback);

// 10

デフォルト値またはクロージャは、関数の３番目の引数として渡せます。指定値が空白の場合、この値をが返します。A default value or closure may be passed as the third argument to the function. This value will be returned if the given value is blank:

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

// 値は空白

validator() validator()

validator関数は、引数を使用して新しいバリデータインスタンスを作成します。Validatorファサードの代わりに使用できます。The validator function creates a new validator[/docs/{{version}}/validation] instance with the given arguments. You may use it as an alternative to the Validator facade:

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

value() value()

value関数は、指定値を返します。ただし、関数へクロージャを渡すと、そのクロージャを実行し、その戻り値を返します。The value function returns the value it is given. However, if you pass a closure to the function, the closure will be executed and its returned value will be returned:

$result = value(true);

// true

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

// false

value関数に追加の引数を渡すこともできます。最初の引数がクロージャであれば、追加した引数はクロージャの引数として渡されます。クロージャでなければ、無視します。Additional arguments may be passed to the value function. If the first argument is a closure then the additional parameters will be passed to the closure as arguments, otherwise they will be ignored:

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

// 'Taylor'

view() view()

view関数はviewインスタンスを返します。The view function retrieves a view[/docs/{{version}}/views] instance:

return view('auth.login');

with() with()

with関数は、指定値を返します。関数の２番目の引数としてクロージャを渡たすと、クロージャが実行され、その戻り値を返します。The with function returns the value it is given. If a closure is passed as the second argument to the function, the closure will be executed and its returned value will be returned:

$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

その他のユーティリティOther Utilities

ベンチマークBenchmarking

時には、アプリケーションの特定の部分のパフォーマンスを素早くテストしたいと思うこともあるでしょう。そのような場合は、Benchmarkサポートクラスを利用して、指定するコールバックが完了するまでにかかるミリ秒を測定できます。Sometimes you may wish to quickly test the performance of certain parts of your application. On those occasions, you may utilize the Benchmark support class to measure the number of milliseconds it takes for the given callbacks to complete:

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

デフォルトでは、指定したコールバックは、１回（１繰り返し）実行され、その期間はブラウザ／コンソールに表示されます。By default, the given callbacks will be executed once (one iteration), and their duration will be displayed in the browser / console.

コールバックを複数回呼び出すには、メソッドの第２引数でコールバックを呼び出す反復回数を指定してください。コールバックを複数回実行する場合、Benchmarkクラスはコールバックの実行にかかった平均ミリ秒を返します。To invoke a callback more than once, you may specify the number of iterations that the callback should be invoked as the second argument to the method. When executing a callback more than once, the Benchmark class will return the average amount of milliseconds it took to execute the callback across all iterations:

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

コールバックが返す値を取得しながら、コールバックの実行をベンチマークしたい場合もあるでしょう。valueメソッドはコールバックが返した値と、コールバックの実行にかかったミリ秒数を含むタプルを返します：Sometimes, you may want to benchmark the execution of a callback while still obtaining the value returned by the callback. The value method will return a tuple containing the value returned by the callback and the amount of milliseconds it took to execute the callback:

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

日付Dates

Laravelは、強力な日付と時間の操作ライブラリであるCarbonを含んでいます。新しいCarbonインスタンスを作成するには、now関数を呼び出してください。この関数はLaravelアプリケーション内でグローバルに利用可能です。Laravel includes Carbon[https://carbon.nesbot.com/docs/], a powerful date and time manipulation library. To create a new Carbon instance, you may invoke the now function. This function is globally available within your Laravel application:

$now = now();

もしくは、Illuminate\Support\Carbonクラスを使い、新しいCarbonインスタンスを作成できます。Or, you may create a new Carbon instance using the Illuminate\Support\Carbon class:

use Illuminate\Support\Carbon;

$now = Carbon::now();

Carbonの概要や特徴については、Carbon公式ドキュメントを参照してください。For a thorough discussion of Carbon and its features, please consult the official Carbon documentation[https://carbon.nesbot.com/docs/].

抽選Lottery

Laravelの抽選クラスは、指定する確率セットに基づき、コールバックを実行するために使用します。この機能は、受信リクエストの何パーセントだけに対し、コードを実行したい場合、特に便利です。Laravel's lottery class may be used to execute callbacks based on a set of given odds. This can be particularly useful when you only want to execute code for a percentage of your incoming requests:

use Illuminate\Support\Lottery;

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

Laravelの抽選クラスとLaravelの別機能を組み合わせることもできます。例えば、スロークエリのごく一部だけを例外ハンドラに報告したい場合などです。また、抽選クラスはCallableなので、Callableを引数に取るメソッドへ、クラスインスタンスを渡せます。You may combine Laravel's lottery class with other Laravel features. For example, you may wish to only report a small percentage of slow queries to your exception handler. And, since the lottery class is callable, we may pass an instance of the class into any method that accepts callables:

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

抽選のテストTesting Lotteries

Laravelは、アプリケーションでの抽選の呼び出しを簡単にテストできるように、簡単なメソッドをいくつか提供しています。Laravel provides some simple methods to allow you to easily test your application's lottery invocations:

// 抽選は常に当選する
Lottery::alwaysWin();

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

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

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

パイプラインPipeline

LaravelのPipelineファサードは、指定する入力を一連の呼び出し可能なクラス、クロージャ、Callableを通して、「パイプ」接続する便利な方法を提供し、各クラスに入力を検査または修正する機会を与え、パイプラインの次のCallableを呼び出します。Laravel's Pipeline facade provides a convenient way to "pipe" a given input through a series of invokable classes, closures, or callables, giving each class the opportunity to inspect or modify the input and invoke the next callable in the pipeline:

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

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

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

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

ご覧のように、パイプライン中の呼び出し可能な各クラスやクロージャには、入力と$nextクロージャを引数に渡します。nextクロージャが呼び出されると、パイプラインの次の呼び出し可能なクラスを呼び出します。お気づきかもしれませんが、これは ミドルウェア と非常によく似ています。As you can see, each invokable class or closure in the pipeline is provided the input and a $next closure. Invoking the $next closure will invoke the next callable in the pipeline. As you may have noticed, this is very similar to middleware[/docs/{{version}}/middleware].

パイプラインの最後のCallableが$nextクロージャを呼び出すと、thenメソッドに渡されたCallableを呼び出します。一般的に、このCallableは単に与えられた入力を返すだけです。When the last callable in the pipeline invokes the $next closure, the callable provided to the then method will be invoked. Typically, this callable will simply return the given input.

もちろん、前述したように、パイプラインに渡すのは、クロージャに限定されません。呼び出し可能なクラスを提供することもできます。クラス名が提供された場合、そのクラスはLaravelのサービスコンテナを通じてインスタンス化し、呼び出し可能なクラスへ依存関係を注入します。Of course, as discussed previously, you are not limited to providing closures to your pipeline. You may also provide invokable classes. If a class name is provided, the class will be instantiated via Laravel's service container[/docs/{{version}}/container], allowing dependencies to be injected into the invokable class:

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

スリープSleep

LaravelのSleepクラスは、PHPネイティブのsleepとusleep関数の軽量ラッパーで、テスト性を高めるとともに、開発者に優しい時間操作のためのAPIを公開しています。Laravel's Sleep class is a light-weight wrapper around PHP's native sleep and usleep functions, offering greater testability while also exposing a developer friendly API for working with time:

use Illuminate\Support\Sleep;

$waiting = true;

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

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

Sleepクラスは、異なる時間単位を扱う様々なメソッドを提供しています。The Sleep class offers a variety of methods that allow you to work with different units of time:

// 実行を９０秒停止
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メソッドを使用します。To easily combine units of time, you may use the and method:

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

スリープのテストTesting Sleep

SleepクラスやPHPネイティブのスリープ関数を使用するコードをテストする場合、テストの実行は一時停止します。皆さんの予想通り、これはテストスイートの速度を著しく低下させます。たとえば、次のようなコードをテストしているとしましょう：When testing code that utilizes the Sleep class or PHP's native sleep functions, your test will pause execution. As you might expect, this makes your test suite significantly slower. For example, imagine you are testing the following code:

$waiting = /* ... */;

$seconds = 1;

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

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

通常、このコードのテストは最低でも１秒かかるでしょう。幸運なことに、Sleepクラスは、テストスイートを高速に保つために、スリープを「Fake」できます。Typically, testing this code would take at least one second. Luckily, the Sleep class allows us to "fake" sleeping so that our test suite stays fast:

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

    // ...
}

SleepクラスをFakeする場合、実際の実行の一時停止はバイパスされるため、テストが大幅に高速化されます。When faking the Sleep class, the actual execution pause is by-passed, leading to a substantially faster test.

一度SleepクラスをFakeすると、本来発生するはずの「スリープ」に対してアサートできるようになります。これを説明するために、実行を３回一時停止するコードをテストしていると仮定します。（各停止時間は１秒ずつ増加させます。）assertSequenceメソッドを使用すると、テストの速度を維持したまま、適切な時間だけコードが「スリープ」したことをアサートできます：Once the Sleep class has been faked, it is possible to make assertions against the expected "sleeps" that should have occurred. To illustrate this, let's imagine we are testing code that pauses execution three times, with each pause increasing by a single second. Using the assertSequence method, we can assert that our code "slept" for the proper amount of time while keeping our test fast:

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クラスには、テスト時に使用する他の様々なアサーションを用意しています。Of course, the Sleep class offers a variety of other assertions you may use when testing:

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の間隔ごとで、瞬時に時間を進めています。Sometimes it may be useful to perform an action whenever a fake sleep occurs in your application code. To achieve this, you may provide a callback to the whenFakingSleep method. In the following example, we use Laravel's time manipulation helpers[/docs/{{version}}/mocking#interacting-with-time] to instantly progress time by the duration of each 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クラスを使用し、そのヘルパを使用する際のテストの実行性を上げています。Laravel uses the Sleep class internally whenever it is pausing execution. For example, the retry[#method-retry] helper uses the Sleep class when sleeping, allowing for improved testability when using that helper.