Helpers
Table of Contents
Introduction
Laravel "は、さまざまなグローバルヘルパー"PHP 関数を含んでいます。これらの関数の多くはフレームワーク自体で使用されていますが、便利だと思われる場合には自由にそれらを自分のアプリケーションで使用することができます。
Available Methods
配列とオブジェクト
Arr::accessible Arr::add Arr::collapse Arr::crossJoin Arr::divide Arr::dot Arr::except Arr::exists Arr::first Arr::flatten Arr::forget Arr::get Arr::has Arr::hasAny Arr::isAssoc Arr::isList Arr::join Arr::keyBy Arr::last Arr::map Arr::mapSpread Arr::mapWithKeys Arr::only Arr::pluck Arr::prepend Arr::prependKeysWith Arr::pull Arr::query Arr::random Arr::set Arr::shuffle Arr::sort Arr::sortDesc Arr::sortRecursive Arr::sortRecursiveDesc Arr::take Arr::toCssClasses Arr::toCssStyles Arr::undot Arr::where Arr::whereNotNull Arr::wrap data_fill data_get data_set data_forget head last
Numbers
Number::abbreviate Number::clamp Number::currency Number::fileSize Number::forHumans Number::format Number::ordinal Number::percentage Number::spell Number::useLocale Number::withLocale
Paths
URLs
Miscellaneous
abort abort_if abort_unless app auth back bcrypt blank broadcast cache class_uses_recursive collect config context cookie csrf_field csrf_token decrypt dd dispatch dispatch_sync dump encrypt env event fake filled info literal logger method_field now old once optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with
Arrays & Objects
Arr::accessible()
Arr::accessible method は与えられた value が array アクセス可能であるかどうかを判断します：
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 method は、指定した key がすでに array に存在しないか、またはnullに設定されている場合に、指定した key/ value のペアを array に追加します:
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 method は、 array の配列を 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 method は、指定された配列をクロスジョインし、すべての可能な順列でデカルト積を返します：
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 method は 2 つの配列を返します：一つは与えられた array の keys を含み、もう一つは values を含みます。
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
Arr::dot()
Arr::dot method は、多次元の array を"ドット"表記法を使用して深さを示す single レベルの array に平坦化します：
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::except()
Arr::except method は指定された key/ value のペアを array から削除します：
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']
Arr::exists()
Arr::existsの method は与えられた key が指定された 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 method は、指定された真偽 test を通過する array の最初の要素を返します。
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function (int $value, int $key) {
return $value >= 150;
});
// 200
defaultvalue も、method の三番目のパラメータとして渡すことができます。この value は、真偽 valuetest を通過しない value が返されます。
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);
Arr::flatten()
Arr::flatten method は、多次元の array を single レベルの array に平坦化します：
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::forget()
Arr::forget method は、"dot"表記法を使用して深くネストされた array から指定された key/ value ペアを削除します：
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::get()
Arr::getの method は "dot"表記を使用して深くネストされた array から value を取得します：
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100
Arr::get method は、 default value も受け入れます。これは、指定された key が array 内に存在しない場合に返されます:
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0
Arr::has()
Arr::has method は、"ドット"記法を使って、指定したアイテムまたはアイテムが array 内に存在するかどうかをチェックします。
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 method は、"ドット"表記を使用して、指定されたセットの任意のアイテムが array 内に存在するかどうかをチェックします。
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 method は、指定した array が連想 array である場合、trueを返します。 0 から始まる連番の数 values keys を持っていない array は"連想"とみなされます。
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::isList()
Arr::isList method は、与えられた array の keys がゼロから始まる連続した整数である場合、trueを返します：
use Illuminate\Support\Arr;
$isList = Arr::isList(['foo', 'bar', 'baz']);
// true
$isList = Arr::isList(['product' => ['name' => 'Desk', 'price' => 100]]);
// false
Arr::join()
Arr::joinの method は、array 要素を string で結合します。この method の第二引数を使用して、array の最終要素の結合 string も指定できます：
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の method keys は、指定されたキーによって array をキー化します。同じキーを持つ複数の項目がある場合、新しい 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の method は、指定された真偽 test を path する array の最後の要素を返します。
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function (int $value, int $key) {
return $value >= 150;
});
// 300
default value は、method の第 3 引数として渡すことができます。この value は、真の test を通過しない場合に返されます。
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::map()
Arr::mapの method は、 array を反復処理し、各 value と key を与えられたコールバックに渡します。 array value はコールバックによって返される value に置き換えられます:
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 method は、 array 全体を反復処理し、それぞれのネストされたアイテムの value を指定されたクロージャに渡します。クロージャはアイテムを自由に変更し、それを返し、これにより変更されたアイテムの新しい array が形成されます。
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の''method''は''array''を反復処理し、各''value''を指定したコールバックに渡します。コールバックは、''単一''の key/''value''ペアを含む関連''array''を返す必要があります：
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 method は、指定された key/ value のペアのみを与えられた 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 method は、指定された key から array のすべての values を取得します。
use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']
また、結果として得られるリストがどのようにキー付けされるべきかを指定することもできます：
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
Arr::prepend method は、 array の先頭にアイテムをプッシュします：
use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']
必要に応じて、 value 用のキーを指定することができます：
use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]
Arr::prependKeysWith()
Arr::prependKeysWithは、与えられたプレフィックスで array のすべてのキー名の前に付けます:
use Illuminate\Support\Arr;
$array = [
'name' => 'Desk',
'price' => 100,
];
$keyed = Arr::prependKeysWith($array, 'product.');
/*
[
'product.name' => 'Desk',
'product.price' => 100,
]
*/
Arr::pull()
Arr::pull method は、 array から key/ value のペアを返し、取り除きます：
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
default value は、 method の第 3 引数として渡すことができます。この value は、key が存在しない場合に返されます：
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);
Arr::query()
Arr::query method は、 array を 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 method は、 array から random value を返します:
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)
また、返すアイテムの数量をオプションの 2 番目の引数として指定することもできます。この引数を提供すると、1 つのアイテムだけが求められる場合でも array を返すことに注意してください。
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)
Arr::set()
Arr::set method は "dot" 表記を使用して、深くネストされた array 内に value を設定します：
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
Arr::shuffle()
Arr::shuffle method は、 array 内のアイテムをランダムにシャッフルします：
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)
Arr::sort()
Arr::sort method は、その values によって array をソートします：
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']
あなたはまた、特定のクロージャの結果によって array をソートすることもできます：
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の method は、その values によって array を降順に並べ替えます。
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sortDesc($array);
// ['Table', 'Desk', 'Chair']
また、特定のクロージャの結果によって array をソートすることもできます。
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 method は、数 values インデックスのサブ配列に対してsort関数を、連想サブ配列に対してksort関数を使用して、再帰的に array をソートします：
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 method を使用することができます。
$sorted = Arr::sortRecursiveDesc($array);
Arr::take()
Arr::take method は、指定された数のアイテムを持つ新しい array を返します：
use Illuminate\Support\Arr;
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, 3);
// [0, 1, 2]
また、指定された数の項目を array の最後から取得するために、負の integer を渡すこともできます：
$array = [0, 1, 2, 3, 4, 5];
$chunk = Arr::take($array, -2);
// [4, 5]
Arr::toCssClasses()
Arr::toCssClassesmethod は、条件に基づいて CSSclass の string をコンパイルします。この method では、array 内の key が追加したい class を含み、一方その value はブール式になります。array の要素が数 valuekey を持つ場合、それは常に rendering された class リストに含まれます。
use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/
Arr::toCssStyles()
Arr::toCssStylesは条件付きで CSS style の string をコンパイルします。この method は、 array の key が追加したい class を含み、 value が boolean 式であるクラスの array を受け入れます。 array の要素が数値の key を持っている場合、それは常に rendering された class リストに含まれます。
use Illuminate\Support\Arr;
$hasColor = true;
$array = ['background-color: blue', 'color: blue' => $hasColor];
$classes = Arr::toCssStyles($array);
/*
'background-color: blue; color: blue;'
*/
この method は Laravel の機能を通じて、[@class] Blade ディレクティブだけでなく、Blade コンポーネントの attribute バッグとクラスのマージも可能にします。
Arr::undot()
Arr::undot" method は "ドット"表記を使用する一次元の array を多次元の 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 method は与えられたクロージャを使用して array をフィルタリングします：
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 method は、指定された array からすべてのnull values を削除します:
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]
Arr::wrap()
Arr::wrap method は指定された value を array に包みます。指定された value がすでに array の場合、それは変更せずに返されます：
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
指定された value がnullの場合、空の array が返されます：
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
data_fill()
data_fill 関数は、"dot"表記を使用して、ネストされた array や object 内の欠損している value を設定します：
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
この関数はワイルドカードとしてアスタリスクも受け入れ、対象をそれに応じて埋めます:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/
data_get()
data_get関数は、"dot"表記法を使用して、ネストされた array または object から value を取得します。
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100
data_get 関数は、指定されたキーが見つからない場合に返される default value も受け入れます：
$discount = data_get($data, 'products.desk.discount', 0);
// 0
この関数は、アスタリスクを使用したワイルドカードも受け入れ、 array または object の任意のキーを対象とすることができます：
$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}のプレースホルダーは、 array の最初または最後の項目を取得するために使用できます：
$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関数は"dot"記法を使用して、ネストされた array または object 内に value を設定します：
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
この関数はアスタリスクを使用したワイルドカードも受け付け、対象に対して values を適切に設定します：
$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],
],
]
*/
default では、既存の value は上書きされます。存在しない values だけを設定したい場合は、関数の第 4 引数にfalseを渡すことができます。
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, overwrite: false);
// ['products' => ['desk' => ['price' => 100]]]
data_forget()
data_forget関数は、"dot"表記法を使用して、ネストされた array または object 内の value を削除します。
$data = ['products' => ['desk' => ['price' => 100]]];
data_forget($data, 'products.desk.price');
// ['products' => ['desk' => []]]
この関数はアスタリスクを使用したワイルドカードも受け入れ、その目標で values を削除します:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_forget($data, 'products.*.price');
/*
[
'products' => [
['name' => 'Desk 1'],
['name' => 'Desk 2'],
],
]
*/
head()
head関数は指定された array の最初の要素を返します。
$array = [100, 200, 300];
$first = head($array);
// 100
last()
last関数は、与えられた array の最後の要素を返します：
$array = [100, 200, 300];
$last = last($array);
// 300
Numbers
Number::abbreviate()
Number::abbreviate method は、指定された数値の value の人間が読めるフォーマットを、単位の略語とともに返します。
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 method は、指定された数値が特定の範囲内に留まることを保証します。数値が最小値よりも小さい場合、最小の value が返されます。数値が最大値よりも大きい場合、最大の value が返されます。
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 method は、与えられた value を 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 method は、指定されたバイト value のファイルサイズ表現を 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 method は、提供された数値の 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 method は与えられた数 values を locale 特有の 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 method は、数値の序数形を返します：
use Illuminate\Support\Number;
$number = Number::ordinal(1);
// 1st
$number = Number::ordinal(2);
// 2nd
$number = Number::ordinal(21);
// 21st
Number::percentage()
Number::percentage method は、与えられた value を 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 method は、与えられた数を string の単語に変換します：
use Illuminate\Support\Number;
$number = Number::spell(102);
// one hundred and two
$number = Number::spell(88, locale: 'fr');
// quatre-vingt-huit
after引数により、すべての数字が綴られるべき value を指定できます。
$number = Number::spell(10, after: 10);
// 10
$number = Number::spell(11, after: 10);
// eleven
until引数を使用すると、すべての数字がスペルアウトされるべき value の前に指定することができます:
$number = Number::spell(5, until: 10);
// five
$number = Number::spell(10, until: 10);
// 10
Number::useLocale()
Number::useLocale method は、数 values や通貨のフォーマット方法に影響を与えるグローバルな default の数字の locale を設定します。これは、後続のNumberclass のメソッドの呼び出しによって適用されます。
use Illuminate\Support\Number;
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Number::useLocale('de');
}
Number::withLocale()
Number::withLocale method は指定された locale を使用して与えられたクロージャを実行し、コールバックが実行された後に元の locale を復元します:
use Illuminate\Support\Number;
$number = Number::withLocale('de', function () {
return Number::format(1500);
});
Paths
app_path()
app_path関数は、アプリケーションのappディレクトリへの完全修飾 path を返します。また、app_path関数を使用して、 application ディレクトリに対する相対的なファイルへの完全修飾 path を生成することもできます。
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path()
base_path関数は、アプリケーションの root ディレクトリへの完全修飾 path を返します。また、 base_path関数を使用して、 project root ディレクトリに対して相対的な指定ファイルへの完全修飾 path を生成することもできます。
$path = base_path();
$path = base_path('vendor/bin');
config_path()
config_path関数は、application のconfigディレクトリへの完全修飾 path を返します。また、application の設定ディレクトリ内の特定のファイルへの完全修飾 path を生成するためにconfig_path関数を使用することもできます：
$path = config_path();
$path = config_path('app.php');
database_path()
database_path関数は、アプリケーションのdatabaseディレクトリへの完全修飾 path を返します。また、database_path関数を使用して、 database ディレクトリ内の特定のファイルへの完全修飾 path を生成することもできます。
$path = database_path();
$path = database_path('factories/UserFactory.php');
lang_path()
lang_path関数は、あなたの application のlangディレクトリへの完全に資格のある path を返します。また、ディレクトリ内の特定のファイルへの完全に資格のある path を生成するためにlang_path関数を使用することもできます：
$path = lang_path();
$path = lang_path('en/messages.php');
NOTE
default では、Laravel application のスケルトンには
langディレクトリが含まれていません。Laravel の言語ファイルをカスタマイズしたい場合、lang:publishArtisan command を使って公開できます。
mix()
mix関数はバージョン化されたMixファイルへの path を返します。
$path = mix('css/app.css');
public_path()
public_path関数は、アプリケーションのpublicディレクトリへの完全修飾 path を返します。また、public_path関数を使用して、 public ディレクトリ内の特定のファイルへの完全修飾 path を生成することもできます：
$path = public_path();
$path = public_path('css/app.css');
resource_path()
resource_path関数は、アプリケーションのresourcesディレクトリへの完全修飾 path を返します。また、resource_path関数を使用して、 resources ディレクトリ内の特定のファイルへの完全修飾 path を生成することもできます：
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path()
storage_path関数は、アプリケーションのstorageディレクトリへの完全修飾 path を返します。また、storage_path関数を使用して、 storage ディレクトリ内の指定されたファイルへの完全修飾 path を生成することもできます。
$path = storage_path();
$path = storage_path('app/file.txt');
URLs
action()
action関数は、指定された controller action のための URL を生成します：
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
もし method が route パラメータを受け入れる場合、それらを method への第二引数として渡すことができます：
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
asset機能は現在の request のス key ム(HTTP または HTTPS)を使用して、アセットの URL を生成します：
$url = asset('img/photo.jpg');
あなたは .env ファイルの ASSET_URL variable を設定することで、アセットの URL ホストを設定することができます。これは Amazon S3 や他の CDN のような外部 service でアセットをホストしている場合に便利です：
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
route関数は指定された名前付きの routeに対して URL を生成します。
$url = route('route.name');
もし route がパラメータを受け入れる場合、それらを関数への第二引数として渡すことができます：
$url = route('route.name', ['id' => 1]);
default として、route関数は絶対的な URL を生成します。相対的な URL を生成したい場合は、関数の３つ目の引数としてfalseを渡すことができます。
$url = route('route.name', ['id' => 1], false);
secure_asset()
secure_asset 関数は HTTPS を使用してアセットの URL を生成します：
$url = secure_asset('img/photo.jpg');
secure_url()
secure_url関数は、指定された path に対する完全修飾 HTTPS の URL を生成します。追加の URL セグメントは関数の第 2 引数で渡すことが可能です。
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
to_route()
to_route関数は、指定された名前付き routeに対してredirect HTTP responseを生成します：
return to_route('users.show', ['user' => 1]);
必要に応じて、to_route method の第三引数と第四引数として、割り当てるべき HTTP status コードと追加の responseheaders を渡すことができます。
return to_route('users.show', ['user' => 1], 302, ['X-Framework' => 'Laravel']);
url()
url関数は、指定された path に対する完全修飾 URL を生成します：
$url = url('user/profile');
$url = url('user/profile', [1]);
もし path が提供されていない場合、Illuminate\Routing\UrlGenerator インスタンスが返されます：
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
Miscellaneous
abort()
abort 関数は HTTP 例外をスローし、それは 例外 handlerによってレンダリングされます：
abort(403);
また、例外のメッセージとブラウザに送信するべき custom HTTP response headers を提供することもできます：
abort(403, 'Unauthorized.', $headers);
abort_if()
abort_if関数は、与えられた boolean 式がtrueに評価されると、 HTTP 例外をスローします：
abort_if(! Auth::user()->isAdmin(), 403);
abortの method のように、例外の custom response headers テキストを第三引数として、そして custom response headers の array を関数の第四引数として提供することもできます。
abort_unless()
abort_unless関数は、指定された boolean 式がfalseに評価された場合、 HTTP 例外をスローします。
abort_unless(Auth::user()->isAdmin(), 403);
abort method のように、例外の response テキストを第 3 引数として、また custom response headers の array を関数の第 4 引数として提供することもできます。
app()
app 関数は service container のインスタンスを返します：
$container = app();
コンテナから解決するために、 class またはインターフェース名を渡すことができます。
$api = app('HelpSpot\API');
auth()
auth関数はauthenticatorインスタンスを返します。これはAuth facade の代わりとして使用することができます：
$user = auth()->user();
必要に応じて、アクセスしたいガードインスタンスを指定することができます。
$user = auth('admin')->user();
back()
back 関数はユーザーの前の位置に redirect HTTP response を生成します：
return back($status = 302, $headers = [], $fallback = '/');
return back();
bcrypt()
bcrypt関数は、与えられた value を Bcrypt を using してhashesします。この関数はHash facade の代わりとして使用できます：
$password = bcrypt('my-secret-password');
blank()
blank関数は指定された value が"空白"であるかどうかを判断します。
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
blankの逆数については、filledの method をご覧ください。
broadcast()
broadcast関数は指定したeventをその listeners に配信します：
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();
cache()
cache 関数はcacheから values を取得するために使用できます。指定されたキーが cache に存在しない場合、オプションの default value が返されます。
$value = cache('key');
$value = cache('key', 'default');
関数にキー / value の組を持つ array を渡すことで、アイテムを cache に追加することができます。キャッシュされた value が有効とみなされる秒数または期間も渡すべきです：
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
class_uses_recursive関数は、 class によって使用されるすべての特性を返します。これには、すべての親クラスによって使用される特性も含まれます。
$traits = class_uses_recursive(App\Models\User::class);
collect()
collect関数は与えられた value からcollectionインスタンスを作成します：
$collection = collect(['taylor', 'abigail']);
config()
config関数は、設定変数の value を取得します。設定の values は"dot"の syntax を使用してアクセスすることができ、それにはファイルの名前とアクセスしたいオプションの名前が含まれています。 default value を指定することができ、設定オプションが存在しない場合にはその値が返されます。
$value = config('app.timezone');
$value = config('app.timezone', $default);
runtime で設定変数を設定することができます。これはキー/ value のペアを含む array を渡すことにより行います。ただし、この関数は現在の request の設定 value にのみ影響を与え、実際の設定 values を update することはありませんので注意してください:
config(['app.debug' => true]);
context()
context関数は、現在の contextから value を取得します。 default value を指定することができ、 context のキーが存在しない場合に返されます。
$value = context('trace_id');
$value = context('trace_id', $default);
キー/ value ペアの array を渡すことで、 context values を設定することができます。
use Illuminate\Support\Str;
context(['trace_id' => Str::uuid()->toString()]);
cookie()
cookie関数は新しいcookieインスタンスを作成します:
$cookie = cookie('name', 'value', $minutes);
csrf_field()
csrf_field 関数は、CSRF の token の value を含む HTML の hidden の input フィールドを生成します。例えば、Blade syntax を利用した場合は次のとおりです。
{{ csrf_field() }}
csrf_token()
csrf_token関数は、現在の CSRF の token の value を取得します：
$token = csrf_token();
decrypt()
decrypt関数は与えられた value を復号化します。この関数はCryptの facade に対する代替手段として使用することができます。
$password = decrypt($value);
dd()
dd関数は指定された変数をダンプし、スクリプトの実行を終了します：
dd($value);
dd($value1, $value2, $value3, ...);
もしスクリプトの実行を停止させたくない場合は、代わりに dump 関数を使用してください。
dispatch()
dispatch関数は、指定されたjob を Laravel job queueにプッシュします：
dispatch(new App\Jobs\SendEmails);
dispatch_sync()
dispatch_sync関数は与えられた job をsync queue に追加し、それが直ちに処理されるようにします：
dispatch_sync(new App\Jobs\SendEmails);
dump()
dump関数は与えられた変数をダンプします：
dump($value);
dump($value1, $value2, $value3, ...);
変数をダンプした後でスクリプトの実行を停止したい場合は、代わりに dd 関数を使用してください。
encrypt()
encrypt関数は与えられた value を暗号化します。この関数はCryptの facade に代わるものとして使用することができます。
$secret = encrypt('my-secret-value');
env()
env 関数は、 環境 variablesの value を取得するか、default 値を返します：
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
WARNING
あなたが
config:cacheの command を deployment process 中に実行する場合、設定ファイルからのみenv関数を呼び出していることを確認してください。設定が cache されると、.envファイルはロードされず、env関数へのすべての呼び出しはnullを返します。
event()
event 関数は、指定された event をその listeners にディスパッチします：
event(new UserRegistered($user));
fake()
fake関数はコンテナからFaker の singleton を解決します。これは model ファクトリー、database seeding、テスト、および views のプロトタイピングで fake data を作成する際に役立ちます：
@for($i = 0; $i < 10; $i++)
<dl>
<dt>Name</dt>
<dd>{{ fake()->name() }}</dd>
<dt>Email</dt>
<dd>{{ fake()->unique()->safeEmail() }}</dd>
</dl>
@endfor
default では、fake関数はconfig/app.phpの設定 option であるapp.faker_localeを利用します。通常、この設定 option はAPP_FAKER_LOCALE environment variables によって設定されます。また、locale をfake関数に渡すことで指定することもできます。各 locale は個々のシングルトンを解決します。
fake('nl_NL')->name()
filled()
filled関数は、与えられた value が"blank"でないかどうかを判断します。
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
filledの逆数については、blankの method を参照してください。
info()
info関数は、あなたのアプリケーションのlogに情報を書き込みます。
info('Some helpful information!');
関数には、 array のコンテキスト data も渡すことができます：
info('User login attempt failed.', ['id' => $user->id]);
literal()
literal関数は与えられた名前付き引数をプロパティとして新しいstdClass インスタンスを作成します：
$obj = literal(
name: 'Joe',
languages: ['PHP', 'Ruby'],
);
$obj->name; // 'Joe'
$obj->languages; // ['PHP', 'Ruby']
logger()
logger関数は、logにdebugレベルのメッセージを書き込むために使用することができます：
logger('Debug message');
関数には、コンテキストの data としての array も渡すことができます：
logger('User has logged in.', ['id' => $user->id]);
関数に value が渡されない場合、ロガーのインスタンスが返されます：
logger()->error('You are not allowed here.');
method_field()
method_field関数は、フォームの HTTP 動詞の偽装 value を含む input hidden HTML フィールドを生成します。例えば、Blade syntaxを使用すると：
<form method="POST">
{{ method_field('DELETE') }}
</form>
now()
now関数は現在の時間のための新しいIlluminate\Support\Carbonインスタンスを作成します:
$now = now();
old()
old 関数は、以前の input value を session に取得します：
$value = old('value');
$value = old('value', 'default');
old関数の第二引数として提供される"default values"は、しばしば属性の Eloquent model となりますが、Laravel では、第二引数として単に全体の Eloquent model をold関数に渡すことができます。そうすると、Laravel はold関数に提供された最初の引数が"default values"とみなされるべき Eloquent 属性の名前であると想定します。
{{ old('name', $user->name) }}
// Is equivalent to...
{{ old('name', $user) }}
once()
once関数は指定されたコールバックを実行し、その結果を request の期間、メモリ内にキャッシュします。同じコールバックを持つonce関数への後続の呼び出しは、以前にキャッシュされた結果を返します。
function random(): int
{
return once(function () {
return random_int(1, 1000);
});
}
random(); // 123
random(); // 123 (cached result)
random(); // 123 (cached result)
once関数が object インスタンス内から実行されると、cache された結果はその object インスタンスに unique になります：
<?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関数は任意の引数を受け入れ、その object 上でプロパティをアクセスしたり、メソッドを呼び出したりすることができます。与えられた object がnullの場合、プロパティとメソッドは error を引き起こす代わりにnullを返します。
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
optional関数は、第二引数としてクロージャも受け入れます。もし、第一引数として提供された value が null でない場合、クロージャが実行されます。
return optional(User::find($id), function (User $user) {
return $user->name;
});
policy()
policy method は、指定された class のpolicyインスタンスを取得します：
$policy = policy(App\Models\User::class);
redirect()
redirect 関数はredirect HTTP responseを返すか, 引数なしで呼び出された場合はリダイレクタのインスタンスを返します:
return redirect($to = null, $status = 302, $headers = [], $https = null);
return redirect('/home');
return redirect()->route('route.name');
report()
report関数は、あなたの例外 handlerを使用して例外を報告します：
report($e);
report 関数はまた、 string を引数として受け入れます。 string が関数に与えられると、その関数は与えられた string をそのメッセージとして例外を生成します：
report('Something went wrong.');
report_if()
report_if関数は、指定された条件がtrueの場合、あなたの例外 handlerを使用して例外を報告します：
report_if($shouldReport, $e);
report_if($shouldReport, 'Something went wrong.');
report_unless()
report_unless関数は、指定された条件がfalseの場合、例外 handlerを使用して例外を報告します：
report_unless($reportingDisabled, $e);
report_unless($reportingDisabled, 'Something went wrong.');
request()
request関数は現在のrequestインスタンスを返すか、現在の request から input フィールドの value を取得します:
$request = request();
$value = request('key', $default);
rescue()
rescue関数は与えられたクロージャを実行し、その実行中に発生する例外を補足します。補足されたすべての例外はあなたの例外ハンドラーに送られます。しかし、request は処理を続けます：
return rescue(function () {
return $this->method();
});
また、rescue関数に第二引数を渡すこともできます。この引数は、クロージャを実行中に例外が発生した場合に返されるべき"デフォルト"の value となります：
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
report引数は、例外がreport関数を介して報告されるべきかどうかを判断するために、rescue関数に提供できます：
return rescue(function () {
return $this->method();
}, report: function (Throwable $throwable) {
return $throwable instanceof InvalidArgumentException;
});
resolve()
resolve関数は、与えられた class またはインターフェース名をservice containerを使用してインスタンスに解決します。
$api = resolve('HelpSpot\API');
response()
response関数は、responseインスタンスを作成するか、 response factory のインスタンスを取得します：
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
retry()
retry関数は、与えられた最大の attempt の閾値が満たされるまで、与えられたコールバックを実行しようとします。コールバックが例外を throw しない場合、その戻り value が返されます。コールバックが例外をスローすると、自動的に再試行されます。最大の attempt 数を超えると、例外がスローされます:
return retry(5, function () {
// Attempt 5 times while resting 100ms between attempts...
}, 100);
試行間で sleep するミリ秒数を手動で計算したい場合は、retry関数の第 3 引数としてクロージャを渡すことができます:
use Exception;
return retry(5, function () {
// ...
}, function (int $attempt, Exception $exception) {
return $attempt * 100;
});
便宜上、retry 関数の最初の引数として array を提供することができます。この array は、連続した試みの間に何ミリ秒 sleep するかを決定するために使われます。
return retry([100, 200], function () {
// Sleep for 100ms on first retry, 200ms on second retry...
});
特定の条件下でのみ retry を行うために、あなたは閉鎖をretry関数の第 4 の引数として渡すことができます：
use Exception;
return retry(5, function () {
// ...
}, 100, function (Exception $exception) {
return $exception instanceof RetryException;
});
session()
session関数は、session values を取得または設定するために使用できます:
$value = session('key');
関数にキー/ value のペアの array を渡すことで、 values を設定することができます。
session(['chairs' => 7, 'instruments' => 3]);
関数に value が渡されない場合、 session ストアが返されます：
$value = session()->get('key');
session()->put('key', $value);
tap()
tap関数は、任意の$valueとクロージャを引数として受け取ります。$valueはクロージャに渡され、その後tap関数によって返されます。クロージャの戻り value は関係ありません：
$user = tap(User::first(), function (User $user) {
$user->name = 'taylor';
$user->save();
});
tap関数にクロージャが渡されない場合、与えられた$value上で任意の method を呼び出すことができます。呼び出した method の返り value は常に$valueとなり、その method が定義内で実際には何を返すかに関係なくなります。例えば、 Eloquent のupdate method は通常、 integer を返します。しかし、tap関数を通じてupdate method をチェーン呼び出しすることにより、 method が model 自身を返すように強制することができます：
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
tap method を class に追加するためには、Illuminate\Support\Traits\Tappableトレイトを class に追加することができます。このトレイトのtap method はクロージャを唯一の引数として受け取ります。 object のインスタンス自体がクロージャに渡され、それからtap method によって返されます：
return $user->tap(function (User $user) {
// ...
});
throw_if()
throw_if関数は、指定された boolean 式が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関数は、指定された boolean 式がfalseに評価された場合に、指定された例外をスローします：
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
today()
today 関数は、現在の日付のための新しい Illuminate\Support\Carbon インスタンスを作成します:
$today = today();
trait_uses_recursive()
trait_uses_recursive関数は、トレイトが使用するすべてのトレイトを返します：
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
transform関数は、与えられた value が空白ではない場合にクロージャーを実行し、そのクロージャーの戻り value を返します。
$callback = function (int $value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
default value またはクロージャは、関数の第 3 引数として渡すことができます。 value が空白だった場合、この value が返されます：
$result = transform(null, $callback, 'The value is blank');
// The value is blank
validator()
Validator関数は、指定された引数と共に新しいvalidatorのインスタンスを作成します。それはvalidator facade の代替として使用することができます。
$validator = validator($data, $rules, $messages);
value()
value関数は与えられた value を返します。しかし、もしこの関数にクロージャを渡すと、そのクロージャが実行され、その返り値の value が返されます:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
追加の引数は value 関数に渡すことが可能です。最初の引数がクロージャである場合、追加のパラメータは引数としてクロージャに渡されます。それ以外の場合は無視されます:
$result = value(function (string $name) {
return $name;
}, 'Taylor');
// 'Taylor'
view()
view関数はviewインスタンスを取得します：
return view('auth.login');
with()
with関数は与えられた value を返します。もしクロージャが関数の第二引数として渡された場合、そのクロージャは実行され、その戻り値の value が返されます：
$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
時々、あなたは application の特定の部分のパフォーマンスをすばやくテストしたいと思うかもしれません。そのような場合、あなたはBenchmarkサポート class を利用して、与えられたコールバックが完了するまでにかかるミリ秒数を測定することができます。
<?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
]);
default では、指定されたコールバックは一度(1 回のイテレーション)実行され、その期間はブラウザー/ console に表示されます。
コールバックを一度以上呼び出すには、コールバックが呼び出されるべき回数を method の第二引数として指定できます。コールバックを複数回実行するとき、Benchmark class は、すべての反復でコールバックを実行するのに必要なミリ秒の平均量を返します：
Benchmark::dd(fn () => User::count(), iterations: 10); // 0.5 ms
時には、コールバックの実行をベンチマークしたいと思うかもしれませんが、その際でもコールバックによって返される value を取得したいと思うかもしれません。value method は、コールバックによって返される value と、コールバックの実行に要したミリ秒数を含むタプルを返します：
[$count, $duration] = Benchmark::value(fn () => User::count());
Dates
Laravel application はCarbon を含んでおり、これは強力な日時操作の library です。新しいCarbonインスタンスを作成するには、now関数を呼び出すことができます。この関数は、 Laravel アプリケーション 全体で利用可能です。
$now = now();
または、Illuminate\Support\Carbonの class を使用して新しいCarbonインスタンスを作成することもできます:
use Illuminate\Support\Carbon;
$now = Carbon::now();
徹底的な Carbon およびその機能の議論については、公式 Carbon ドキュメンテーション をご覧ください。
Lottery
Laravel の抽選 class は、与えられたオッズに基づいてコールバックを実行するために使用できます。これは、受信リクエストの一部の割合に対してのみ code を実行したい場合に特に便利です：
use Illuminate\Support\Lottery;
Lottery::odds(1, 20)
->winner(fn () => $user->won())
->loser(fn () => $user->lost())
->choose();
Laravel の lottery class を他の Laravel features と組み合わせることができます。例えば、遅いクエリのうち一部だけを handler へ報告するようにしたいかもしれません。そして、lottery class は呼び出し可能なので、呼び出し可能なものを受け入れる任意の method にその class のインスタンスを渡すことができます:
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 ロトリー
Laravel は、アプリケーションのロトリー呼び出しを簡単にテストできるように、いくつかのシンプルなメソッドを提供しています:
// 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();
Pipeline
Laravel のPipelineの facade は、与えられた input を一連の呼び出し可能な class、クロージャ、またはコールバックを通じてパイプする便利な方法を提供し、各 class に input を検査または修正し、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);
ご覧の通り、各呼び出し可能な class やクロージャは pipeline 内で input と$nextクロージャが提供されます。$nextクロージャを呼び出すと、 pipeline 内の次の呼び出し可能なものが呼び出されます。お気づきかもしれませんが、これはmiddlewareと非常に似ています。
pipeline の最後の callable が$nextクロージャを呼び出すと、thenの method に提供された callable が呼び出されます。通常、この callable は単に与えられた input を返します。
もちろん、前述の通り、あなたが pipeline に提供するのはクロージャーに限られません。また、呼び出し可能なクラスを提供することもできます。もし class の名前が提供された場合、その class は Laravel のservice containerを经由してインスタンス化され、呼び出し可能な class に依存性を注入することができます。
$user = Pipeline::send($user)
->through([
GenerateProfilePhoto::class,
ActivateSubscription::class,
SendWelcomeEmail::class,
])
->then(fn (User $user) => $user);
Sleep
Laravel のSleep class は、PHP のネイティブなsleepおよびusleep関数を軽量にラップしたもので、テストのしやすさを向上させるとともに、時間とのやり取りに向くデベロッパーフレンドリーな API を提供します。
use Illuminate\Support\Sleep;
$waiting = true;
while ($waiting) {
Sleep::for(1)->second();
$waiting = /* ... */;
}
Sleep class は、さまざまな時間単位で作業できるようにする多くの methods を提供します。
// 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 method を使用することができます。
Sleep::for(1)->second()->and(10)->milliseconds();
Testing Sleep
Sleep class や PHP のネイティブスリープ関数を利用したコードを testing すると、testing の実行が一時停止します。予想通り、これにより testing スイートは大幅に遅くなります。例えば、次のコードを testing していると想像してみてください。
$waiting = /* ... */;
$seconds = 1;
while ($waiting) {
Sleep::for($seconds++)->seconds();
$waiting = /* ... */;
}
通常、この code を testing するには、少なくとも1 秒かかります。幸いなことに、Sleep class により、テストスイートを高速で保つために fake スリープをすることができます。
it('waits until ready', function () {
Sleep::fake();
// ...
});
public function test_it_waits_until_ready()
{
Sleep::fake();
// ...
}
Sleep class を偽装すると、実際の実行一時停止がバイパスされ、テストが大幅に高速化します。
Sleep class がフェイクされたら、期待される sleeps が発生したかに対してアサーションを行うことができます。これを説明するために、実行を 3 回一時停止し、それぞれの停止が single 秒ずつ増加するという testing code を想像してみましょう。assertSequence method を使用して、code が適切な時間 sleep したことを assert し、テストを速く保つことができます：
it('checks if ready three times', function () {
Sleep::fake();
// ...
Sleep::assertSequence([
Sleep::for(1)->second(),
Sleep::for(2)->seconds(),
Sleep::for(3)->seconds(),
]);
}
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 class は、 testing を行う際に使用できる他のさまざまなアサーションを提供しています。
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();
時々、あなたの application code で fake sleep が発生したときに、action を実行することが有用かもしれません。これを実現するためには、whenFakingSleep 方法にコールバックを提供することができます。以下の例では、Laravel のtime manipulation helpersを使用して、各 sleep の期間だけ時間を即時に進めます：
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 method は、テスト内でスリープする際に Carbon を sync に保つためのsyncWithCarbon引数を受け入れます。
Sleep::fake(syncWithCarbon: true);
$start = now();
Sleep::for(1)->second();
$start->diffForHumans(); // 1 second ago
Laravel は実行を一時停止するたびに、内部的にSleep class を使用します。たとえば、retry helper は、スリープ中にSleep class を使用し、その helper を使用する際の test 可能性を向上させます。