ヘルパ

イントロダクション
使用可能な関数

イントロダクション

Laravelは様々な、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。

使用可能な関数

配列とオブジェクト

パス

app_path base_path config_path database_path mix public_path resource_path storage_path

文字列

URL

action asset secure_asset route secure_url url

その他

メソッド一覧

配列とオブジェクト

`array_add()` {#collection-method .first-collection-method}

array_add関数は指定されたキー／値のペアをそのキーが存在していない場合、配列に追加します。

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

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

`array_collapse()`

array_collapse関数は配列の配列を一次元の配列へ展開します。

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

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

`array_divide()`

array_divide関数は２つの配列をリターンします。一つは指定した配列のキー、もう一方は値です。

list($keys, $values) = array_divide(['name' => 'Desk']);

// $keys: ['name']

// $values: ['Desk']

`array_dot()`

array_dot関数は多次元配列を「ドット」記法で深さを表した一次元配列に変換します。

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

$flattened = array_dot($array);

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

`array_except()`

array_except関数は指定されたキー／値ペアを配列から削除します。

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

$filtered = array_except($array, ['price']);

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

`array_first()`

array_first関数は指定されたテストにパスした最初の要素を返します。

$array = [100, 200, 300];

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

// 200

デフォルト値を３つ目の引数で指定することもできます。この値はテストでどの値もテストにパスしない場合に返されます。

$first = array_first($array, $callback, $default);

`array_flatten()`

array_flatten関数は、多次元配列を一次元配列へ変換します。

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

$flattened = array_flatten($array);

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

`array_forget()`

array_forget関数は「ドット記法」で指定されたキーと値のペアを深くネストされた配列から取り除きます。

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

array_forget($array, 'products.desk');

// ['products' => []]

`array_get()`

array_get関数は指定された値を「ドット」記法で指定された値を深くネストされた配列から取得します。

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

$price = array_get($array, 'products.desk.price');

// 100

array_get関数は、指定したキーが存在しない場合に返されるデフォルト値を指定できます。

$discount = array_get($array, 'products.desk.discount', 0);

// 0

`array_has()`

array_has関数は、「ドット」記法で指定されたアイテムが配列に存在するかをチェックします。

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

$contains = array_has($array, 'product.name');

// true

$contains = array_has($array, ['product.price', 'product.discount']);

// false

`array_last()`

array_last関数は、テストでパスした最後の配列要素を返します。

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

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

// 300

メソッドの第３引数には、デフォルト値を渡します。テストでパスする値がない場合に、返されます。

$last = array_last($array, $callback, $default);

`array_only()`

array_only関数は配列中の指定されたキー／値ペアのアイテムのみを返します。

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

$slice = array_only($array, ['name', 'price']);

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

`array_pluck()`

array_pluck関数は配列中の指定キーに対する値を全て取得します。

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

$names = array_pluck($array, 'developer.name');

// ['Taylor', 'Abigail']

さらに、結果のリストのキー項目も指定できます。

$names = array_pluck($array, 'developer.name', 'developer.id');

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

`array_prepend()`

array_prepend関数は配列の先頭にアイテムを追加します。

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

$array = array_prepend($array, 'zero');

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

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

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

$array = array_prepend($array, 'Desk', 'name');

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

`array_pull()`

array_pull関数は配列から指定されたキー／値ペアを取得し、同時に削除します。

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

$name = array_pull($array, 'name');

// $name: Desk

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

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

$value = array_pull($array, $key, $default);

`array_random()`

array_random関数は配列からランダムに値を返します。

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

$random = array_random($array);

// 4 - (ランダムに取得された値)

第２引数として、返すアイテム数を任意に指定することもできます。この引数を指定した場合、たとえ一つだけ取得したいときでも配列で返されることに注意してください。

$items = array_random($array, 2);

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

`array_set()`

array_set関数は「ドット」記法を使用し、深くネストした配列に値をセットします。

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

array_set($array, 'products.desk.price', 200);

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

`array_sort()`

array_sort関数は、配列の値に基づきソートします。

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

$sorted = array_sort($array);

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

指定したクロージャの結果に基づき、ソートすることもできます。

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

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

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

`array_sort_recursive()`

array_sort_recursive関数はsort機能を使い配列を再帰的にソートします。

$array = [
    ['Roman', 'Taylor', 'Li'],
    ['PHP', 'Ruby', 'JavaScript'],
];

$sorted = array_sort_recursive($array);

/*
    [
        ['Li', 'Roman', 'Taylor'],
        ['JavaScript', 'PHP', 'Ruby'],
    ]
*/

`array_where()`

array_whereは指定されたクロージャで、配列をフィルタリングします。

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

$filtered = array_where($array, function ($value, $key) {
    return is_string($value);
});

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

`array_wrap()`

array_wrap関数は、指定した値を配列中にラップします。指定した値が配列中に存在している場合は、変更されません。

$string = 'Laravel';

$array = array_wrap($string);

// ['Laravel']

`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_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, false);

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

`head()`

head関数は、配列の最初の要素を返します。

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

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

$array = [100, 200, 300];

$last = last($array);

// 300

パス

`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ディレクトリの完全パスを返します。さらに、アプリケーションの設定ディレクトリ中の指定ファイルへの完全パスを生成することもできます。

$path = config_path();

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

`database_path()`

database_path関数は、databaseディレクトリの完全パスを返します。さらに、データベースディレクトリ中の指定ファイルへの完全パスを生成することもできます。

$path = database_path();

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

`mix()`

mix関数は、バージョンつけしたMixファイルのパスを取得します。

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

`public_path()`

public_path関数は、publicディレクトリの完全パスを返します。さらに、publicディレクトリ中の指定ファイルへの完全パスを生成することもできます。

$path = public_path();

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

`resource_path()`

resource_path関数は、resourcesディレクトリの完全パスを返します。さらに、リソースディレクトリ中の指定ファイルへの完全パスを生成することもできます。

$path = resource_path();

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

`storage_path()`

storage_path関数は、storageディレクトリの完全パスを返します。さらに、ストレージディレクトリ中の指定ファイルへの完全パスを生成することもできます。

$path = storage_path();

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

文字列

`__()`

__関数は、指定した翻訳文字列か翻訳キーをローカリゼーションファイルを使用し、翻訳します。

echo __('Welcome to our application');

echo __('messages.welcome');

指定した翻訳文字列や翻訳キーが存在しない場合、__関数は指定した値をそのまま返します。たとえば、上記の場合に翻訳キーが存在しなければ、__関数はmessages.welcomeを返します。

`camel_case()`

camel_case関数は、文字列をキャメルケース（２つ目以降の単語の先頭は大文字）へ変換します。

$converted = camel_case('foo_bar');

// fooBar

`class_basename()`

class_basename関数は指定されたクラス名から名前空間を除いた、クラス名だけを取得します。

$class = class_basename('Foo\Bar\Baz');

// Baz

`e()`

e関数は、PHPのhtmlspecialchars関数をdouble_encodeオプションにfalseを指定し、実行します。

echo e('<html>foo</html>');

// &lt;html&gt;foo&lt;/html&gt;

`ends_with()`

ends_with関数は、最初の文字列が２つ目の引数の文字列で終わっているか調べます。

$result = ends_with('This is my name', 'name');

// true

`kebab_case()`

kebab_case関数は、指定した文字列を「ケバブ-ケース」に変換します。

$converted = kebab_case('fooBar');

// foo-bar

`preg_replace_array()`

preg_replace_array関数は、指定したパターンを順番に配列中の値に置き換えます。

$string = 'The event will take place between :start and :end';

$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

`snake_case()`

snake_case関数は文字列をスネークケース（小文字名下線区切り）に変換します。

$converted = snake_case('fooBar');

// foo_bar

`starts_with()`

starts_with関数は指定した文字列が、２番めの文字列で始まっているか調べます。

$result = starts_with('This is my name', 'This');

// true

`str_after()`

str_after関数は、指定した値に続く文字列を全て返します。

$slice = str_after('This is my name', 'This is');

// ' my name'

`str_before()`

str_before関数は、文字列中の指定した値より前の文字列を全部返します。

$slice = str_before('This is my name', 'my name');

// 'This is '

`str_contains()`

str_contains関数は指定した文字列が、２つ目の文字列を含んでいるか調べます。

$contains = str_contains('This is my name', 'my');

// true

指定した文字列に値のどれかが含まれているかを判定するために、値の配列を渡すことも可能です。

$contains = str_contains('This is my name', ['my', 'foo']);

// true

`str_finish()`

str_finish関数は指定した文字列の最後が、２つ目の引数の値で終了していない場合、その値を追加します。

$adjusted = str_finish('this/string', '/');

// this/string/

$adjusted = str_finish('this/string/', '/');

// this/string/

`str_is()`

str_is関数は指定した文字列がパターンに一致しているかを判定します。アスタリスクが使用されるとワイルドカードとして利用されます。

$matches = str_is('foo*', 'foobar');

// true

$matches = str_is('baz*', 'foobar');

// false

`str_limit()`

str_limit関数は、指定した長さへ文字列を切り詰めます。

$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20);

// The quick brown fox...

また、第３引数として、最長文字列数を超えた場合に末尾へ追加する、文字列を渡すこともできます。

$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');

// The quick brown fox (...)

`str_plural()`

str_plural関数は単数形を複数形へ変換します。この関数は現在英語のみサポートしています。

$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

整数をこの関数の第２引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。

$plural = str_plural('child', 2);

// children

$plural = str_plural('child', 1);

// child

`str_random()`

str_random関数は指定された長さのランダムな文字列を生成します。この関数は、PHPのrandom_bytes関数を使用します。

$random = str_random(40);

`str_replace_array()`

str_replace_array関数は配列を使い、文字列を指定値へ順番に置き換えます。

$string = 'The event will take place between ? and ?';

$replaced = str_replace_array('?', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

`str_replace_first()`

str_replace_first関数は、文字列中で最初に出現した値を指定値で置き換えます。

$replaced = str_replace_first('the', 'a', 'the quick brown fox jumps over the lazy dog');

// a quick brown fox jumps over the lazy dog

`str_replace_last()`

str_replace_last関数は、文字列中で最後に出現した値を指定値で置き換えます。

$replaced = str_replace_last('the', 'a', 'the quick brown fox jumps over the lazy dog');

// the quick brown fox jumps over a lazy dog

`str_singular()`

str_singular関数は複数形を単数形へ変換します。この関数は、現在英語のみサポートしています。

$singular = str_singular('cars');

// car

$singular = str_singular('children');

// child

`str_slug()`

str_slug関数は指定された文字列から、URLフレンドリーな「スラグ」を生成します。

$slug = str_slug('Laravel 5 Framework', '-');

// laravel-5-framework

`str_start()`

str_start関数は文字列が指定値から始まっていない場合、先頭にその文字列を追加します。

$adjusted = str_start('this/string', '/');

// /this/string

$adjusted = str_start('/this/string/', '/');

// /this/string

`studly_case()`

studly_case関数は文字列をアッパーキャメルケース（単語の頭文字を大文字）に変換します。

$converted = studly_case('foo_bar');

// FooBar

`title_case()`

title_case関数は、指定された文字列を「タイトルケース」へ変換します。

$converted = title_case('a nice title uses the correct case');

// A Nice Title Uses The Correct Case

`trans()`

trans関数は、指定した翻訳キーをローカリゼーションファイルを使用し翻訳します。

echo trans('messages.welcome');

指定した翻訳キーが存在しない場合、trans関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcomeが返ります。

`trans_choice()`

trans_choice関数は、指定した指定値を数値を元に翻訳します。

echo trans_choice('messages.notifications', $unreadCount);

指定した翻訳キーが存在しない場合、trans_choice関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcomeが返ります。

URL

`action()`

action関数は、指定されたコントローラアクションのURLを生成します。完全修飾コントローラ名は必要ありません。代わりに、App\Http\Controllers名前空間からの相対クラス名を指定してください。

$url = action('HomeController@index');

メソッドがルートパラメーターを受け付ける場合は、第２引数で指定してください。

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

`asset()`

asset関数は、現在のリクエストのスキーマ(HTTPかHTTPS)を使い、アセットへのURLを生成します。

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

`secure_asset()`

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

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

`route()`

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

$url = route('routeName');

ルートにパラメーターを受け付ける場合は第２引数で指定します

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

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

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

`secure_url()`

secure_url関数は、指定したパスへの完全なHTTPS URLを生成します。

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

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

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

例外のレスポンステキストと、カスタムヘッダを指定することもできます。

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

`abort_if()`

abort_if関数は、指定された論理値がtrueと評価された場合に、HTTP例外を投げます。

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

abortメソッドと同様に、例外のレスポンステキストを第３引数に、カスタムレスポンスヘッダを第４引数に指定することもできます。

`abort_unless()`

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

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

abortメソッドと同様に、例外のレスポンステキストを第３引数に、カスタムレスポンスヘッダを第４引数に指定することもできます。

`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 = false);

return back();

`bcrypt()`

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

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

`broadcast()`

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

broadcast(new UserRegistered($user));

`blank()`

blank関数は指定値が”blank”であるかどうかを返します。

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

// true

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

// false

blankの逆の動作は、filledメソッドです。

`cache()`

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

$value = cache('key');

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

関数にキー／値ペアの配列を渡すと、アイテムをキャッシュへ追加します。さらに分数、もしくはキャッシュ値が有効であると推定される期限を渡すこともできます。

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

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

`class_uses_recursive()`

class_uses_recursive関数は、全サブクラスで使われているものも含め、クラス中で使用されているトレイトを全て返します。

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

`collect()`

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

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

`config()`

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

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

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

キー／値ペアの配列を渡すことにより、実行時に設定変数をセットできます。

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

`cookie()`

cookie関数は新しいクッキーインスタンスを生成します。

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

`csrf_field()`

csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。

`csrf_token()`

csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。

$token = csrf_token();

`dd()`

dd関数は指定された変数の内容を表示し、スクリプトの実行を停止します。

dd($value);

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

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

`decrypt()`

decrypt関数は、指定値をLaravelの暗号化機能を用い、復号します。

$decrypted = decrypt($encrypted_value);

`dispatch()`

dispatch関数は、指定したジョブをLaravelのジョブキューへ投入します。

dispatch(new App\Jobs\SendEmails);

`dispatch_now()`

dispatch_now関数は、指定したジョブを即時に実行し、handleメソッドからの値を返します。

$result = dispatch_now(new App\Jobs\SendEmails);

`dump()`

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

dump($value);

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

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

`encrypt()`

encrypt関数は、Laravelの暗号化機能を用い、指定値を暗号化します。

$encrypted = encrypt($unencrypted_value);

`env()`

env関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。

$env = env('APP_ENV');

// APP_ENVがセットされていない場合、'production'が返る
$env = env('APP_ENV', 'production');

`event()`

event関数は指定したイベントをリスナに対して発行します

event(new UserRegistered($user));

`factory()`

factory関数は指定したクラス、名前、個数のモデルファクトリビルダを生成します。これはテストやシーディング（DB初期値設定）で使用できます。

$user = factory(App\User::class)->make();

`filled()`

filled関数は、指定値が”blank”であるかどうかを返します。

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

// true

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

// false

filledの逆の動作は、blankメソッドです。

`info()`

info関数はログへ情報(information)を書き出します。

info('Some helpful information!');

関連情報の配列を関数へ渡すこともできます。

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

`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動詞の見せかけの値を保持する「隠し」HTTP入力フィールドを生成します。Blade記法を使う例です。

<form method="POST">
    
</form>

`now()`

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

$now = now();

`old()`

old関数はセッションにフラッシュデーターとして保存されている直前の入力値を取得します。

$value = old('value');

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

`optional()`

optional関数は、どんな引数も指定でき、そのオブジェクトのプロパティへアクセスしたり、メソッドを呼び出したりできます。オブジェクトがnullの場合、プロパティとメソッドはエラーを発生させる代わりに、シンプルにnullを返します。

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

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

`policy()`

policy関数は、指定クラスのポリシーインスタンスを取得します。

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

`redirect()`

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

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

return redirect('/home');

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

`report()`

report関数は、例外ハンドラのreportメソッドを利用し、例外をレポートします。

report($e);

`request()`

request関数は現在のリクエストインスタンスを返すか、入力アイテムを取得します。

$request = request();

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

`rescue()`

rescue関数は指定されたクロージャを実行し、実行時に発生する例外をキャッチします。キャッチされた例外は、すべて例外ハンドラのreportメソッドに送られます。しかし、リクエストは引き続き処理されます。

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

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

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

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

`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 () {
    // 実行間で500ms空け、５回試行する
}, 100);

`session()`

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

$value = session('key');

キー／値ペアの配列を渡し、値を設定することができます。

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

関数に引数を渡さない場合は、セッション保存域が返されます。

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

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

`tap()`

tap関数は引数を２つ取ります。アビリティの$valueとクロージャです。$valueはクロージャに渡され、それからtap関数により返されます。クロージャから返す値は無視されます。

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

    $user->save();
});

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

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

`today()`

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

$today = today();

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

`trait_uses_recursive()`

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

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

`transform()`

transform関数は、指定値がblankでない場合に指定値を「クロージャ」で実行し、実行結果を返します。

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

$result = transform(5, $callback);

// 10

デフォルト値か「クロージャ」を第３引数として渡すこともできます。この値は指定値がblankの場合に返されます。

$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

`view()`

view関数はviewインスタンスを返します。

return view('auth.login');

`with()`

with関数は指定値を返します。「クロージャ」を第２引数へ渡した場合は実行し、結果を返します。

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

$result = with(5, $callback);

// 10

$result = with(null, $callback);

// 0

$result = with(5, null);

// 5

ヘルパ

イントロダクション

使用可能な関数

配列とオブジェクト

パス

文字列

URL

その他

メソッド一覧

配列とオブジェクト

array_add() {#collection-method .first-collection-method}

array_collapse()

array_divide()

array_dot()

array_except()

array_first()

array_flatten()

array_forget()

array_get()

array_has()

array_last()

array_only()

array_pluck()

array_prepend()

array_pull()

array_random()

array_set()

array_sort()

array_sort_recursive()

array_where()

array_wrap()

data_fill()

data_get()

data_set()

head()

last()

パス

app_path()

base_path()

config_path()

database_path()

mix()

public_path()

resource_path()

storage_path()

文字列

__()

camel_case()

class_basename()

e()

ends_with()

kebab_case()

preg_replace_array()

snake_case()

starts_with()

str_after()

str_before()

str_contains()

str_finish()

str_is()

str_limit()

str_plural()

str_random()

str_replace_array()

str_replace_first()

str_replace_last()

str_singular()

str_slug()

str_start()

studly_case()

title_case()

trans()

trans_choice()

URL

action()

asset()

secure_asset()

route()

secure_url()

url()

`array_add()` {#collection-method .first-collection-method}

`array_collapse()`

`array_divide()`

`array_dot()`

`array_except()`

`array_first()`

`array_flatten()`

`array_forget()`

`array_get()`

`array_has()`

`array_last()`

`array_only()`

`array_pluck()`

`array_prepend()`

`array_pull()`

`array_random()`

`array_set()`

`array_sort()`

`array_sort_recursive()`

`array_where()`

`array_wrap()`

`data_fill()`

`data_get()`

`data_set()`

`head()`

`last()`

`app_path()`

`base_path()`

`config_path()`

`database_path()`

`mix()`

`public_path()`

`resource_path()`

`storage_path()`

`__()`

`camel_case()`

`class_basename()`

`e()`

`ends_with()`

`kebab_case()`

`preg_replace_array()`

`snake_case()`

`starts_with()`

`str_after()`

`str_before()`

`str_contains()`

`str_finish()`

`str_is()`

`str_limit()`

`str_plural()`

`str_random()`

`str_replace_array()`

`str_replace_first()`

`str_replace_last()`

`str_singular()`

`str_slug()`

`str_start()`

`studly_case()`

`title_case()`

`trans()`

`trans_choice()`

`action()`

`asset()`

`secure_asset()`

`route()`

`secure_url()`

`url()`

`abort()`

`abort_if()`

`abort_unless()`

`app()`

`auth()`

`back()`

`bcrypt()`

`broadcast()`

`blank()`

`cache()`

`class_uses_recursive()`

`collect()`

`config()`