ヘルパー

はじめに

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

利用可能なメソッド

配列とオブジェクト

その他

配列とオブジェクト

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

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

    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メソッドは、配列を反復処理し、各値を指定されたコールバックに渡します。コールバックは、単一のキー/値ペアを含む連想配列を返す必要があります：

    use Illuminate\Support\Arr;

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

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

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

`Arr::only()`

Arr::onlyメソッドは、指定されたキー/値ペアのみを与えられた配列から返します：

    use Illuminate\Support\Arr;

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

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

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

`Arr::pluck()`

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

    use Illuminate\Support\Arr;

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

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

    // ['Taylor', 'Abigail']

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

    use Illuminate\Support\Arr;

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

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

`Arr::prepend()`

Arr::prependメソッドは、アイテムを配列の先頭に追加します：

    use Illuminate\Support\Arr;

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

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

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

必要な場合は、値に使用するキーを指定することができます：

    use Illuminate\Support\Arr;

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

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

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

`Arr::prependKeysWith()`

Arr::prependKeysWithは、連想配列のすべてのキー名を指定された接頭辞で前置します：

    use Illuminate\Support\Arr;

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

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

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

`Arr::pull()`

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

    use Illuminate\Support\Arr;

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

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

    // $name: Desk

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

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

    use Illuminate\Support\Arr;

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

`Arr::query()`

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

    use Illuminate\Support\Arr;

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

    Arr::query($array);

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

`Arr::random()`

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

    use Illuminate\Support\Arr;

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

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

    // 4 - (retrieved randomly)

オプションの第二引数として返すアイテムの数を指定することもできます。この引数を指定すると、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;'
*/

このメソッドは、Bladeコンポーネントの属性バッグとクラスをマージするLaravelの機能を可能にし、@class Bladeディレクティブも可能にします。

`Arr::undot()`

Arr::undotメソッドは、"ドット"表記を使用する単一次元配列を多次元配列に展開します：

    use Illuminate\Support\Arr;

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

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

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

`Arr::where()`

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

    use Illuminate\Support\Arr;

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

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

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

`Arr::whereNotNull()`

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

    use Illuminate\Support\Arr;

    $array = [0, null];

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

    // [0 => 0]

`Arr::wrap()`

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

    use Illuminate\Support\Arr;

    $string = 'Laravel';

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

    // ['Laravel']

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

    use Illuminate\Support\Arr;

    $array = Arr::wrap(null);

    // []

`data_fill()`

data_fill 関数は、ネストされた配列またはオブジェクト内の欠落している値を "ドット" 表記を使用して設定します:

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

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

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

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

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

この関数はワイルドカードとしてアスタリスクを受け入れ、対象を適切に埋めます:

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

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

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

`data_get()`

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

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

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

    // 100

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

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

    // 0

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

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

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

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

{first} と {last} のプレースホルダーを使用して、配列内の最初または最後のアイテムを取得することができます:

    $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 関数は、"ドット" 表記を使用してネストされた配列またはオブジェクト内に値を設定します:

    $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],
            ],
        ]
    */

デフォルトでは、既存の値は上書きされます。存在しない場合にのみ値を設定したい場合は、関数の第四引数に 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 関数は与えられた配列の最後の要素を返します:

    $array = [100, 200, 300];

    $last = last($array);

    // 300

数値

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

URLs

`action()`

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

    use App\Http\Controllers\HomeController;

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

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

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

`asset()`

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

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

.envファイルでASSET_URL変数を設定することで、アセットのURLホストを構成できます。これは、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]);

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

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

`url()`

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

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

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

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

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

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

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

その他

`abort()`

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

    abort(403);

例外メッセージとブラウザに送信されるカスタムHTTPレスポンスヘッダも提供できます：

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

`abort_if()`

abort_if 関数は、与えられたブール式が true に評価される場合にHTTP例外をスローします：

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

abort メソッドと同様に、関数には例外のレスポンステキストを第3引数として、カスタムレスポンスヘッダの配列を第4引数として提供することもできます。

`abort_unless()`

abort_unless 関数は、与えられたブール式が false に評価される場合にHTTP例外をスローします：

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

`app()`

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

    $container = app();

コンテナから解決するためにクラスまたはインターフェース名を渡すことができます：

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

`auth()`

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

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

必要に応じて、アクセスしたいガードインスタンスを指定することができます：

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

`back()`

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

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

    return back();

`bcrypt()`

bcrypt 関数は、Bcryptを使用して与えられた値をハッシュ化します。この関数は、Hash ファサードの代替として使用できます：

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

`blank()`

blank 関数は、与えられた値が「空白」かどうかを判定します：

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

    // true

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

    // false

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

`broadcast()`

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

    broadcast(new UserRegistered($user));

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

`cache()`

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

    $value = cache('key');

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

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

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

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

`class_uses_recursive()`

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

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

`collect()`

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

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

`config()`

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

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

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

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

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

`context()`

context 関数は、現在のコンテキストから値を取得します。コンテキストキーが存在しない場合は、オプションのデフォルト値が返されます：

    $value = context('trace_id');

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

コンテキスト値を設定するには、キー/値のペアの配列を渡すことができます：

    use Illuminate\Support\Str;

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

`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 関数は指定された値を復号化します。この関数は Crypt ファサードの代替として使用できます：

    $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 関数は指定されたジョブを同期キューにプッシュして、即座に処理されるようにします：

    dispatch_sync(new App\Jobs\SendEmails);

`dump()`

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

    dump($value);

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

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

`encrypt()`

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

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

`env()`

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

    $env = env('APP_ENV');

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

警告

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

`event()`

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

    event(new UserRegistered($user));

`fake()`

fake 関数は、コンテナから Faker シングルトンを解決し、モデルファクトリ、データベースシーディング、テスト、プロトタイプビューで偽のデータを作成する際に便利です:

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

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

デフォルトでは、fake 関数は、config/app.php の app.faker_locale 設定オプションを使用します。通常、この設定オプションは APP_FAKER_LOCALE 環境変数を介して設定されます。fake 関数に渡すことで、ロケールを指定することもできます。各ロケールは個別のシングルトンを解決します:

    fake('nl_NL')->name()

`filled()`

filled 関数は、指定された値が "空でない" かどうかを判定します:

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

    // true

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

    // false

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

`info()`

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

    info('Some helpful information!');

関数には、コンテキストデータの配列も渡すことができます:

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

`literal()`

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

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

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

`logger()`

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

    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 関数は、セッションにフラッシュされた古い入力値を取得します:

    $value = old('value');

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

old 関数の第二引数として提供される「デフォルト値」は、Eloquent モデルの属性であることが多いため、Laravel では、old 関数に第二引数として単純に Eloquent モデル全体を渡すことができます。これを行うと、Laravel は、old 関数に提供された最初の引数が「デフォルト値」として考慮されるべき Eloquent 属性の名前であると想定します:

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

    // Is equivalent to...

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

`once()`

once 関数は、指定されたコールバックを実行し、リクエストの間メモリに結果をキャッシュします。同じコールバックで once 関数が複数回呼び出された場合、以前にキャッシュされた結果が返されます:

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

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

once 関数がオブジェクトインスタンス内から実行される場合、キャッシュされた結果はそのオブジェクトインスタンスに固有です:

<?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 関数は任意の引数を受け入れ、そのオブジェクトのプロパティにアクセスしたりメソッドを呼び出すことができます。指定されたオブジェクトが null の場合、プロパティやメソッドはエラーを発生させる代わりに null を返します：

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

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

optional 関数は第二引数としてクロージャを受け入れることもできます。最初の引数として提供された値が null でない場合、そのクロージャが呼び出されます：

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

`policy()`

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

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

`redirect()`

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

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

    return redirect('/home');

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

`report()`

report 関数はあなたの例外ハンドラを使用して例外を報告します：

    report($e);

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

    report('Something went wrong.');

`report_if()`

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

    report_if($shouldReport, $e);

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

`report_unless()`

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

    report_unless($reportingDisabled, $e);

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

`request()`

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

    $request = request();

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

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

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

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

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

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

rescue 関数に report 引数を指定すると、例外が 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 関数の第三引数としてクロージャを渡すことができます:

    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 関数に第四引数としてクロージャを渡すことができます:

    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 メソッドは通常整数を返します。ただし、update メソッド呼び出しを tap 関数を介してチェーンさせることで、メソッドがモデル自体を返すように強制することができます:

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

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

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

`throw_if()`

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

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

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

`throw_unless()`

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

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

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

`today()`

today 関数は、現在の日付の新しい Illuminate\Support\Carbon インスタンスを作成します:

    $today = today();

`trait_uses_recursive()`

trait_uses_recursive 関数は、トレイトで使用されているすべてのトレイトを返します:

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

`transform()`

transform 関数は、値が空でない場合に、クロージャを実行し、そのクロージャの戻り値を返します:

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

    $result = transform(5, $callback);

    // 10

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

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

    // The value is blank

`validator()`

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

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

`value()`

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

    $result = value(true);

    // true

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

    // false

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

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

    // 'Taylor'

`view()`

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

    return view('auth.login');

`with()`

with 関数は、与えられた値を返します。関数の第二引数としてクロージャを渡すと、そのクロージャが実行され、その戻り値が返されます:

    $callback = function (mixed $value) {
        return is_numeric($value) ? $value * 2 : 0;
    };

    $result = with(5, $callback);

    // 10

    $result = with(null, $callback);

    // 0

    $result = with(5, null);

    // 5

その他のユーティリティ

ベンチマーク

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

    <?php

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

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

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

デフォルトでは、指定されたコールバックは一度だけ（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 の機能と組み合わせることができます。たとえば、例外ハンドラに遅いクエリの一部のみを報告したい場合があります。そして、ロトクラスは呼び出し可能なので、クラスのインスタンスを受け入れる任意のメソッドにクラスのインスタンスを渡すことができます：

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

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

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

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

Sleep

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

Testing Sleep

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

    $waiting = /* ... */;

    $seconds = 1;

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

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

通常、このコードをテストすると、少なくとも1秒かかります。幸いにも、Sleepクラスを使用すると、テストスイートが速く保たれるように「仮想」スリープを行うことができます。

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

    // ...
});

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

    // ...
}

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

Sleep クラスを偽装した後は、予想される「スリープ」が発生したかどうかに対してアサーションを行うことが可能です。これを示すために、各一時停止が1秒ずつ増加するコードをテストしていると想像してみましょう。assertSequence メソッドを使用して、コードが適切な時間だけ「スリープ」したことをアサートすることができます。これにより、テストを高速に保ちながら、コードが適切な時間だけ「スリープ」したことを確認できます。

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 クラスには、テスト時に使用できるさまざまな他のアサーションが用意されています。

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

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

Sleep::fake(syncWithCarbon: true);

$start = now();

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

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

Laravel は、実行を一時停止する場合に内部で Sleep クラスを使用します。たとえば、retry ヘルパーは、スリープ時に Sleep クラスを使用しており、そのヘルパーを使用する際のテスト性を向上させることができます。

ヘルパー

はじめに​

利用可能なメソッド​

配列とオブジェクト​

数値​

パス​

URL​

その他​

配列とオブジェクト​

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

Arr::toCssClasses()​

Arr::toCssStyles()​

Arr::undot()​

Arr::where()​

Arr::whereNotNull()​

Arr::wrap()​

data_fill()​

data_get()​

data_set()​

data_forget()​

head()​

数値​

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

URLs​

action()​

asset()​

はじめに

利用可能なメソッド

配列とオブジェクト

数値

パス

URL

その他

配列とオブジェクト

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

`Arr::toCssClasses()`

`Arr::toCssStyles()`

`Arr::undot()`

`Arr::where()`

`Arr::whereNotNull()`

`Arr::wrap()`

`data_fill()`

`data_get()`

`data_set()`

`data_forget()`

`head()`

数値

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

URLs

`action()`

`asset()`

`route()`