ヘルパ関数 5.3 Laravel

イントロダクション

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

使用可能な関数

配列

メソッド一覧

配列

`array_add()`

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 = array_dot(['foo' => ['bar' => 'baz']]);

// ['foo.bar' => 'baz'];

`array_except()`

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

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

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

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

`array_first()`

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

$array = [100, 200, 300];

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

// 200

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

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

`array_flatten()`

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

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

$array = 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]]];

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

// ['price' => 100]

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

$value = array_get($array, 'names.john', 'default');

`array_has()`

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

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

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

// true

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

// false

`array_last()`

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

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

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

// 300

`array_only()`

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

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

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

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

`array_pluck()`

array_pluck関数は配列から指定されたキー／値ペアのリストを取得します。

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

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

// ['Taylor', 'Abigail'];

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

$array = 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');

// $array: ['zero', 'one', 'two', 'three', 'four']

`array_pull()`

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

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

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

// $name: Desk

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

`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 = [
    ['name' => 'Desk'],
    ['name' => 'Chair'],
];

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

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

`array_sort_recursive()`

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

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

$array = array_sort_recursive($array);

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

`array_where()`

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

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

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

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

`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関数はアプリケーション設定ディレクトリの完全パスを返します。

$path = config_path();

`database_path()`

database_path関数はアプリケーションデータベースディレクトリへの完全パスを返します。

$path = database_path();

`elixir()`

elixir関数は、バージョン付けされたElixirファイルのパスを取得します。

elixir($file);

`public_path()`

public_path関数は、publicディレクトリの完全パスを返します。

$path = public_path();

`resource_path()`

resource_path関数は、resourceディレクトリの完全パスを返します。保存ディレクトリからの相対パスをresource_path関数に指定することで、完全パスを生成することもできます。

$path = resource_path();

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

`storage_path()`

storage_path関数は、storageディレクトリの完全パスを返します。また、storage_path関数は、指定されたstorageディレクトリからの相対ファイルパスから、完全パスを生成します。

$path = storage_path();

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

文字列

`camel_case()`

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

$camel = camel_case('foo_bar');

// fooBar

`class_basename()`

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

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

// Baz

`e()`

e関数は指定された文字列にhtmlspecialcharsを実行します。

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

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

`ends_with()`

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

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

// true

`snake_case()`

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

$snake = snake_case('fooBar');

// foo_bar

`str_limit()`

str_limit関数は文字列を文字数へ短くします。最初の引数に文字列を受付、最終的な文字列の最大文字数が第２引数です。

$value = str_limit('The PHP framework for web artisans.', 7);

// The PHP...

`starts_with()`

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

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

// true

`str_contains()`

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

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

// true

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

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

// true

`str_finish()`

str_finish関数は指定された文字列の最後に２つ目の文字列を一つだけ付けます。

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

// this/string/

`str_is()`

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

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

// true

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

// false

`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関数を使用します。

$string = str_random(40);

`str_singular()`

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

$singular = str_singular('cars');

// car

`str_slug()`

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

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

// laravel-5-framework

`studly_case()`

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

$value = studly_case('foo_bar');

// FooBar

`title_case()`

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

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

// A Nice Title Uses The Correct Case

`trans()`

trans関数は指定した言語行を言語ファイルを使用して翻訳します。

echo trans('validation.required'):

`trans_choice()`

trans_choice関数は指定された言語行を数値をもとに翻訳します。Lang::choiceのエイリアスです。

$value = trans_choice('foo.bar', $count);

URL

`action()`

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

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

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

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

`asset()`

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

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

`secure_asset()`

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

echo secure_asset('foo/bar.zip', $title, $attributes = []);

`route()`

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

$url = route('routeName');

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

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

`secure_url()`

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

echo secure_url('user/profile');

echo secure_url('user/profile', [1]);

`url()`

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

echo url('user/profile');

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

パスを指定しない場合は、Illuminate\Routing\UrlGeneratorインスタンスを返します。

echo url()->current();
echo url()->full();
echo url()->previous();

その他

`abort()`

abort関数は、例外ハンドラによりレンダーされるであろう、HTTP例外を投げます。

abort(401);

例外のレスポンステキストを指定することもできます。

abort(401, 'Unauthorized.');

`abort_if()`

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

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

`abort_unless()`

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

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

`auth()`

auth関数はAuthenticatorインスタンスを返します。Authファサードの代わりに便利に使用できます。

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

`back()`

back関数はユーザの直前のロケーションへのリダイレクトレスポンスを生成します。

return back();

`bcrypt()`

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

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

`cache()`

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

$value = cache('key');

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

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

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

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

`collect()`

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

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

`config()`

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

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

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

configヘルパにキー／値ペアの配列を渡せば、実行時の設定変数をセットすることもできます。

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

`csrf_field()`

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

{{ csrf_field() }}

`csrf_token()`

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

$token = csrf_token();

`dd()`

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

dd($value);

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

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

dump($value);

`dispatch()`

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

dispatch(new App\Jobs\SendEmails);

`env()`

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

$env = env('APP_ENV');

// 変数が存在しない場合にデフォルト値を返す
$env = env('APP_ENV', 'production');

`event()`

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

event(new UserRegistered($user));

`factory()`

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

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

`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">
    {{ method_field('DELETE') }}
</form>

`old()`

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

$value = old('value');

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

`redirect()`

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

return redirect('/home');

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

`request()`

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

$request = request();

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

`response()`

response関数はresponseインスタンスを返すか、レスポンスファクトリのインスタンスを取得します。

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

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

`session()`

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

$value = session('key');

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

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

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

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

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

`value()`

value関数は値が指定された場合は、シンプルにその値を返します。しかし「クロージャ」が関数に渡されると、そのクロージャを実行し結果を返します。

$value = value(function () {
    return 'bar';
});

`view()`

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

return view('auth.login');

Laravel 5.3 ヘルパ関数

イントロダクション

使用可能な関数

配列

パス

文字列

URL

その他

メソッド一覧

配列

array_add()

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

array_sort()

array_sort_recursive()

array_where()

head()

last()

パス

app_path()

base_path()

config_path()

database_path()

elixir()

public_path()

resource_path()

storage_path()

文字列

camel_case()

class_basename()

e()

ends_with()

snake_case()

str_limit()

starts_with()

str_contains()

str_finish()

str_is()

str_plural()

str_random()

str_singular()

str_slug()

studly_case()

title_case()

trans()

trans_choice()

URL

action()

asset()

secure_asset()

route()

secure_url()

url()

その他

abort()

abort_if()

abort_unless()

auth()

back()

bcrypt()

cache()

collect()

config()

csrf_field()

csrf_token()

dd()

dispatch()