バージョン: 10.x

ヘルパ (Helpers)

Introduction
利用可能な方法
その他のユーティリティ
- Benchmarking
- Dates
- Lottery
- Pipeline
- Sleep

導入 (Introduction)

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

利用可能な方法 (Available Methods)

配列とオブジェクト

その他

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

`Arr::accessible()`

Arr::accessible メソッドは、指定された値が配列にアクセスできるかどうかを判断します。

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;

$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);

// true

$isAccessible = Arr::accessible(new Collection);

// true

$isAccessible = Arr::accessible('abc');

// false

$isAccessible = Arr::accessible(new stdClass);

// false

`Arr::add()`

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

use Illuminate\Support\Arr;

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

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

$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);

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

`Arr::collapse()`

Arr::collapse メソッドは、配列の配列を単一の配列に折りたたみます。

use Illuminate\Support\Arr;

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

// [1, 2, 3, 4, 5, 6, 7, 8, 9]

`Arr::crossJoin()`

Arr::crossJoin メソッドは、指定された配列を相互結合し、すべての可能な順列を含むデカルト積を返します。

use Illuminate\Support\Arr;

$matrix = Arr::crossJoin([1, 2], ['a', 'b']);

/*
    [
        [1, 'a'],
        [1, 'b'],
        [2, 'a'],
        [2, 'b'],
    ]
*/

$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);

/*
    [
        [1, 'a', 'I'],
        [1, 'a', 'II'],
        [1, 'b', 'I'],
        [1, 'b', 'II'],
        [2, 'a', 'I'],
        [2, 'a', 'II'],
        [2, 'b', 'I'],
        [2, 'b', 'II'],
    ]
*/

`Arr::divide()`

Arr::divide メソッドは 2 つの配列を返します。1 つはキーを含み、もう 1 つは指定された配列の値を含みます。

use Illuminate\Support\Arr;

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

// $keys: ['name']

// $values: ['Desk']

`Arr::dot()`

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

use Illuminate\Support\Arr;

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

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

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

`Arr::except()`

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

use Illuminate\Support\Arr;

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

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

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

`Arr::exists()`

Arr::exists メソッドは、指定されたキーが指定された配列に存在することを確認します。

use Illuminate\Support\Arr;

$array = ['name' => 'John Doe', 'age' => 17];

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

// true

$exists = Arr::exists($array, 'salary');

// false

`Arr::first()`

Arr::first メソッドは、指定された真理値テストに合格した配列の最初の要素を返します。

use Illuminate\Support\Arr;

$array = [100, 200, 300];

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

// 200

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

use Illuminate\Support\Arr;

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

`Arr::flatten()`

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

use Illuminate\Support\Arr;

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

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

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

`Arr::forget()`

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

use Illuminate\Support\Arr;

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

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

// ['products' => []]

`Arr::get()`

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

use Illuminate\Support\Arr;

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

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

// 100

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

use Illuminate\Support\Arr;

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

// 0

`Arr::has()`

Arr::has メソッドは、「ドット」表記を使用して、指定された項目が配列内に存在するかどうかをチェックします。

use Illuminate\Support\Arr;

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

$contains = Arr::has($array, 'product.name');

// true

$contains = Arr::has($array, ['product.price', 'product.discount']);

// false

`Arr::hasAny()`

Arr::hasAny メソッドは、「ドット」表記を使用して、指定されたセット内の項目が配列内に存在するかどうかをチェックします。

use Illuminate\Support\Arr;

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

$contains = Arr::hasAny($array, 'product.name');

// true

$contains = Arr::hasAny($array, ['product.name', 'product.discount']);

// true

$contains = Arr::hasAny($array, ['category', 'product.discount']);

// false

`Arr::isAssoc()`

指定された配列が連想配列の場合、Arr::isAssoc メソッドは true を返します。配列にゼロで始まる連続した数値キーがない場合、その配列は「結合」とみなされます。

use Illuminate\Support\Arr;

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

// true

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

// false

`Arr::isList()`

指定された配列のキーがゼロから始まる連続した整数の場合、Arr::isList メソッドは 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 メソッドは、配列要素を文字列と結合します。このメソッドの 2 番目の引数を使用して、配列の最後の要素の結合文字列を指定することもできます。

use Illuminate\Support\Arr;

$array = ['Tailwind', 'Alpine', 'Laravel', 'Livewire'];

$joined = Arr::join($array, ', ');

// Tailwind, Alpine, Laravel, Livewire

$joined = Arr::join($array, ', ', ' and ');

// Tailwind, Alpine, Laravel and Livewire

`Arr::keyBy()`

Arr::keyBy メソッドは、指定されたキーによって配列にキーを設定します。複数の項目が同じキーを持つ場合、最後の項目だけが新しい配列に表示されます。

use Illuminate\Support\Arr;

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

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

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

`Arr::last()`

Arr::last メソッドは、指定された真理値テストに合格した配列の最後の要素を返します。

use Illuminate\Support\Arr;

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

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

// 300

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

use Illuminate\Support\Arr;

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

`Arr::map()`

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

use Illuminate\Support\Arr;

$array = ['first' => 'james', 'last' => 'kirk'];

$mapped = Arr::map($array, function (string $value, string $key) {
    return ucfirst($value);
});

// ['first' => 'James', 'last' => 'Kirk']

`Arr::mapWithKeys()`

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

use Illuminate\Support\Arr;

$array = [
    [
        'name' => 'John',
        'department' => 'Sales',
        'email' => '[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 メソッドは、指定された配列から指定されたキーと値のペアのみを返します。

use Illuminate\Support\Arr;

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

$slice = Arr::only($array, ['name', 'price']);

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

`Arr::pluck()`

Arr::pluck メソッドは、配列から指定されたキーのすべての値を取得します。

use Illuminate\Support\Arr;

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

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

// ['Taylor', 'Abigail']

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

use Illuminate\Support\Arr;

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

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

`Arr::prepend()`

Arr::prepend メソッドは、項目を配列の先頭にプッシュします。

use Illuminate\Support\Arr;

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

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

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

必要に応じて、値に使用するキーを指定できます。

use Illuminate\Support\Arr;

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

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

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

`Arr::prependKeysWith()`

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

use Illuminate\Support\Arr;

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

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

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

`Arr::pull()`

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

use Illuminate\Support\Arr;

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

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

// $name: Desk

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

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

use Illuminate\Support\Arr;

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

`Arr::query()`

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

use Illuminate\Support\Arr;

$array = [
    'name' => 'Taylor',
    'order' => [
        'column' => 'created_at',
        'direction' => 'desc'
    ]
];

Arr::query($array);

// name=Taylor&order[column]=created_at&order[direction]=desc

`Arr::random()`

Arr::random メソッドは、配列からランダムな値を返します。

use Illuminate\Support\Arr;

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

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

// 4 - (retrieved randomly)

オプションの 2 番目の引数として、返す項目の数を指定することもできます。この引数を指定すると、必要な項目が 1 つだけの場合でも配列が返されることに注意してください。

use Illuminate\Support\Arr;

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

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

`Arr::set()`

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

use Illuminate\Support\Arr;

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

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

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

`Arr::shuffle()`

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

use Illuminate\Support\Arr;

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

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

`Arr::sort()`

Arr::sort メソッドは、配列を値で並べ替えます。

use Illuminate\Support\Arr;

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

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

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

特定のクロージャの結果によって配列を並べ替えることもできます。

use Illuminate\Support\Arr;

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

$sorted = array_values(Arr::sort($array, function (array $value) {
    return $value['name'];
}));

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

`Arr::sortDesc()`

Arr::sortDesc メソッドは、配列を値の降順に並べ替えます。

use Illuminate\Support\Arr;

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

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

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

特定のクロージャの結果によって配列を並べ替えることもできます。

use Illuminate\Support\Arr;

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

$sorted = array_values(Arr::sortDesc($array, function (array $value) {
    return $value['name'];
}));

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

`Arr::sortRecursive()`

Arr::sortRecursive メソッドは、数値インデックス付きサブ配列の場合は sort 関数を使用し、連想サブ配列の場合は ksort 関数を使用して、配列を再帰的に並べ替えます。

use Illuminate\Support\Arr;

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
    ['one' => 1, 'two' => 2, 'three' => 3],
];

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

/*
    [
        ['JavaScript', 'PHP', 'Ruby'],
        ['one' => 1, 'three' => 3, 'two' => 2],
        ['Li', 'Roman', 'Taylor'],
    ]
*/

結果を降順に並べ替えたい場合は、Arr::sortRecursiveDesc メソッドを使用できます。

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

`Arr::take()`

Arr::take メソッドは、指定された項目数を含む新しい配列を返します。

use Illuminate\Support\Arr;

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

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

// [0, 1, 2]

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

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

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

// [4, 5]

`Arr::toCssClasses()`

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

use Illuminate\Support\Arr;

$isActive = false;
$hasError = true;

$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];

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

/*
    'p-4 bg-red'
*/

`Arr::toCssStyles()`

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

use Illuminate\Support\Arr;

$hasColor = true;

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

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

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

このメソッドは、Laravel の機能を強化し、クラスを Blade コンポーネントの属性バッグと結合するおよび @class Blade ディレクティブを許可します。

`Arr::undot()`

Arr::undot メソッドは、「ドット」表記を使用する 1 次元配列を多次元配列に拡張します。

use Illuminate\Support\Arr;

$array = [
    'user.name' => 'Kevin Malone',
    'user.occupation' => 'Accountant',
];

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

// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]

`Arr::where()`

Arr::where メソッドは、指定されたクロージャを使用して配列をフィルタリングします。

use Illuminate\Support\Arr;

$array = [100, '200', 300, '400', 500];

$filtered = Arr::where($array, function (string|int $value, int $key) {
    return is_string($value);
});

// [1 => '200', 3 => '400']

`Arr::whereNotNull()`

Arr::whereNotNull メソッドは、指定された配列からすべての null 値を削除します。

use Illuminate\Support\Arr;

$array = [0, null];

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

// [0 => 0]

`Arr::wrap()`

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

use Illuminate\Support\Arr;

$string = 'Laravel';

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

// ['Laravel']

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

use Illuminate\Support\Arr;

$array = Arr::wrap(null);

// []

`data_fill()`

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

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

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

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

data_fill($data, 'products.desk.discount', 10);

// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]

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

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

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

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

`data_get()`

data_get 関数は、「ドット」表記を使用して、ネストされた配列またはオブジェクトから値を取得します。

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

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

// 100

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

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

// 0

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

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

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

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

`data_set()`

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

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

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

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

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

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

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

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

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

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

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

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

`data_forget()`

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

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

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

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

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

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

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

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

`head()`

head 関数は、指定された配列の最初の要素を返します。

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

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

$array = [100, 200, 300];

$last = last($array);

// 300

数字 (Numbers)

`Number::abbreviate()`

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

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

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

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 メソッドは、指定されたバイト値のファイルサイズ表現を文字列として返します。

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

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

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

use Illuminate\Support\Number;

$number = Number::ordinal(1);

// 1st

$number = Number::ordinal(2);

// 2nd

$number = Number::ordinal(21);

// 21st

`Number::percentage()`

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

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

use Illuminate\Support\Number;

$number = Number::spell(102);

// one hundred and two

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

// quatre-vingt-huit

after 引数を使用すると、すべての数値の後に続く値を指定できます。

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

// 10

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

// eleven

until 引数を使用すると、すべての数値の前にスペルアウトする必要がある値を指定できます。

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

// five

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

// 10

`Number::useLocale()`

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

use Illuminate\Support\Number;

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

`Number::withLocale()`

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

use Illuminate\Support\Number;

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

パス (Paths)

`app_path()`

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

$path = app_path();

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

`base_path()`

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

$path = base_path();

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

`config_path()`

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

$path = config_path();

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

`database_path()`

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

$path = database_path();

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

`lang_path()`

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

$path = lang_path();

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

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

`mix()`

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

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

`public_path()`

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

$path = public_path();

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

`resource_path()`

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

$path = resource_path();

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

`storage_path()`

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

$path = storage_path();

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

URL (URLs)

`action()`

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

use App\Http\Controllers\HomeController;

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

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

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

`asset()`

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

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

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

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

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

`route()`

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

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

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

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

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

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

`secure_asset()`

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

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

`secure_url()`

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

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

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

`to_route()`

to_route 関数は、指定された名前付きルートの HTTP 応答をリダイレクトするを生成します。

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

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

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

`url()`

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

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

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

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

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

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

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

その他 (Miscellaneous)

`abort()`

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

abort(403);

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

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

`abort_if()`

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

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

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

`abort_unless()`

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

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

`app()`

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

$container = app();

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

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

`auth()`

auth 関数は、authenticator インスタンスを返します。 Auth ファサードの代替として使用できます。

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

必要に応じて、アクセスするガードインスタンスを指定できます。

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

`back()`

back 関数は、ユーザーの以前の場所に HTTP 応答をリダイレクトするを生成します。

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

return back();

`bcrypt()`

bcrypt 関数 hashes は、Bcrypt を使用して指定された値を取得します。この関数は、Hash ファサードの代わりに使用できます。

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

`blank()`

blank 関数は、指定された値が「空白」かどうかを判断します。

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

// true

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

// false

blank の逆については、filled メソッドを参照してください。

`broadcast()`

broadcast 関数 broadcasts は、指定された event をリスナに渡します。

broadcast(new UserRegistered($user));

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

`cache()`

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

$value = cache('key');

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

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

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

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

`class_uses_recursive()`

class_uses_recursive 関数は、そのすべての親クラスで使用される特性を含む、クラスで使用されるすべての特性を返します。

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

`collect()`

collect 関数は、指定された値から collection インスタンスを作成します。

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

`config()`

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

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

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

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

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

`cookie()`

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

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

`csrf_field()`

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

{{ csrf_field() }}

`csrf_token()`

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

$token = csrf_token();

`decrypt()`

decrypt 関数 decrypts に指定された値。この関数は、Crypt ファサードの代わりに使用できます。

$password = decrypt($value);

`dd()`

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

dd($value);

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

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

`dispatch()`

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

dispatch(new App\Jobs\SendEmails);

`dispatch_sync()`

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

dispatch_sync(new App\Jobs\SendEmails);

`dump()`

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

dump($value);

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

変数をダンプした後にスクリプトの実行を停止する場合は、代わりに dd 関数を使用します。

`encrypt()`

encrypt 関数 encrypts に指定された値。この関数は、Crypt ファサードの代わりに使用できます。

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

`env()`

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

$env = env('APP_ENV');

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

デプロイメントプロセス中に config:cache コマンドを実行する場合は、構成ファイル内からのみ env 関数を呼び出していることを確認する必要があります。構成がキャッシュされると、.env ファイルはロードされず、env 関数へのすべての呼び出しは null を返します。

`event()`

event 関数は、指定された event をリスナにディスパッチします。

event(new UserRegistered($user));

`fake()`

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

@for($i = 0; $i < 10; $i++)
    <dl>
        <dt>Name</dt>
        <dd>{{ fake()->name() }}</dd>

        <dt>Email</dt>
        <dd>{{ fake()->unique()->safeEmail() }}</dd>
    </dl>
@endfor

デフォルトでは、fake 関数は、config/app.php 構成ファイル内の app.faker_locale 構成オプションを利用します。ただし、ロケールを fake 関数に渡して指定することもできます。各ロケールは個々のシングルトンを解決します。

fake('nl_NL')->name()

`filled()`

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

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

// true

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

// false

filled の逆については、blank メソッドを参照してください。

`info()`

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

info('Some helpful information!');

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

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

`logger()`

logger 関数を使用して、debug レベルのメッセージを log に書き込むことができます。

logger('Debug message');

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

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

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

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

`method_field()`

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

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

`now()`

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

$now = now();

`old()`

old 関数 retrieves および古い入力値がセッションにフラッシュされました。

$value = old('value');

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

old 関数の 2 番目の引数として指定される「デフォルト値」は多くの場合 Eloquent モデルの属性であるため、Laravel では Eloquent モデル全体を 2 番目の引数として old 関数に渡すだけで済みます。これを行うと、Laravel は、old 関数に指定された最初の引数が、「デフォルト値」とみなされるべき Eloquent 属性の名前であると想定します。

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

// Is equivalent to...

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

`optional()`

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

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

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

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

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

`policy()`

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

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

`redirect()`

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

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

return redirect('/home');

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

`report()`

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

report($e);

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

report('Something went wrong.');

`report_if()`

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

report_if($shouldReport, $e);

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

`report_unless()`

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

report_unless($reportingDisabled, $e);

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

`request()`

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

$request = request();

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

`rescue()`

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

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

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

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

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

report 引数を rescue 関数に指定して、例外を report 関数経由で報告するかどうかを決定できます。

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

`resolve()`

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

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

`response()`

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

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

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

`retry()`

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

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

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

use Exception;

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

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

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

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

use Exception;

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

`session()`

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

$value = session('key');

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

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

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

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

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

`tap()`

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

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

    $user->save();
});

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

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

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

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

`throw_if()`

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

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

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

`throw_unless()`

指定されたブール式が false と評価される場合、throw_unless 関数は指定された例外をスローします。

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 関数は、値が blank でない場合、指定された値に対してクロージャを実行し、クロージャの戻り値を返します。

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

$result = transform(5, $callback);

// 10

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

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

// The value is blank

`validator()`

validator 関数は、指定された引数を使用して新しい validator インスタンスを作成します。 Validator ファサードの代替として使用できます。

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

`value()`

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

$result = value(true);

// true

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

// false

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

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

// 'Taylor'

`view()`

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

return view('auth.login');

`with()`

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

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

ベンチマーク

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

<?php

use App\Models\User;
use Illuminate\Support\Benchmark;

Benchmark::dd(fn () => User::find(1)); // 0.1 ms

Benchmark::dd([
    'Scenario 1' => fn () => User::count(), // 0.5 ms
    'Scenario 2' => fn () => User::all()->count(), // 20.0 ms
]);

デフォルトでは、指定されたコールバックは 1 回 (1 回の反復) 実行され、その期間はブラウザ/コンソールに表示されます。

コールバックを複数回呼び出すには、コールバックを呼び出す反復回数をメソッドの 2 番目の引数として指定できます。コールバックを複数回実行すると、Benchmark クラスは、すべての反復にわたってコールバックの実行にかかった平均ミリ秒数を返します。

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

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

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

日付

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

$now = now();

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

use Illuminate\Support\Carbon;

$now = Carbon::now();

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

宝くじ

Laravel の宝くじクラスは、指定されたオッズのセットに基づいてコールバックを実行するために使用できます。これは、受信リクエストの一部のコードのみを実行したい場合に特に便利です。

use Illuminate\Support\Lottery;

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

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

use Carbon\CarbonInterval;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Lottery;

DB::whenQueryingForLongerThan(
    CarbonInterval::seconds(2),
    Lottery::odds(1, 100)->winner(fn () => report('Querying > 2 seconds.')),
);

宝くじのテスト

Laravel には、アプリケーションの宝くじ呼び出しを簡単にテストできるようにするための簡単なメソッドがいくつか用意されています。

// Lottery 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 ファサードは、一連の呼び出し可能なクラス、クロージャ、または呼び出し可能オブジェクトを介して特定の入力を「パイプ」する便利な方法を提供し、各クラスに入力を検査または変更して、パイプライン内の次の呼び出し可能オブジェクトを呼び出す機会を与えます。

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

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

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

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

寝る

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

use Illuminate\Support\Sleep;

$waiting = true;

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

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

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

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

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

睡眠のテスト

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

$waiting = /* ... */;

$seconds = 1;

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

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

通常、このコードのテストには少なくとも 1 秒かかります。幸いなことに、Sleep クラスを使用すると、テストスイートの速度を維持するために、睡眠を「偽装」することができます。

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

    // ...
}

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

Sleep クラスが偽装されると、発生するはずの「スリープ」に対してアサーションを行うことができます。これを説明するために、実行を 3 回一時停止し、各一時停止が 1 秒ずつ増加するコードをテストしていると想像してみましょう。 assertSequence メソッドを使用すると、テストの高速性を維持しながら、コードが適切な時間「スリープ」したことを確認できます。

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

    // ...

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

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

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

// 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 の時間操作ヘルパを使用して、各スリープの継続時間ごとに時間を瞬時に進めます。

use Carbon\CarbonInterval as Duration;

$this->freezeTime();

Sleep::fake();

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

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

導入 (Introduction)​

利用可能な方法 (Available Methods)​

配列とオブジェクト​

数字​

パス​

URL​

その他​

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

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::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::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)​

app_path()​

base_path()​

config_path()​

database_path()​

lang_path()​

mix()​

public_path()​

resource_path()​

storage_path()​

URL (URLs)​

action()​

asset()​

route()​

導入 (Introduction)

利用可能な方法 (Available Methods)

配列とオブジェクト

数字

パス

URL

その他

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

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

`app_path()`

`base_path()`

`config_path()`

`database_path()`

`lang_path()`

`mix()`

`public_path()`

`resource_path()`

`storage_path()`

URL (URLs)

`action()`

`asset()`

`route()`