ヘルパ

イントロダクション
利用可能なメソッド
その他のユーティリティ

イントロダクション

Laravelには、さまざまなグローバル「ヘルパ」PHP関数が含まれています。これらの関数の多くはフレームワーク自体が使用していますが、便利だと思えばアプリケーションで自由に使用できます。

利用可能なメソッド

配列とオブジェクト

`Arr::accessible()`

Arr::accessibleメソッドは、指定した値が配列としてアクセス可能か判定します。

 1use Illuminate\Support\Arr;
 2use Illuminate\Support\Collection;
 3 
 4$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
 5 
 6// true
 7 
 8$isAccessible = Arr::accessible(new Collection);
 9 
10// true
11 
12$isAccessible = Arr::accessible('abc');
13 
14// false
15 
16$isAccessible = Arr::accessible(new stdClass);
17 
18// false

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に設定されている場合に、指定したキーと値のペアを配列に追加します。

1use Illuminate\Support\Arr;
2 
3$array = Arr::add(['name' => 'Desk'], 'price', 100);
4 
5// ['name' => 'Desk', 'price' => 100]
6 
7$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
8 
9// ['name' => 'Desk', 'price' => 100]

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メソッドは、配列の配列を1つの配列にまとめます。

1use Illuminate\Support\Arr;
2 
3$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
4 
5// [1, 2, 3, 4, 5, 6, 7, 8, 9]

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メソッドは、指定した配列をクロス結合し、すべての可能な順列を持つデカルト積を返します。

 1use Illuminate\Support\Arr;
 2 
 3$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
 4 
 5/*
 6    [
 7        [1, 'a'],
 8        [1, 'b'],
 9        [2, 'a'],
10        [2, 'b'],
11    ]
12*/
13 
14$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
15 
16/*
17    [
18        [1, 'a', 'I'],
19        [1, 'a', 'II'],
20        [1, 'b', 'I'],
21        [1, 'b', 'II'],
22        [2, 'a', 'I'],
23        [2, 'a', 'II'],
24        [2, 'b', 'I'],
25        [2, 'b', 'II'],
26    ]
27*/

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メソッドは2つの配列を返します。1つはキーを、もう1つは指定した配列の値を含みます。

1use Illuminate\Support\Arr;
2 
3[$keys, $values] = Arr::divide(['name' => 'Desk']);
4 
5// $keys: ['name']
6 
7// $values: ['Desk']

use Illuminate\Support\Arr;

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

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

Arr::dotメソッドは、多次元配列を「ドット」記法を使用して深さを示す単一レベルの配列に平坦化します。

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$flattened = Arr::dot($array);
6 
7// ['products.desk.price' => 100]

use Illuminate\Support\Arr;

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

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

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

`Arr::except()`

Arr::exceptメソッドは、配列から指定したキーと値のペアを削除します。

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$filtered = Arr::except($array, ['price']);
6 
7// ['name' => 'Desk']

use Illuminate\Support\Arr;

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

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

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

`Arr::exists()`

Arr::existsメソッドは、指定したキーが指定した配列に存在するかをチェックします。

 1use Illuminate\Support\Arr;
 2 
 3$array = ['name' => 'John Doe', 'age' => 17];
 4 
 5$exists = Arr::exists($array, 'name');
 6 
 7// true
 8 
 9$exists = Arr::exists($array, 'salary');
10 
11// false

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メソッドは、指定した真偽テストに合格する配列の最初の要素を返します。

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300];
4 
5$first = Arr::first($array, function (int $value, int $key) {
6    return $value >= 150;
7});
8 
9// 200

use Illuminate\Support\Arr;

$array = [100, 200, 300];

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

// 200

メソッドの３番目のパラメータとして、デフォルト値を渡すこともできます。この値は、真偽値テストに合格する値がない場合に返されます。

1use Illuminate\Support\Arr;
2 
3$first = Arr::first($array, $callback, $default);

use Illuminate\Support\Arr;

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

`Arr::flatten()`

Arr::flattenメソッドは、多次元配列を単一レベルの配列に平坦化します。

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
4 
5$flattened = Arr::flatten($array);
6 
7// ['Joe', 'PHP', 'Ruby']

use Illuminate\Support\Arr;

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

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

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

`Arr::forget()`

Arr::forgetメソッドは、「ドット」記法を使用して、深くネストされた配列から特定のキー／値ペアを削除します。

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::forget($array, 'products.desk');
6 
7// ['products' => []]

use Illuminate\Support\Arr;

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

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

// ['products' => []]

`Arr::get()`

Arr::getメソッドは、「ドット」記法を使用して、深くネストした配列から値を取得します。

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5$price = Arr::get($array, 'products.desk.price');
6 
7// 100

use Illuminate\Support\Arr;

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

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

// 100

Arr::getメソッドはデフォルト値も受け入れます。指定したキーが配列に存在しない場合は、そのデフォルト値が返されます。

1use Illuminate\Support\Arr;
2 
3$discount = Arr::get($array, 'products.desk.discount', 0);
4 
5// 0

use Illuminate\Support\Arr;

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

// 0

`Arr::has()`

Arr::hasメソッドは、「ドット」記法を使用して、特定のアイテムが配列に存在するかどうかをチェックします。

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::has($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::has($array, ['product.price', 'product.discount']);
10 
11// false

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メソッドは、「ドット」記法を使用して、特定のセットのいずれかのアイテムが配列に存在するかどうかをチェックします。

 1use Illuminate\Support\Arr;
 2 
 3$array = ['product' => ['name' => 'Desk', 'price' => 100]];
 4 
 5$contains = Arr::hasAny($array, 'product.name');
 6 
 7// true
 8 
 9$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
10 
11// true
12 
13$contains = Arr::hasAny($array, ['category', 'product.discount']);
14 
15// false

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から始まる連続した数値キーを持たない場合に「連想配列」と見なされます。

1use Illuminate\Support\Arr;
2 
3$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
4 
5// true
6 
7$isAssoc = Arr::isAssoc([1, 2, 3]);
8 
9// false

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を返します。

1use Illuminate\Support\Arr;
2 
3$isList = Arr::isList(['foo', 'bar', 'baz']);
4 
5// true
6 
7$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
8 
9// false

use Illuminate\Support\Arr;

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

// true

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

// false

`Arr::join()`

Arr::joinメソッドは、配列の要素を文字列で結合します。このメソッドの２番目の引数を使用すると、配列の最後の要素の結合文字列を指定することもできます。

 1use Illuminate\Support\Arr;
 2 
 3$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];
 4 
 5$joined = Arr::join($array, ', ');
 6 
 7// Tailwind, Alpine, Laravel, Livewire
 8 
 9$joined = Arr::join($array, ', ', ' and ');
10 
11// Tailwind, Alpine, Laravel and Livewire

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メソッドは、指定したキーで配列をキー付けします。複数のアイテムが同じキーを持つ場合、新しい配列には最後のアイテムのみが表示されます。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['product_id' => 'prod-100', 'name' => 'Desk'],
 5    ['product_id' => 'prod-200', 'name' => 'Chair'],
 6];
 7 
 8$keyed = Arr::keyBy($array, 'product_id');
 9 
10/*
11    [
12        'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
13        'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
14    ]
15*/

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メソッドは、指定した真偽テストに合格した配列の最後の要素を返します。

1use Illuminate\Support\Arr;
2 
3$array = [100, 200, 300, 110];
4 
5$last = Arr::last($array, function (int $value, int $key) {
6    return $value >= 150;
7});
8 
9// 300

use Illuminate\Support\Arr;

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

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

// 300

メソッドの３番目の引数として、デフォルト値を渡すことができます。この値は、真偽値テストに合格する値がない場合に返されます。

1use Illuminate\Support\Arr;
2 
3$last = Arr::last($array, $callback, $default);

use Illuminate\Support\Arr;

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

`Arr::map()`

Arr::mapメソッドは配列を反復処理し、各値とキーを指定したコールバックに渡します。配列の値は、コールバックから返された値に置き換えられます。

1use Illuminate\Support\Arr;
2 
3$array = ['first' => 'james', 'last' => 'kirk'];
4 
5$mapped = Arr::map($array, function (string $value, string $key) {
6    return ucfirst($value);
7});
8 
9// ['first' => 'James', 'last' => 'Kirk']

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

Arr::mapSpreadメソッドは配列を繰り返し処理し、ネストされた各アイテムの値を指定したクロージャに渡します。クロージャはアイテムを自由に変更して返すことができるため、変更されたアイテムの新しい配列が形成されます。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    [0, 1],
 5    [2, 3],
 6    [4, 5],
 7    [6, 7],
 8    [8, 9],
 9];
10 
11$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
12    return $even + $odd;
13});
14 
15/*
16    [1, 5, 9, 13, 17]
17*/

use Illuminate\Support\Arr;

$array = [
    [0, 1],
    [2, 3],
    [4, 5],
    [6, 7],
    [8, 9],
];

$mapped = Arr::mapSpread($array, function (int $even, int $odd) {
    return $even + $odd;
});

/*
    [1, 5, 9, 13, 17]
*/

`Arr::mapWithKeys()`

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    [
 5        'name' => 'John',
 6        'department' => 'Sales',
 7        'email' => '[email protected]',
 8    ],
 9    [
10        'name' => 'Jane',
11        'department' => 'Marketing',
12        'email' => '[email protected]',
13    ]
14];
15 
16$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
17    return [$item['email'] => $item['name']];
18});
19 
20/*
21    [
22        '[email protected]' => 'John',
23        '[email protected]' => 'Jane',
24    ]
25*/

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => '[email protected]',
    ],
    [
        'name' => 'Jane',
        'department' => 'Marketing',
        'email' => '[email protected]',
    ]
];

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

/*
    [
        '[email protected]' => 'John',
        '[email protected]' => 'Jane',
    ]
*/

`Arr::only()`

Arr::onlyメソッドは、指定した配列から指定したキー／値のペアのみを返します。

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
4 
5$slice = Arr::only($array, ['name', 'price']);
6 
7// ['name' => 'Desk', 'price' => 100]

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メソッドは、配列から特定のキーの値をすべて取得します。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['developer' => ['id' => 1, 'name' => 'Taylor']],
 5    ['developer' => ['id' => 2, 'name' => 'Abigail']],
 6];
 7 
 8$names = Arr::pluck($array, 'developer.name');
 9 
10// ['Taylor', 'Abigail']

use Illuminate\Support\Arr;

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

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

// ['Taylor', 'Abigail']

結果のリストをどのようにキー付けしたいかを指定することもできます。

1use Illuminate\Support\Arr;
2 
3$names = Arr::pluck($array, 'developer.name', 'developer.id');
4 
5// [1 => 'Taylor', 2 => 'Abigail']

use Illuminate\Support\Arr;

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

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

`Arr::prepend()`

Arr::prependメソッドは、配列の先頭にアイテムをプッシュします。

1use Illuminate\Support\Arr;
2 
3$array = ['one', 'two', 'three', 'four'];
4 
5$array = Arr::prepend($array, 'zero');
6 
7// ['zero', 'one', 'two', 'three', 'four']

use Illuminate\Support\Arr;

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

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

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

必要であれば、値に使用するキーを指定できます。

1use Illuminate\Support\Arr;
2 
3$array = ['price' => 100];
4 
5$array = Arr::prepend($array, 'Desk', 'name');
6 
7// ['name' => 'Desk', 'price' => 100]

use Illuminate\Support\Arr;

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

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

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

`Arr::prependKeysWith()`

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

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Desk',
 5    'price' => 100,
 6];
 7 
 8$keyed = Arr::prependKeysWith($array, 'product.');
 9 
10/*
11    [
12        'product.name' => 'Desk',
13        'product.price' => 100,
14    ]
15*/

use Illuminate\Support\Arr;

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

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

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

`Arr::pull()`

Arr::pullメソッドは、配列からキーと値のペアを取得し、削除します。

1use Illuminate\Support\Arr;
2 
3$array = ['name' => 'Desk', 'price' => 100];
4 
5$name = Arr::pull($array, 'name');
6 
7// $name: Desk
8 
9// $array: ['price' => 100]

use Illuminate\Support\Arr;

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

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

// $name: Desk

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

メソッドの3番目の引数として、デフォルト値を渡すことができます。この値は、キーが存在しない場合に返されます。

1use Illuminate\Support\Arr;
2 
3$value = Arr::pull($array, $key, $default);

use Illuminate\Support\Arr;

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

`Arr::query()`

Arr::queryメソッドは、配列をクエリ文字列に変換します。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'name' => 'Taylor',
 5    'order' => [
 6        'column' => 'created_at',
 7        'direction' => 'desc'
 8    ]
 9];
10 
11Arr::query($array);
12 
13// name=Taylor&order[column]=created_at&order[direction]=desc

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メソッドは、配列からランダムな値を返します。

1use Illuminate\Support\Arr;
2 
3$array = [1, 2, 3, 4, 5];
4 
5$random = Arr::random($array);
6 
7// 4 - (retrieved randomly)

use Illuminate\Support\Arr;

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

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

// 4 - (retrieved randomly)

オプションの２番目の引数として返すアイテムの数を指定することもできます。この引数を指定すると、１つのアイテムのみが必要な場合でも配列が返されることに注意してください。

1use Illuminate\Support\Arr;
2 
3$items = Arr::random($array, 2);
4 
5// [2, 5] - (retrieved randomly)

use Illuminate\Support\Arr;

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

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

`Arr::set()`

Arr::setメソッドは、「ドット」記法を使用して、深くネストされた配列内に値を設定します。

1use Illuminate\Support\Arr;
2 
3$array = ['products' => ['desk' => ['price' => 100]]];
4 
5Arr::set($array, 'products.desk.price', 200);
6 
7// ['products' => ['desk' => ['price' => 200]]]

use Illuminate\Support\Arr;

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

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

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

`Arr::shuffle()`

Arr::shuffleメソッドは、配列内のアイテムをランダムにシャッフルします。

1use Illuminate\Support\Arr;
2 
3$array = Arr::shuffle([1, 2, 3, 4, 5]);
4 
5// [3, 2, 5, 1, 4] - (generated randomly)

use Illuminate\Support\Arr;

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

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

`Arr::sort()`

Arr::sortメソッドは、配列を値でソートします。

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sort($array);
6 
7// ['Chair', 'Desk', 'Table']

use Illuminate\Support\Arr;

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

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

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

指定したクロージャの結果で配列をソートすることもできます。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sort($array, function (array $value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Chair'],
16        ['name' => 'Desk'],
17        ['name' => 'Table'],
18    ]
19*/

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メソッドは、配列をその値で降順にソートします。

1use Illuminate\Support\Arr;
2 
3$array = ['Desk', 'Table', 'Chair'];
4 
5$sorted = Arr::sortDesc($array);
6 
7// ['Table', 'Desk', 'Chair']

use Illuminate\Support\Arr;

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

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

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

指定したクロージャの結果で配列をソートすることもできます。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['name' => 'Desk'],
 5    ['name' => 'Table'],
 6    ['name' => 'Chair'],
 7];
 8 
 9$sorted = array_values(Arr::sortDesc($array, function (array $value) {
10    return $value['name'];
11}));
12 
13/*
14    [
15        ['name' => 'Table'],
16        ['name' => 'Desk'],
17        ['name' => 'Chair'],
18    ]
19*/

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関数を使用して、配列を再帰的にソートします。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    ['Roman', 'Taylor', 'Li'],
 5    ['PHP', 'Ruby', 'JavaScript'],
 6    ['one' => 1, 'two' => 2, 'three' => 3],
 7];
 8 
 9$sorted = Arr::sortRecursive($array);
10 
11/*
12    [
13        ['JavaScript', 'PHP', 'Ruby'],
14        ['one' => 1, 'three' => 3, 'two' => 2],
15        ['Li', 'Roman', 'Taylor'],
16    ]
17*/

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メソッドを使用できます。

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

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

`Arr::take()`

Arr::takeメソッドは、指定した数のアイテムを持つ新しい配列を返します。

1use Illuminate\Support\Arr;
2 
3$array = [0, 1, 2, 3, 4, 5];
4 
5$chunk = Arr::take($array, 3);
6 
7// [0, 1, 2]

use Illuminate\Support\Arr;

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

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

// [0, 1, 2]

負の整数を渡して、配列の末尾から指定した数のアイテムを取得することもできます。

1$array = [0, 1, 2, 3, 4, 5];
2 
3$chunk = Arr::take($array, -2);
4 
5// [4, 5]

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

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

// [4, 5]

`Arr::toCssClasses()`

Arr::toCssClassesメソッドは、CSSクラス文字列を条件付きでコンパイルします。このメソッドは、配列キーに追加したいクラスを含み、値がブール式であるクラスの配列を受け入れます。配列要素に数値キーがある場合、それは常にレンダリングされるクラスリストに含まれます。

 1use Illuminate\Support\Arr;
 2 
 3$isActive = false;
 4$hasError = true;
 5 
 6$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
 7 
 8$classes = Arr::toCssClasses($array);
 9 
10/*
11    'p-4 bg-red'
12*/

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スタイル文字列を条件付きでコンパイルします。このメソッドは、配列キーに追加したいクラスを含み、値がブール式であるクラスの配列を受け入れます。配列要素に数値キーがある場合、それは常にレンダリングされるクラスリストに含まれます。

 1use Illuminate\Support\Arr;
 2 
 3$hasColor = true;
 4 
 5$array = ['background-color: blue', 'color: blue' => $hasColor];
 6 
 7$classes = Arr::toCssStyles($array);
 8 
 9/*
10    'background-color: blue; color: blue;'
11*/

use Illuminate\Support\Arr;

$hasColor = true;

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

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

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

このメソッドは、Laravelの機能であるBladeコンポーネントの属性バッグとクラスをマージする機能や、@classBladeディレクティブを動かすものです。

`Arr::undot()`

Arr::undotメソッドは、「ドット」記法を使用した１次元配列を多次元配列に展開します。

 1use Illuminate\Support\Arr;
 2 
 3$array = [
 4    'user.name' => 'Kevin Malone',
 5    'user.occupation' => 'Accountant',
 6];
 7 
 8$array = Arr::undot($array);
 9 
10// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

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メソッドは、指定したクロージャを使用して配列をフィルタリングします。

1use Illuminate\Support\Arr;
2 
3$array = [100, '200', 300, '400', 500];
4 
5$filtered = Arr::where($array, function (string|int $value, int $key) {
6    return is_string($value);
7});
8 
9// [1 => '200', 3 => '400']

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値を削除します。

1use Illuminate\Support\Arr;
2 
3$array = [0, null];
4 
5$filtered = Arr::whereNotNull($array);
6 
7// [0 => 0]

use Illuminate\Support\Arr;

$array = [0, null];

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

// [0 => 0]

`Arr::wrap()`

Arr::wrapメソッドは、指定した値を配列でラップします。指定した値がすでに配列である場合は、変更せずに返されます。

1use Illuminate\Support\Arr;
2 
3$string = 'Laravel';
4 
5$array = Arr::wrap($string);
6 
7// ['Laravel']

use Illuminate\Support\Arr;

$string = 'Laravel';

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

// ['Laravel']

指定した値がnullの場合、空の配列が返されます。

1use Illuminate\Support\Arr;
2 
3$array = Arr::wrap(null);
4 
5// []

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

data_fill関数は、「ドット」記法を使用して、ネストした配列またはオブジェクト内の欠損値を設定します。

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_fill($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 100]]]
6 
7data_fill($data, 'products.desk.discount', 10);
8 
9// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

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

この関数はアスタリスクをワイルドカードとして受け入れ、それに応じてターゲットを埋めます。

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2'],
 5    ],
 6];
 7 
 8data_fill($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 100],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

$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関数は、「ドット」記法を使用して、ネストした配列またはオブジェクトから値を取得します。

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3$price = data_get($data, 'products.desk.price');
4 
5// 100

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

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

// 100

data_get関数はデフォルト値も受け入れます。指定したキーが見つからない場合は、そのデフォルト値が返されます。

1$discount = data_get($data, 'products.desk.discount', 0);
2 
3// 0

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

// 0

この関数はアスタリスクを使用したワイルドカードも受け入れ、配列またはオブジェクトの任意のキーを対象にできます。

1$data = [
2    'product-one' => ['name' => 'Desk 1', 'price' => 100],
3    'product-two' => ['name' => 'Desk 2', 'price' => 150],
4];
5 
6data_get($data, '*.name');
7 
8// ['Desk 1', 'Desk 2'];

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

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

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

{first}および{last}プレースホルダーを使用して、配列の最初または最後の項目を取得できます。

 1$flight = [
 2    'segments' => [
 3        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
 4        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
 5    ],
 6];
 7 
 8data_get($flight, 'segments.{first}.arrival');
 9 
10// 15:00

$flight = [
    'segments' => [
        ['from' => 'LHR', 'departure' => '9:00', 'to' => 'IST', 'arrival' => '15:00'],
        ['from' => 'IST', 'departure' => '16:00', 'to' => 'PKX', 'arrival' => '20:00'],
    ],
];

data_get($flight, 'segments.{first}.arrival');

// 15:00

`data_set()`

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

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 200]]]

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

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

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

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

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_set($data, 'products.*.price', 200);
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1', 'price' => 200],
14            ['name' => 'Desk 2', 'price' => 200],
15        ],
16    ]
17*/

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

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

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

デフォルトでは、既存の値は上書きされます。値が存在しない場合にのみ値を設定したい場合は、関数の４番目の引数としてfalseを渡してください。

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_set($data, 'products.desk.price', 200, overwrite: false);
4 
5// ['products' => ['desk' => ['price' => 100]]]

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

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

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

`data_forget()`

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

1$data = ['products' => ['desk' => ['price' => 100]]];
2 
3data_forget($data, 'products.desk.price');
4 
5// ['products' => ['desk' => []]]

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

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

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

この関数は、アスタリスクをワイルドカードとして受け入れ、それに応じてターゲットの値を削除します。

 1$data = [
 2    'products' => [
 3        ['name' => 'Desk 1', 'price' => 100],
 4        ['name' => 'Desk 2', 'price' => 150],
 5    ],
 6];
 7 
 8data_forget($data, 'products.*.price');
 9 
10/*
11    [
12        'products' => [
13            ['name' => 'Desk 1'],
14            ['name' => 'Desk 2'],
15        ],
16    ]
17*/

$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関数は、指定した配列の最初の要素を返します。

1$array = [100, 200, 300];
2 
3$first = head($array);
4 
5// 100

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

last関数は、指定した配列の最後の要素を返します。

1$array = [100, 200, 300];
2 
3$last = last($array);
4 
5// 300

$array = [100, 200, 300];

$last = last($array);

// 300

数値

`Number::abbreviate()`

Number::abbreviateメソッドは、指定した数値を、単位の省略形を付けて人間が読める形式で返します。

 1use Illuminate\Support\Number;
 2 
 3$number = Number::abbreviate(1000);
 4 
 5// 1K
 6 
 7$number = Number::abbreviate(489939);
 8 
 9// 490K
10 
11$number = Number::abbreviate(1230000, precision: 2);
12 
13// 1.23M

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メソッドは、指定した数値が指定した範囲内に収まるようにします。数値が最小値より低い場合は最小値が返されます。数値が最大値より高い場合は最大値が返されます。

 1use Illuminate\Support\Number;
 2 
 3$number = Number::clamp(105, min: 10, max: 100);
 4 
 5// 100
 6 
 7$number = Number::clamp(5, min: 10, max: 100);
 8 
 9// 10
10 
11$number = Number::clamp(10, min: 10, max: 100);
12 
13// 10
14 
15$number = Number::clamp(20, min: 10, max: 100);
16 
17// 20

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メソッドは、指定した値の通貨表現を文字列として返します。

 1use Illuminate\Support\Number;
 2 
 3$currency = Number::currency(1000);
 4 
 5// $1,000.00
 6 
 7$currency = Number::currency(1000, in: 'EUR');
 8 
 9// €1,000.00
10 
11$currency = Number::currency(1000, in: 'EUR', locale: 'de');
12 
13// 1.000,00 €

use Illuminate\Support\Number;

$currency = Number::currency(1000);

// $1,000.00

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

// €1,000.00

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

// 1.000,00 €

`Number::defaultCurrency()`

Number::defaultCurrencyメソッドは、Numberクラスが使用しているデフォルトの通貨を返します。

1use Illuminate\Support\Number;
2 
3$currency = Number::defaultCurrency();
4 
5// USD

use Illuminate\Support\Number;

$currency = Number::defaultCurrency();

// USD

`Number::defaultLocale()`

Number::defaultLocaleメソッドは、Numberクラスが使用しているデフォルトのロケールを返します。

1use Illuminate\Support\Number;
2 
3$locale = Number::defaultLocale();
4 
5// en

use Illuminate\Support\Number;

$locale = Number::defaultLocale();

// en

`Number::fileSize()`

Number::fileSizeメソッドは、指定したバイト値のファイルサイズ表現を文字列として返します。

 1use Illuminate\Support\Number;
 2 
 3$size = Number::fileSize(1024);
 4 
 5// 1 KB
 6 
 7$size = Number::fileSize(1024 * 1024);
 8 
 9// 1 MB
10 
11$size = Number::fileSize(1024, precision: 2);
12 
13// 1.00 KB

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メソッドは、指定した数値を人間が読める形式で返します。

 1use Illuminate\Support\Number;
 2 
 3$number = Number::forHumans(1000);
 4 
 5// 1 thousand
 6 
 7$number = Number::forHumans(489939);
 8 
 9// 490 thousand
10 
11$number = Number::forHumans(1230000, precision: 2);
12 
13// 1.23 million

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メソッドは、指定した数値をロケール固有の文字列にフォーマットします。

 1use Illuminate\Support\Number;
 2 
 3$number = Number::format(100000);
 4 
 5// 100,000
 6 
 7$number = Number::format(100000, precision: 2);
 8 
 9// 100,000.00
10 
11$number = Number::format(100000.123, maxPrecision: 2);
12 
13// 100,000.12
14 
15$number = Number::format(100000, locale: 'de');
16 
17// 100.000

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メソッドは、数値の序数表現を返します。

 1use Illuminate\Support\Number;
 2 
 3$number = Number::ordinal(1);
 4 
 5// 1st
 6 
 7$number = Number::ordinal(2);
 8 
 9// 2nd
10 
11$number = Number::ordinal(21);
12 
13// 21st

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::pairs()`

Number::pairsメソッドは、指定した範囲とステップ値に基づいて、数値ペア（サブ範囲）の配列を生成します。このメソッドは、ページネーションやバッチ処理などのために、より大きな数値範囲をより小さく管理しやすいサブ範囲に分割するのに役立ちます。pairsメソッドは配列の配列を返し、各内部配列は数値のペア（サブ範囲）を表します。

1use Illuminate\Support\Number;
2 
3$result = Number::pairs(25, 10);
4 
5// [[1, 10], [11, 20], [21, 25]]
6 
7$result = Number::pairs(25, 10, offset: 0);
8 
9// [[0, 10], [10, 20], [20, 25]]

use Illuminate\Support\Number;

$result = Number::pairs(25, 10);

// [[1, 10], [11, 20], [21, 25]]

$result = Number::pairs(25, 10, offset: 0);

// [[0, 10], [10, 20], [20, 25]]

`Number::percentage()`

Number::percentageメソッドは、指定した値のパーセンテージ表現を文字列として返します。

 1use Illuminate\Support\Number;
 2 
 3$percentage = Number::percentage(10);
 4 
 5// 10%
 6 
 7$percentage = Number::percentage(10, precision: 2);
 8 
 9// 10.00%
10 
11$percentage = Number::percentage(10.123, maxPrecision: 2);
12 
13// 10.12%
14 
15$percentage = Number::percentage(10, precision: 2, locale: 'de');
16 
17// 10,00%

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メソッドは、指定した数値を単語の文字列に変換します。

1use Illuminate\Support\Number;
2 
3$number = Number::spell(102);
4 
5// one hundred and two
6 
7$number = Number::spell(88, locale: 'fr');
8 
9// quatre-vingt-huit

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

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

// quatre-vingt-huit

after引数を使用すると、それ以降のすべての数値をスペルアウトする値を指定できます。

1$number = Number::spell(10, after: 10);
2 
3// 10
4 
5$number = Number::spell(11, after: 10);
6 
7// eleven

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

// 10

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

// eleven

until引数を使用すると、それ以前のすべての数値をスペルアウトする値を指定できます。

1$number = Number::spell(5, until: 10);
2 
3// five
4 
5$number = Number::spell(10, until: 10);
6 
7// 10

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

// five

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

// 10

`Number::trim()`

Number::trimメソッドは、指定した数値の小数点以下の末尾のゼロを削除します。

1use Illuminate\Support\Number;
2 
3$number = Number::trim(12.0);
4 
5// 12
6 
7$number = Number::trim(12.30);
8 
9// 12.3

use Illuminate\Support\Number;

$number = Number::trim(12.0);

// 12

$number = Number::trim(12.30);

// 12.3

`Number::useLocale()`

Number::useLocaleメソッドは、デフォルトの数値ロケールをグローバルに設定します。これは、後続のNumberクラスのメソッド呼び出しによる数値と通貨のフォーマットに影響します。

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Number::useLocale('de');
9}

use Illuminate\Support\Number;

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

`Number::withLocale()`

Number::withLocaleメソッドは、指定したロケールを使用して指定したクロージャを実行し、コールバックの実行後に元のロケールを復元します。

1use Illuminate\Support\Number;
2 
3$number = Number::withLocale('de', function () {
4    return Number::format(1500);
5});

use Illuminate\Support\Number;

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

`Number::useCurrency()`

Number::useCurrencyメソッドは、デフォルトの数値通貨をグローバルに設定します。これは、後続のNumberクラスのメソッド呼び出しによる通貨のフォーマットに影響します。

1use Illuminate\Support\Number;
2 
3/**
4 * Bootstrap any application services.
5 */
6public function boot(): void
7{
8    Number::useCurrency('GBP');
9}

use Illuminate\Support\Number;

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

`Number::withCurrency()`

Number::withCurrencyメソッドは、指定した通貨を使用して指定したクロージャを実行し、コールバックの実行後に元の通貨を復元します。

1use Illuminate\Support\Number;
2 
3$number = Number::withCurrency('GBP', function () {
4    // ...
5});

use Illuminate\Support\Number;

$number = Number::withCurrency('GBP', function () {
    // ...
});

パス

`app_path()`

app_path関数は、アプリケーションのappディレクトリへの完全修飾パスを返します。app_path関数を使用して、アプリケーションディレクトリからの相対パスでファイルへの完全修飾パスを生成することもできます。

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

$path = app_path();

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

`base_path()`

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

1$path = base_path();
2 
3$path = base_path('vendor/bin');

$path = base_path();

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

`config_path()`

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

1$path = config_path();
2 
3$path = config_path('app.php');

$path = config_path();

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

`database_path()`

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

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

$path = database_path();

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

`lang_path()`

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

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

$path = lang_path();

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

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

`mix()`

mix関数は、バージョニングされたMixファイルへのパスを返します。

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

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

`public_path()`

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

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

$path = public_path();

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

`resource_path()`

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

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

$path = resource_path();

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

`storage_path()`

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

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

$path = storage_path();

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

URL

`action()`

action関数は、指定したコントローラアクションのURLを生成します。

1use App\Http\Controllers\HomeController;
2 
3$url = action([HomeController::class, 'index']);

use App\Http\Controllers\HomeController;

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

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

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

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

`asset()`

asset関数は、リクエストの現在のスキーム（HTTPまたはHTTPS）を使用してアセットのURLを生成します。

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

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

.envファイルでASSET_URL変数を設定することで、アセットURLホストを設定できます。これは、Amazon S3や他のCDNなどの外部サービスでアセットをホストする場合に便利です。

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

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

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

`route()`

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

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

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

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

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

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

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

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

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

`secure_asset()`

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

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

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

`secure_url()`

secure_url関数は、指定したパスへの完全修飾HTTPS URLを生成します。追加のURLセグメントは、関数の２番目の引数で渡すことができます。

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

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

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

`to_route()`

to_route関数は、指定した名前付きルートへのリダイレクトHTTPレスポンスを生成します。

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

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

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

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

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

`url()`

url関数は、指定したパスへの完全修飾URLを生成します。

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

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

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

パスが指定されていない場合、Illuminate\Routing\UrlGeneratorインスタンスが返されます。

1$current = url()->current();
2 
3$full = url()->full();
4 
5$previous = url()->previous();

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

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

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

その他

`abort()`

abort関数は、HTTP例外をスローし、例外ハンドラによってレンダリングされます。

1abort(403);

abort(403);

例外のメッセージと、ブラウザに送信するカスタムHTTPレスポンスヘッダを指定することもできます。

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

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

`abort_if()`

abort_if関数は、指定した論理式がtrueと評価された場合にHTTP例外をスローします。

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

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

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

`abort_unless()`

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

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

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

`app()`

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

1$container = app();

$container = app();

クラス名またはインターフェイス名を渡して、コンテナからそれを依存解決できます。

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

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

`auth()`

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

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

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

必要であれば、どのガードインスタンスにアクセスしたいかを指定できます。

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

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

`back()`

back関数は、ユーザーの前の場所へのリダイレクトHTTPレスポンスを生成します。

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

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

return back();

`bcrypt()`

bcrypt関数は、Bcryptを使用して指定した値をハッシュ化します。この関数は、Hashファサードの代わりとして使用できます。

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

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

`broadcast()`

broadcast関数は、指定したイベントをそのリスナにブロードキャストします。

1broadcast(new UserRegistered($user));
2 
3broadcast(new UserRegistered($user))->toOthers();

broadcast(new UserRegistered($user));

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

`cache()`

cache関数は、キャッシュから値を取得するために使用します。指定したキーがキャッシュに存在しない場合、オプションのデフォルト値が返されます。

1$value = cache('key');
2 
3$value = cache('key', 'default');

$value = cache('key');

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

関数にキー／値ペアの配列を渡すことで、キャッシュにアイテムを追加できます。キャッシュされた値が有効であるべき秒数または期間も渡す必要があります。

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

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

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

`class_uses_recursive()`

class_uses_recursive関数は、クラスが使用するすべてのトレイトを返します。これには、そのすべての親クラスが使用するトレイトも含まれます。

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

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

`collect()`

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

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

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

`config()`

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

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

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

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

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

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

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

`context()`

context関数は、現在のコンテキストから値を取得します。デフォルト値を指定でき、コンテキストキーが存在しない場合はその値が返されます。

1$value = context('trace_id');
2 
3$value = context('trace_id', $default);

$value = context('trace_id');

$value = context('trace_id', $default);

キーと値のペアの配列を渡すことで、コンテキスト値を設定できます。

1use Illuminate\Support\Str;
2 
3context(['trace_id' => Str::uuid()->toString()]);

use Illuminate\Support\Str;

context(['trace_id' => Str::uuid()->toString()]);

cookie関数は、新しいcookieインスタンスを作成します。

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

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

`csrf_field()`

csrf_field関数は、CSRFトークンの値を含むHTMLのhidden入力フィールドを生成します。たとえば、Blade構文を使用します。

1{{ csrf_field() }}

{{ csrf_field() }}

`csrf_token()`

csrf_token関数は、現在のCSRFトークンの値を取得します。

1$token = csrf_token();

$token = csrf_token();

`decrypt()`

decrypt関数は、指定した値を復号します。この関数は、Cryptファサードの代わりとして使用できます。

1$password = decrypt($value);

$password = decrypt($value);

`dd()`

dd関数は、指定した変数をダンプし、スクリプトの実行を終了します。

1dd($value);
2 
3dd($value1, $value2, $value3, ...);

dd($value);

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

スクリプトの実行を停止したくない場合は、代わりにdump関数を使用してください。

`dispatch()`

dispatch関数は、指定したジョブをLaravelのジョブキューにプッシュします。

1dispatch(new App\Jobs\SendEmails);

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

dispatch_sync関数は、指定したジョブをsyncキューにプッシュし、すぐに処理されるようにします。

1dispatch_sync(new App\Jobs\SendEmails);

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

dump関数は、指定した変数をダンプします。

1dump($value);
2 
3dump($value1, $value2, $value3, ...);

dump($value);

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

変数をダンプした後にスクリプトの実行を停止したい場合は、代わりにdd関数を使用してください。

`encrypt()`

encrypt関数は、指定した値を暗号化します。この関数は、Cryptファサードの代わりとして使用できます。

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

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

`env()`

env関数は、環境変数の値を取得するか、デフォルト値を返します。

1$env = env('APP_ENV');
2 
3$env = env('APP_ENV', 'production');

$env = env('APP_ENV');

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

デプロイプロセス中にconfig:cacheコマンドを実行する場合は、設定ファイル内からのみenv関数を呼び出すようにしてください。設定がキャッシュされると、.envファイルはロードされなくなり、env関数へのすべての呼び出しはnullを返します。

`event()`

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

1event(new UserRegistered($user));

event(new UserRegistered($user));

`fake()`

fake関数は、コンテナからFakerシングルトンを解決します。これは、モデルファクトリ、データベースシーディング、テスト、プロトタイピングビューで偽のデータを作成するのに役立ちます。

1@for($i = 0; $i < 10; $i++)
2    <dl>
3        <dt>Name</dt>
4        <dd>{{ fake()->name() }}</dd>
5 
6        <dt>Email</dt>
7        <dd>{{ fake()->unique()->safeEmail() }}</dd>
8    </dl>
9@endfor

@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設定オプションを利用します。通常、この設定オプションはAPP_FAKER_LOCALE環境変数によって設定されます。fake関数にロケールを渡して指定することもできます。各ロケールは個別のシングルトンを解決します。

1fake('nl_NL')->name()

fake('nl_NL')->name()

`info()`

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

1info('Some helpful information!');

info('Some helpful information!');

コンテキストデータの配列を関数に渡すこともできます。

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

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

`literal()`

literal関数は、指定した名前付き引数をプロパティとして持つ新しいstdClassインスタンスを作成します。

1$obj = literal(
2    name: 'Joe',
3    languages: ['PHP', 'Ruby'],
4);
5 
6$obj->name; // 'Joe'
7$obj->languages; // ['PHP', 'Ruby']

$obj = literal(
    name: 'Joe',
    languages: ['PHP', 'Ruby'],
);

$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']

`logger()`

logger関数は、debugレベルのメッセージをログに書き込むために使用できます。

1logger('Debug message');

logger('Debug message');

コンテキストデータの配列を関数に渡すこともできます。

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

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

関数に値が渡されない場合、loggerインスタンスが返されます。

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

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

`method_field()`

method_field関数は、フォームのHTTP動詞の偽装値を含むHTMLのhidden入力フィールドを生成します。たとえば、Blade構文を使用します。

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

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

`now()`

now関数は、現在時刻の新しいIlluminate\Support\Carbonインスタンスを作成します。

1$now = now();

$now = now();

`old()`

old関数は、セッションにフラッシュされた古い入力値を取得します。

1$value = old('value');
2 
3$value = old('value', 'default');

$value = old('value');

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

old関数の２番目の引数として提供される「デフォルト値」は、多くの場合Eloquentモデルの属性であるため、LaravelではEloquentモデル全体をold関数の２番目の引数として渡すことができます。そうすることで、Laravelはold関数に提供される最初の引数を、「デフォルト値」と見なすべきEloquent属性の名前であると見なします。

1{{ old('name', $user->name) }}
2 
3// Is equivalent to...
4 
5{{ old('name', $user) }}

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

// Is equivalent to...

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

`once()`

once関数は、指定したコールバックを実行し、その結果をリクエストの間メモリにキャッシュします。同じコールバックを持つonce関数への後続の呼び出しは、以前にキャッシュされた結果を返します。

 1function random(): int
 2{
 3    return once(function () {
 4        return random_int(1, 1000);
 5    });
 6}
 7 
 8random(); // 123
 9random(); // 123 (cached result)
10random(); // 123 (cached result)

function random(): int
{
    return once(function () {
        return random_int(1, 1000);
    });
}

random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)

once関数がオブジェクトインスタンス内から実行されると、キャッシュされた結果はそのオブジェクトインスタンスに固有のものになります。

 1<?php
 2 
 3class NumberService
 4{
 5    public function all(): array
 6    {
 7        return once(fn () => [1, 2, 3]);
 8    }
 9}
10 
11$service = new NumberService;
12 
13$service->all();
14$service->all(); // (cached result)
15 
16$secondService = new NumberService;
17 
18$secondService->all();
19$secondService->all(); // (cached result)

<?php

class NumberService
{
    public function all(): array
    {
        return once(fn () => [1, 2, 3]);
    }
}

$service = new NumberService;

$service->all();
$service->all(); // (cached result)

$secondService = new NumberService;

$secondService->all();
$secondService->all(); // (cached result)

`optional()`

optional関数は任意の引数を受け入れ、そのオブジェクトのプロパティにアクセスしたり、メソッドを呼び出したりできます。指定したオブジェクトがnullの場合、プロパティとメソッドはエラーを引き起こす代わりにnullを返します。

1return optional($user->address)->street;
2 
3{!! old('name', optional($user)->name) !!}

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

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

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

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

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

`policy()`

policyメソッドは、指定したクラスのポリシーインスタンスを取得します。

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

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

`redirect()`

redirect関数は、リダイレクトHTTPレスポンスを返すか、引数なしで呼び出された場合はリダイレクタインスタンスを返します。

1return redirect($to = null, $status = 302, $headers = [], $https = null);
2 
3return redirect('/home');
4 
5return redirect()->route('route.name');

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

return redirect('/home');

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

`report()`

report関数は、例外ハンドラを使用して例外を報告します。

1report($e);

report($e);

report関数は、引数として文字列も受け入れます。文字列が関数に渡されると、関数は指定した文字列をメッセージとして持つ例外を作成します。

1report('Something went wrong.');

report('Something went wrong.');

`report_if()`

report_if関数は、指定した条件がtrueの場合に、例外ハンドラを使用して例外を報告します。

1report_if($shouldReport, $e);
2 
3report_if($shouldReport, 'Something went wrong.');

report_if($shouldReport, $e);

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

`report_unless()`

report_unless関数は、指定した条件がfalseの場合に、例外ハンドラを使用して例外を報告します。

1report_unless($reportingDisabled, $e);
2 
3report_unless($reportingDisabled, 'Something went wrong.');

report_unless($reportingDisabled, $e);

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

`request()`

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

1$request = request();
2 
3$value = request('key', $default);

$request = request();

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

`rescue()`

rescue関数は、指定したクロージャを実行し、その実行中に発生した例外をキャッチします。キャッチされたすべての例外は例外ハンドラに送信されますが、リクエストは処理を続行します。

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

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

rescue関数に２番目の引数を渡すこともできます。この引数は、クロージャの実行中に例外が発生した場合に返される「デフォルト」値になります。

1return rescue(function () {
2    return $this->method();
3}, false);
4 
5return rescue(function () {
6    return $this->method();
7}, function () {
8    return $this->failure();
9});

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

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

rescue関数にreport引数を指定して、例外をreport関数で報告すべきかどうかを判断できます。

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

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

`resolve()`

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

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

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

`response()`

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

1return response('Hello World', 200, $headers);
2 
3return response()->json(['foo' => 'bar'], 200, $headers);

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

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

`retry()`

retry関数は、指定した最大試行回数のしきい値に達するまで、指定したコールバックの実行を試みます。コールバックが例外をスローしない場合、その戻り値が返されます。コールバックが例外をスローした場合、自動的に再試行されます。最大試行回数を超えた場合、例外がスローされます。

1return retry(5, function () {
2    // Attempt 5 times while resting 100ms between attempts...
3}, 100);

return retry(5, function () {
    // Attempt 5 times while resting 100ms between attempts...
}, 100);

試行の間にスリープするミリ秒数を手動で計算したい場合は、retry関数の３番目の引数としてクロージャを渡すことができます。

1use Exception;
2 
3return retry(5, function () {
4    // ...
5}, function (int $attempt, Exception $exception) {
6    return $attempt * 100;
7});

use Exception;

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

便宜上、retry関数の最初の引数として配列を指定できます。この配列は、後続の試行の間にスリープするミリ秒数を決定するために使用されます。

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

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

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

1use Exception;
2 
3return retry(5, function () {
4    // ...
5}, 100, function (Exception $exception) {
6    return $exception instanceof RetryException;
7});

use Exception;

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

`session()`

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

1$value = session('key');

$value = session('key');

キー／値ペアの配列を関数に渡すことで値を設定できます。

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

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

関数に値が渡されない場合、セッションストアが返されます。

1$value = session()->get('key');
2 
3session()->put('key', $value);

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

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

`tap()`

tap関数は、任意の$valueとクロージャの２つの引数を受け入れます。$valueはクロージャに渡され、その後tap関数によって返されます。クロージャの戻り値は無関係です。

1$user = tap(User::first(), function (User $user) {
2    $user->name = 'taylor';
3 
4    $user->save();
5});

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

    $user->save();
});

tap関数にクロージャが渡されない場合、指定した$valueで任意のメソッドを呼び出すことができます。呼び出すメソッドの戻り値は、そのメソッドが実際に定義で何を返すかに関係なく、常に$valueになります。たとえば、Eloquentのupdateメソッドは通常整数を返します。しかし、updateメソッドの呼び出しをtap関数を介してチェーンすることで、メソッドにモデル自体を強制的に返させることができます。

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

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

クラスにtapメソッドを追加するには、Illuminate\Support\Traits\Tappableトレイトをクラスに追加します。このトレイトのtapメソッドは、クロージャを唯一の引数として受け入れます。オブジェクトインスタンス自体がクロージャに渡され、その後tapメソッドによって返されます。

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

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

`throw_if()`

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

1throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
2 
3throw_if(
4    ! Auth::user()->isAdmin(),
5    AuthorizationException::class,
6    'You are not allowed to access this page.'
7);

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と評価された場合に、指定した例外をスローします。

1throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
2 
3throw_unless(
4    Auth::user()->isAdmin(),
5    AuthorizationException::class,
6    'You are not allowed to access this page.'
7);

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インスタンスを作成します。

1$today = today();

$today = today();

`trait_uses_recursive()`

trait_uses_recursive関数は、トレイトが使用するすべてのトレイトを返します。

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

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

`transform()`

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

1$callback = function (int $value) {
2    return $value * 2;
3};
4 
5$result = transform(5, $callback);
6 
7// 10

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

$result = transform(5, $callback);

// 10

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

1$result = transform(null, $callback, 'The value is blank');
2 
3// The value is blank

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

// The value is blank

`validator()`

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

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

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

`value()`

value関数は、渡された値を返します。ただし、関数にクロージャを渡すと、クロージャが実行され、その戻り値が返されます。

1$result = value(true);
2 
3// true
4 
5$result = value(function () {
6    return false;
7});
8 
9// false

$result = value(true);

// true

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

// false

value関数には追加の引数を渡すことができます。最初の引数がクロージャの場合、追加のパラメータはクロージャに引数として渡されます。それ以外の場合は無視されます。

1$result = value(function (string $name) {
2    return $name;
3}, 'Taylor');
4 
5// 'Taylor'

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

// 'Taylor'

`view()`

view関数は、ビューインスタンスを取得します。

1return view('auth.login');

return view('auth.login');

`with()`

with関数は、渡された値を返します。関数の２番目の引数としてクロージャが渡された場合、クロージャが実行され、その戻り値が返されます。

 1$callback = function (mixed $value) {
 2    return is_numeric($value) ? $value * 2 : 0;
 3};
 4 
 5$result = with(5, $callback);
 6 
 7// 10
 8 
 9$result = with(null, $callback);
10 
11// 0
12 
13$result = with(5, null);
14 
15// 5

$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

`when()`

when関数は、指定された条件がtrueと評価された場合に、与えられた値を返します。それ以外の場合はnullが返されます。関数の2番目の引数としてクロージャが渡された場合は、クロージャが実行され、その戻り値が返されます。

1$value = when(true, 'Hello World');
2 
3$value = when(true, fn () => 'Hello World');

$value = when(true, 'Hello World');

$value = when(true, fn () => 'Hello World');

when関数は、主にHTML属性を条件付きでレンダリングするのに役立ちます。

1<div {!! when($condition, 'wire:poll="calculate"') !!}>
2    ...
3</div>

<div {!! when($condition, 'wire:poll="calculate"') !!}>
    ...
</div>

その他のユーティリティ

ベンチマーキング

アプリケーションの特定の部分のパフォーマンスを素早くテストしたい場合があります。そのような場合、Benchmarkサポートクラスを利用して、指定したコールバックの完了にかかるミリ秒数を測定できます。

 1<?php
 2 
 3use App\Models\User;
 4use Illuminate\Support\Benchmark;
 5 
 6Benchmark::dd(fn () => User::find(1)); // 0.1 ms
 7 
 8Benchmark::dd([
 9    'Scenario 1' => fn () => User::count(), // 0.5 ms
10    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
11]);

<?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クラスはすべてのイテレーションにわたるコールバックの実行にかかった平均ミリ秒数を返します。

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

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

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

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

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

日付

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

1$now = now();

$now = now();

または、Illuminate\Support\Carbonクラスを使用して新しいCarbonインスタンスを作成することもできます。

1use Illuminate\Support\Carbon;
2 
3$now = Carbon::now();

use Illuminate\Support\Carbon;

$now = Carbon::now();

Carbonとその機能についての詳細な説明については、公式のCarbonドキュメントを参照してください。

遅延関数

遅延関数は現在、コミュニティからのフィードバックを収集している間ベータ版です。

Laravelのキュー投入済みジョブを使用すると、バックグラウンド処理のためにタスクをキューに入れることができますが、長時間実行されるキューワーカーを設定または維持することなく、遅延させたい単純なタスクがある場合があります。

遅延関数を使用すると、ユーザーにHTTPレスポンスが送信された後までクロージャの実行を遅らせることができ、アプリケーションの感覚を高速で応答性の高いものに保ちます。クロージャの実行を遅らせるには、単にクロージャをIlluminate\Support\defer関数に渡します。

 1use App\Services\Metrics;
 2use Illuminate\Http\Request;
 3use Illuminate\Support\Facades\Route;
 4use function Illuminate\Support\defer;
 5 
 6Route::post('/orders', function (Request $request) {
 7    // Create order...
 8 
 9    defer(fn () => Metrics::reportOrder($order));
10 
11    return $order;
12});

use App\Services\Metrics;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use function Illuminate\Support\defer;

Route::post('/orders', function (Request $request) {
    // Create order...

    defer(fn () => Metrics::reportOrder($order));

    return $order;
});

デフォルトでは、Illuminate\Support\deferが呼び出されたHTTPレスポンス、Artisanコマンド、またはキュー投入済みジョブが正常に完了した場合にのみ、遅延関数が実行されます。これは、リクエストが4xxまたは5xxのHTTPレスポンスになった場合、遅延関数は実行されないことを意味します。遅延関数を常に実行したい場合は、遅延関数にalwaysメソッドをチェーンできます。

1defer(fn () => Metrics::reportOrder($order))->always();

defer(fn () => Metrics::reportOrder($order))->always();

遅延関数のキャンセル

遅延関数を実行前にキャンセルする必要がある場合は、forgetメソッドを使用してその名前で関数をキャンセルできます。遅延関数に名前を付けるには、Illuminate\Support\defer関数の２番目の引数を指定します。

1defer(fn () => Metrics::report(), 'reportMetrics');
2 
3defer()->forget('reportMetrics');

defer(fn () => Metrics::report(), 'reportMetrics');

defer()->forget('reportMetrics');

遅延関数の互換性

Laravel 10.xアプリケーションからLaravel 11.xにアップグレードし、アプリケーションのスケルトンにまだapp/Http/Kernel.phpファイルが含まれている場合は、カーネルの$middlewareプロパティの先頭にInvokeDeferredCallbacksミドルウェアを追加する必要があります。

1protected $middleware = [
2    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class, 
3    \App\Http\Middleware\TrustProxies::class,
4    // ...
5];

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\InvokeDeferredCallbacks::class,
    \App\Http\Middleware\TrustProxies::class,
    // ...
];

テストでの遅延関数の無効化

テストを作成する際、遅延関数を無効にすると便利な場合があります。テストでwithoutDeferを呼び出すことで、Laravelにすべての遅延関数をすぐに呼び出すよう指示できます。

1test('without defer', function () {
2    $this->withoutDefer();
3 
4    // ...
5});

test('without defer', function () {
    $this->withoutDefer();

    // ...
});

 1use Tests\TestCase;
 2 
 3class ExampleTest extends TestCase
 4{
 5    public function test_without_defer(): void
 6    {
 7        $this->withoutDefer();
 8 
 9        // ...
10    }
11}

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_without_defer(): void
    {
        $this->withoutDefer();

        // ...
    }
}

テストケース内のすべてのテストで遅延関数を無効にしたい場合は、基本のTestCaseクラスのsetUpメソッドからwithoutDeferメソッドを呼び出すことができます。

 1<?php
 2 
 3namespace Tests;
 4 
 5use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
 6 
 7abstract class TestCase extends BaseTestCase
 8{
 9    protected function setUp(): void
10    {
11        parent::setUp();
12 
13        $this->withoutDefer();
14    }
15}

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        $this->withoutDefer();
    }
}

ロッテリー

Laravelのロッテリー（くじ引き）クラスを使用して、指定した一連の確率に基づいてコールバックを実行できます。これは、受信リクエストのパーセンテージに対してのみコードを実行したい場合に特に役立ちます。

1use Illuminate\Support\Lottery;
2 
3Lottery::odds(1, 20)
4    ->winner(fn () => $user->won())
5    ->loser(fn () => $user->lost())
6    ->choose();

use Illuminate\Support\Lottery;

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

Laravelのロッテリークラスを他のLaravel機能と組み合わせることができます。たとえば、遅いクエリのわずかな割合だけを例外ハンドラに報告したい場合があります。そして、ロッテリークラスは呼び出し可能であるため、呼び出し可能オブジェクトを受け入れる任意のメソッドにクラスのインスタンスを渡すことができます。

1use Carbon\CarbonInterval;
2use Illuminate\Support\Facades\DB;
3use Illuminate\Support\Lottery;
4 
5DB::whenQueryingForLongerThan(
6    CarbonInterval::seconds(2),
7    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
8);

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は、アプリケーションのロッテリー呼び出しを簡単にテストできるように、いくつかの簡単なメソッドを提供しています。

 1// Lottery will always win...
 2Lottery::alwaysWin();
 3 
 4// Lottery will always lose...
 5Lottery::alwaysLose();
 6 
 7// Lottery will win then lose, and finally return to normal behavior...
 8Lottery::fix([true, false]);
 9 
10// Lottery will return to normal behavior...
11Lottery::determineResultsNormally();

// Lottery will always win...
Lottery::alwaysWin();

// Lottery will always lose...
Lottery::alwaysLose();

// Lottery will win then lose, and finally return to normal behavior...
Lottery::fix([true, false]);

// Lottery will return to normal behavior...
Lottery::determineResultsNormally();

パイプライン

LaravelのPipelineファサードは、指定した入力を一連の呼び出し可能なクラス、クロージャ、または呼び出し可能オブジェクトを通じて「パイプ」する便利な方法を提供します。各クラスは、入力を検査または変更し、パイプラインの次の呼び出し可能オブジェクトを呼び出す機会を得ます。

 1use Closure;
 2use App\Models\User;
 3use Illuminate\Support\Facades\Pipeline;
 4 
 5$user = Pipeline::send($user)
 6    ->through([
 7        function (User $user, Closure $next) {
 8            // ...
 9 
10            return $next($user);
11        },
12        function (User $user, Closure $next) {
13            // ...
14 
15            return $next($user);
16        },
17    ])
18    ->then(fn (User $user) => $user);

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

パイプラインの最後の呼び出し可能オブジェクトが$nextクロージャを呼び出すと、thenメソッドに提供された呼び出し可能オブジェクトが呼び出されます。通常、この呼び出し可能オブジェクトは単に指定された入力を返します。

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

1$user = Pipeline::send($user)
2    ->through([
3        GenerateProfilePhoto::class,
4        ActivateSubscription::class,
5        SendWelcomeEmail::class,
6    ])
7    ->then(fn (User $user) => $user);

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

Sleep

LaravelのSleepクラスは、PHPのネイティブなsleepおよびusleep関数の軽量ラッパーであり、テストの容易性を高めると同時に、時間に関する作業のための開発者に優しいAPIを公開しています。

1use Illuminate\Support\Sleep;
2 
3$waiting = true;
4 
5while ($waiting) {
6    Sleep::for(1)->second();
7 
8    $waiting = /* ... */;
9}

use Illuminate\Support\Sleep;

$waiting = true;

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

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

Sleepクラスは、さまざまな時間単位で作業できるさまざまなメソッドを提供します。

 1// Return a value after sleeping...
 2$result = Sleep::for(1)->second()->then(fn () => 1 + 1);
 3 
 4// Sleep while a given value is true...
 5Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());
 6 
 7// Pause execution for 90 seconds...
 8Sleep::for(1.5)->minutes();
 9 
10// Pause execution for 2 seconds...
11Sleep::for(2)->seconds();
12 
13// Pause execution for 500 milliseconds...
14Sleep::for(500)->milliseconds();
15 
16// Pause execution for 5,000 microseconds...
17Sleep::for(5000)->microseconds();
18 
19// Pause execution until a given time...
20Sleep::until(now()->addMinute());
21 
22// Alias of PHP's native "sleep" function...
23Sleep::sleep(2);
24 
25// Alias of PHP's native "usleep" function...
26Sleep::usleep(5000);

// Return a value after sleeping...
$result = Sleep::for(1)->second()->then(fn () => 1 + 1);

// Sleep while a given value is true...
Sleep::for(1)->second()->while(fn () => shouldKeepSleeping());

// Pause execution for 90 seconds...
Sleep::for(1.5)->minutes();

// Pause execution for 2 seconds...
Sleep::for(2)->seconds();

// Pause execution for 500 milliseconds...
Sleep::for(500)->milliseconds();

// Pause execution for 5,000 microseconds...
Sleep::for(5000)->microseconds();

// Pause execution until a given time...
Sleep::until(now()->addMinute());

// Alias of PHP's native "sleep" function...
Sleep::sleep(2);

// Alias of PHP's native "usleep" function...
Sleep::usleep(5000);

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

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

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

Sleepのテスト

SleepクラスまたはPHPのネイティブなスリープ関数を利用するコードをテストする場合、テストは実行を一時停止します。ご想像のとおり、これによりテストスイートが大幅に遅くなります。たとえば、次のコードをテストしていると想像してください。

1$waiting = /* ... */;
2 
3$seconds = 1;
4 
5while ($waiting) {
6    Sleep::for($seconds++)->seconds();
7 
8    $waiting = /* ... */;
9}

$waiting = /* ... */;

$seconds = 1;

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

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

通常、このコードのテストには*少なくとも*1秒かかります。幸いなことに、Sleepクラスを使用すると、スリープを「偽装」して、テストスイートを高速に保つことができます。

1it('waits until ready', function () {
2    Sleep::fake();
3 
4    // ...
5});

it('waits until ready', function () {
    Sleep::fake();

    // ...
});

1public function test_it_waits_until_ready()
2{
3    Sleep::fake();
4 
5    // ...
6}

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

    // ...
}

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

Sleepクラスが偽装されると、発生すべきだったと期待される「スリープ」に対してアサーションを行うことが可能になります。これを説明するために、実行を３回一時停止し、各一時停止が１秒ずつ増加するコードをテストしていると想像してみましょう。assertSequenceメソッドを使用すると、テストを高速に保ちながら、コードが適切な時間「スリープ」したことをアサートできます。

 1it('checks if ready three times', function () {
 2    Sleep::fake();
 3 
 4    // ...
 5 
 6    Sleep::assertSequence([
 7        Sleep::for(1)->second(),
 8        Sleep::for(2)->seconds(),
 9        Sleep::for(3)->seconds(),
10    ]);
11}

it('checks if ready three times', function () {
    Sleep::fake();

    // ...

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

 1public function test_it_checks_if_ready_three_times()
 2{
 3    Sleep::fake();
 4 
 5    // ...
 6 
 7    Sleep::assertSequence([
 8        Sleep::for(1)->second(),
 9        Sleep::for(2)->seconds(),
10        Sleep::for(3)->seconds(),
11    ]);
12}

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

    // ...

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

もちろん、Sleepクラスは、テスト時に使用できる他のさまざまなアサーションを提供します。

 1use Carbon\CarbonInterval as Duration;
 2use Illuminate\Support\Sleep;
 3 
 4// Assert that sleep was called 3 times...
 5Sleep::assertSleptTimes(3);
 6 
 7// Assert against the duration of sleep...
 8Sleep::assertSlept(function (Duration $duration): bool {
 9    return /* ... */;
10}, times: 1);
11 
12// Assert that the Sleep class was never invoked...
13Sleep::assertNeverSlept();
14 
15// Assert that, even if Sleep was called, no execution paused occurred...
16Sleep::assertInsomniac();

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

// Assert that sleep was called 3 times...
Sleep::assertSleptTimes(3);

// Assert against the duration of sleep...
Sleep::assertSlept(function (Duration $duration): bool {
    return /* ... */;
}, times: 1);

// Assert that the Sleep class was never invoked...
Sleep::assertNeverSlept();

// Assert that, even if Sleep was called, no execution paused occurred...
Sleep::assertInsomniac();

アプリケーションコードで偽のスリープが発生するたびにアクションを実行すると便利な場合があります。これを実現するには、whenFakingSleepメソッドにコールバックを提供します。次の例では、Laravelの時間操作ヘルパを使用して、各スリープの期間だけ時間を即座に進めます。

 1use Carbon\CarbonInterval as Duration;
 2 
 3$this->freezeTime();
 4 
 5Sleep::fake();
 6 
 7Sleep::whenFakingSleep(function (Duration $duration) {
 8    // Progress time when faking sleep...
 9    $this->travel($duration->totalMilliseconds)->milliseconds();
10});

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

Sleep::whenFakingSleep(function (Duration $duration) {
    // Progress time when faking sleep...
    $this->travel($duration->totalMilliseconds)->milliseconds();
});

時間を進めることは一般的な要件であるため、fakeメソッドはsyncWithCarbon引数を受け入れ、テスト内でスリープする際にCarbonを同期させます。

1Sleep::fake(syncWithCarbon: true);
2 
3$start = now();
4 
5Sleep::for(1)->second();
6 
7$start->diffForHumans(); // 1 second ago

Sleep::fake(syncWithCarbon: true);

$start = now();

Sleep::for(1)->second();

$start->diffForHumans(); // 1 second ago

Laravelは、実行を一時停止する際には常に内部的にSleepクラスを使用します。たとえば、retryヘルパはスリープ時にSleepクラスを使用し、そのヘルパを使用する際のテスト容易性を向上させます。

Timebox

LaravelのTimeboxクラスは、指定されたコールバックが実際の実行が早く完了した場合でも、常に一定の時間で実行されることを保証します。これは、攻撃者が実行時間の変動を利用して機密情報を推測する可能性がある暗号操作やユーザー認証チェックに特に役立ちます。

実行が固定期間を超えた場合、Timeboxは効果がありません。最悪のシナリオを考慮して、固定期間として十分に長い時間を選択するのは開発者の責任です。

callメソッドは、クロージャとマイクロ秒単位の制限時間を受け入れ、クロージャを実行し、制限時間に達するまで待機します。

1use Illuminate\Support\Timebox;
2 
3(new Timebox)->call(function ($timebox) {
4    // ...
5}, microseconds: 10000);

use Illuminate\Support\Timebox;

(new Timebox)->call(function ($timebox) {
    // ...
}, microseconds: 10000);

クロージャ内で例外がスローされた場合、このクラスは定義された遅延を尊重し、遅延後に例外を再スローします。

序文

はじめに

アーキテクチャのコンセプト

基本

より深く知る

セキュリティ

データベース

Eloquent ORM

テスト

パッケージ

ヘルパ