ヘルパー（Helpers）

はじめに

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

利用可能なメソッド

配列とオブジェクト

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 last

数値

Number::abbreviate Number::clamp Number::currency Number::fileSize Number::forHumans Number::format Number::ordinal Number::pairs Number::percentage Number::spell Number::trim Number::useLocale Number::withLocale

パス

app_path base_path config_path database_path lang_path mix public_path resource_path storage_path

URL

action asset route secure_asset secure_url to_route url

その他

abort abort_if abort_unless app auth back bcrypt blank broadcast cache class_uses_recursive collect config context cookie csrf_field csrf_token decrypt dd dispatch dispatch_sync dump encrypt env event fake filled info literal logger method_field now old once optional policy redirect report report_if report_unless request rescue resolve response retry session tap throw_if throw_unless today trait_uses_recursive transform validator value view with when

配列とオブジェクト

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;
$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;
$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;
$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' => '',
   ],
   [
   'name' => 'Jane',
   'department' => 'Marketing',
   'email' => '',
   ]
];
$mapped = Arr::mapWithKeys($array, function (array $item, int $key) {
   return [$item['email'] => $item['name']];
});
/*
   [
   '' => 'John',
   '' => '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;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']

Arr::prepend()

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

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;
$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;
$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 = [
   ['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 = [
   ['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 関数を使用して連想サブ配列を再帰的にソートします:

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

Arr::take()

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

$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 コンポーネントの属性バグとクラスをマージする機能や、@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;
$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],
   ],
   ]
*/

デフォルトでは、既存の値は上書きされます。値が存在しない場合にのみ設定したい場合は、関数の第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

数値

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.00
$currency = Number::currency(1000, in: 'EUR');
// €1,000.00
$currency = Number::currency(1000, in: 'EUR', locale: 'de');
// 1.000,00 €

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

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

use Illuminate\Support\Number;
$result = Number::pairs(25, 10);
// [[1, 10], [11, 20], [21, 25]]
$result = Number::pairs(25, 10, offset: 0);
// [[0, 10], [10, 20], [20, 25]]

Number::percentage()

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

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

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

use Illuminate\Support\Number;
$number = Number::trim(12.0);
// 12
$number = Number::trim(12.30);
// 12.3

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

パス

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

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

アセット URL ホストを設定するには、ASSET_URL 変数を .env ファイルに設定します。これは、アセットを 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');

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

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

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

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

secure_asset()

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

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

secure_url()

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

$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 メソッドの第三および第四引数として渡すことができます:

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

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

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('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 関数は、指定された ジョブ をLaravelの ジョブキュー にプッシュします:

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 関数は 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()->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 関数に渡される第2引数は、しばしばEloquentモデルの属性であるため、Laravelでは、old 関数にEloquentモデル全体を第2引数として渡すことができます。そうすることで、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()

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

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 関数は、レスポンス インスタンスを作成するか、レスポンスファクトリのインスタンスを取得します:

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 関数は、セッション 値を取得または設定するために使用できます:

$value = session('key');

キー/値ペアの配列を渡すことで値を設定できます:

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

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

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

tap()

tap 関数は2つの引数を受け入れます: 任意の $value とクロージャ。$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 メソッドは、唯一の引数としてクロージャを受け入れます。オブジェクトインスタンス自体がクロージャに渡され、その後 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