Laravel 5.1 ヘルパ関数

イントロダクションIntroduction

Laravelは様々な「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。Laravel includes a variety of "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.

使用可能な関数Available Methods

配列Arrays

パスPaths

文字列Strings

URLURLs

その他Miscellaneous

メソッド一覧Method Listing

配列Arrays

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

array_add関数は指定されたキー／値のペアをそのキーが存在していない場合、配列に追加します。The array_add function adds a given key / value pair to the array if the given key doesn't already exist in the array:

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

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

array_collapse() {#collection-method}array_collapse() {#collection-method}

array_collapse関数は配列の配列を一次元の配列へ展開します。The array_collapse function collapse an array of arrays into a single array:

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

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

array_divide() {#collection-method}array_divide() {#collection-method}

array_divide関数は２つの配列をリターンします。一つはオリジナル配列のキー、もう一方は値です。The array_divide function returns two arrays, one containing the keys, and the other containing the values of the original array:

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

// $keys: ['name']

// $values: ['Desk']

array_dot() {#collection-method}array_dot() {#collection-method}

array_dot関数は多次元配列を「ドット」記法で深さを表した一次元配列に変換します。The array_dot function flattens a multi-dimensional array into a single level array that uses "dot" notation to indicate depth:

$array = array_dot(['foo' => ['bar' => 'baz']]);

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

array_except() {#collection-method}array_except() {#collection-method}

array_except関数は指定されたキー／値ペアを配列から削除します。The array_except function removes the given key / value pairs from the array:

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

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

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

array_first() {#collection-method}array_first() {#collection-method}

array_first関数は指定されたテストにパスした最初の要素を返します。The array_first function returns the first element of an array passing a given truth test:

$array = [100, 200, 300];

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

// 200

デフォルト値を３つ目の引数で指定することもできます。この値はテストでどの値もテストにパスしない場合に返されます。A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:

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

array_flatten() {#collection-method}array_flatten() {#collection-method}

array_flatten関数は、多次元配列を一次元配列へ変換します。The array_flatten function will flatten a multi-dimensional array into a single level.

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

$array = array_flatten($array);

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

array_forget() {#collection-method}array_forget() {#collection-method}

array_forget関数は「ドット記法」で指定されたキーと値のペアを深くネストされた配列から取り除きます。The array_forget function removes a given key / value pair from a deeply nested array using "dot" notation:

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

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

// ['products' => []]

array_get() {#collection-method}array_get() {#collection-method}

array_get関数は指定された値を「ドット」記法で指定された値を深くネストされた配列から取得します。The array_get function retrieves a value from a deeply nested array using "dot" notation:

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

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

// ['price' => 100]

　array_get関数は、指定したキーが存在しない場合に返されるデフォルト値を指定できます。The array_get function also accepts a default value, which will be returned if the specific key is not found:

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

array_has() {#collection-method}array_has() {#collection-method}

array_has関数は、「ドット」記法で指定されたアイテムの存在をチェックします。The array_has function checks that a given item exists in an array using "dot" notation:

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

$hasDesk = array_has($array, 'products.desk');

// true

array_only() {#collection-method}array_only() {#collection-method}

array_only関数は配列中の指定されたキー／値ペアのアイテムのみを返します。The array_only function will return only the specified key / value pairs from the given array:

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

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

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

array_pluck() {#collection-method}array_pluck() {#collection-method}

array_pluck関数は配列から指定されたキー／値ペアのリストを取得します。The array_pluck function will pluck a list of the given key / value pairs from the array:

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

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

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

さらに、結果のリストのキー項目も指定できます。You may also specify how you wish the resulting list to be keyed:

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

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

array_pull() {#collection-method}array_pull() {#collection-method}

array_pull関数は配列から指定されたキー／値ペアを取得し、同時に削除します。The array_pull function returns and removes a key / value pair from the array:

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

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

// $name: Desk

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

array_set() {#collection-method}array_set() {#collection-method}

array_set関数は「ドット」記法を使用し、深くネストした配列に値をセットします。The array_set function sets a value within a deeply nested array using "dot" notation:

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

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

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

array_sort() {#collection-method}array_sort() {#collection-method}

array_sort関数は指定されたクロージャーの実行結果に基づき、配列をソートします。The array_sort function sorts the array by the results of the given Closure:

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

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

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

array_sort_recursive() {#collection-method}array_sort_recursive() {#collection-method}

array_sort_recursive関数はsort機能を使い配列を再帰的にソートします。The array_sort_recursive function recursively sorts the array using the sort function:

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

$array = array_sort_recursive($array);

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

array_where() {#collection-method}array_where() {#collection-method}

array_whereは指定されたクロージャーで、配列をフィルタリングします。The array_where function filters the array using the given Closure:

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

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

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

head() {#collection-method}head() {#collection-method}

head関数はシンプルに配列の最初の要素を返します。The head function simply returns the first element in the given array:

$array = [100, 200, 300];

$first = head($array);

// 100

last() {#collection-method}last() {#collection-method}

last関数は指定した配列の最後の要素を返します。The last function returns the last element in the given array:

$array = [100, 200, 300];

$last = last($array);

// 300

パスPaths

app_path() {#collection-method}app_path() {#collection-method}

app_path関数はappディレクトリーへの完全パスを取得します。The app_path function returns the fully qualified path to the app directory:

$path = app_path();

app_path関数はさらに指定されたアプリケーションディレクトリーからの相対パスから絶対パスを生成します。You may also use the app_path function to generate a fully qualified path to a given file relative to the application directory:

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

base_path() {#collection-method}base_path() {#collection-method}

base_path関数はプロジェクトルートの完全パスを返します。The base_path function returns the fully qualified path to the project root:

$path = base_path();

base_path関数はさらに指定されたプロジェクトルートディレクトリーからの相対パスから絶対パスを生成します。You may also use the base_path function to generate a fully qualified path to a given file relative to the application directory:

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

config_path() {#collection-method}config_path() {#collection-method}

config_path関数はアプリケーション設定ディレクトリーの完全パスを返します。The config_path function returns the fully qualified path to the application configuration directory:

$path = config_path();

database_path() {#collection-method}database_path() {#collection-method}

database_path関数はアプリケーションデータベースディレクトリーへの完全パスを返します。The database_path function returns the fully qualified path to the application's database directory:

$path = database_path();

elixir() {#collection-method}elixir() {#collection-method}

elixir関数はバージョン付けされたElixirファイルのパスを取得します。The elixir function gets the path to the versioned Elixir[/docs/{{version}}/elixir] file:

elixir($file);

public_path() {#collection-method}public_path() {#collection-method}

public_path関数はpublicディレクトリーの完全パスを返します。The public_path function returns the fully qualified path to the public directory:

$path = public_path();

storage_path() {#collection-method}storage_path() {#collection-method}

storage_path関数はstorageディレクトリーの完全パスを返します。The storage_path function returns the fully qualified path to the storage directory:

$path = storage_path();

storage_path関数は指定されたstorageディレクトリーからの相対ファイルパスから完全パスを生成します。You may also use the storage_path function to generate a fully qualified path to a given file relative to the storage directory:

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

文字列Strings

camel_case() {#collection-method}camel_case() {#collection-method}

camel_case関数は文字列をキャメルケース（２つ目以降の単語の先頭は大文字）へ変換します。The camel_case function converts the given string to camelCase:

$camel = camel_case('foo_bar');

// fooBar

class_basename() {#collection-method}class_basename() {#collection-method}

class_basename関数は指定されたクラス名から名前空間を除いた、クラス名だけを取得します。The class_basename returns the class name of the given class with the class' namespace removed:

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

// Baz

e() {#collection-method}e() {#collection-method}

e関数は指定された文字列にhtmlentitesを実行します。The e function runs htmlentities over the given string:

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

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

ends_with() {#collection-method}ends_with() {#collection-method}

ends_with関数は、最初の文字列が２つ目の引数の文字列で終わっているか調べます。The ends_with function determines if the given string ends with the given value:

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

// true

snake_case() {#collection-method}snake_case() {#collection-method}

snake_case関数は文字列をスネークケース（小文字名下線区切り）に変換します。The snake_case function converts the given string to snake_case:

$snake = snake_case('fooBar');

// foo_bar

str_limit() {#collection-method}str_limit() {#collection-method}

str_limit関数は文字列を文字数へ短くします。最初の引数に文字列を受付、最終的な文字列の最大文字数が第２引数です。The str_limit function limits the number of characters in a string. The function accepts a string as its first argument and the maximum number of resulting characters as its second argument:

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

// The PHP...

starts_with() {#collection-method}starts_with() {#collection-method}

starts_with関数は指定された文字列が、２番めの文字列で始まっているか調べます。The starts_with function determines if the given string begins with the given value:

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

// true

str_contains() {#collection-method}str_contains() {#collection-method}

str_contains関数は指定された文字列が、２つ目の文字列を含んでいるか調べます。The str_contains function determines if the given string contains the given value:

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

// true

str_finish() {#collection-method}str_finish() {#collection-method}

str_finish関数は指定された文字列の最後に２つ目の文字列を一つだけ付けます。The str_finish function adds a single instance of the given value to a string:

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

// this/string/

str_is() {#collection-method}str_is() {#collection-method}

str_is関数は指定された文字列がパターンに一致しているかを判定します。アスタリスクが使用されるとワイルドカードとして利用されます。The str_is function determines if a given string matches a given pattern. Asterisks may be used to indicate wildcards:

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

// true

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

// false

str_plural() {#collection-method}str_plural() {#collection-method}

str_plural関数は単数形を複数形へ変換します。この関数は現在英語のみサポートしています。The str_plural function converts a string to its plural form. This function currently only supports the English language:

$plural = str_plural('car');

// cars

$plural = str_plural('child');

// children

整数をこの関数の第２引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:

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

// children

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

// child

str_random() {#collection-method}str_random() {#collection-method}

str_random関数は指定された長さのランダムな文字列を生成します。The str_random function generates a random string of the specified length:

$string = str_random(40);

str_singular() {#collection-method}str_singular() {#collection-method}

str_singular関数は複数形を単数形へ変換します。この関数は現在英語のみサポートしています。The str_singular function converts a string to its singular form. This function currently only supports the English language:

$singular = str_singular('cars');

// car

str_slug() {#collection-method}str_slug() {#collection-method}

str_slug関数は指定された文字列から、URLフレンドリーな「スラグ」を生成します。The str_slug function generates a URL friendly "slug" from the given string:

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

// laravel-5-framework

studly_case() {#collection-method}studly_case() {#collection-method}

studly_case関数は文字列をアッパーキャメルケース（単語の頭文字を大文字）に変換します。The studly_case function converts the given string to StudlyCase:

$value = studly_case('foo_bar');

// FooBar

trans() {#collection-method}trans() {#collection-method}

trans関数は指定した言語行を言語ファイルを使用して翻訳します。The trans function translates the given language line using your localization files[/docs/{{version}}/localization]:

echo trans('validation.required'):

trans_choice() {#collection-method}trans_choice() {#collection-method}

trans_choice関数は指定された言語行を数値をもとに翻訳します。Lang::choiceのエイリアスです。The trans_choice function translates the given language line with inflection:

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

URLURLs

action() {#collection-method}action() {#collection-method}

action関数は指定されたコントローラアクションからURLを生成します。完全修飾コントローラー名は必要ありません。代わりにApp\Http\Controllers名前空間からの相対クラス名を指定してください。The action function generates a URL for the given controller action. You do not need to pass the full namespace to the controller. Instead, pass the controller class name relative to the App\Http\Controllers namespace:

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

メソッドがルートパラメーターを受け付ける場合は、第２引数で指定してください。If the method accepts route parameters, you may pass them as the second argument to the method:

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

asset() {#collection-method}asset() {#collection-method}

現在のリクエストのスキーマ(HTTPかHTTPS)を使い、アセットへのURLを生成します。Generate a URL for an asset using the current scheme of the request (HTTP or HTTPS):

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

secure_asset() {#collection-method}secure_asset() {#collection-method}

HTTPSを使い、アセットへのURLを生成します。Generate a URL for an asset using HTTPS:

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

route() {#collection-method}route() {#collection-method}

route関数は指定された名前付きルートへのURLを生成します。The route function generates a URL for the given named route:

$url = route('routeName');

ルートにパラメーターを受け付ける場合は第２引数で指定しますIf the route accepts parameters, you may pass them as the second argument to the method:

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

url() {#collection-method}url() {#collection-method}

url関数は指定されたパスへの完全なURLを生成します。The url function generates a fully qualified URL to the given path:

echo url('user/profile');

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

その他Miscellaneous

auth() {#collection-method}auth() {#collection-method}

auth関数はAuthenticatorインスタンスを返します。Authファサードの代わりに便利に使用できます。The auth function returns an authenticator instance. You may use it instead of the Auth facade for convenience:

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

back() {#collection-method}back() {#collection-method}

back関数はユーザーの直前のロケーションへのリダイレクトレスポンスを生成します。The back() function generates a redirect response to the user's previous location:

return back();

bcrypt() {#collection-method}bcrypt() {#collection-method}

bcrypt関数は指定した値をBcryptを使用しハッシュ化します。Hashファサードの代用として便利に使用できます。The bcrypt function hashes the given value using Bcrypt. You may use it as an alternative to the Hash facade:

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

collect() {#collection-method}collect() {#collection-method}

collect関数は指定したアイテムから、コレクションのインスタンスを生成します。The collect function creates a collection[/docs/{{version}}/collections] instance from the supplied items:

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

config() {#collection-method}config() {#collection-method}

config関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。The config function gets the value of a configuration variable. The configuration values may be accessed using "dot" syntax, which includes the name of the file and the option you wish to access. A default value may be specified and is returned if the configuration option does not exist:

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

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

configヘルパにキー／値ペアの配列を渡せば、実行時の設定変数をセットすることもできます。The config helper may also be used to set configuration variables at runtime by passing an array of key / value pairs:

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

csrf_field() {#collection-method}csrf_field() {#collection-method}

csrf_field関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。The csrf_field function generates an HTML hidden input field containing the value of the CSRF token. For example, using Blade syntax[/docs/{{version}}/blade]:

{!! csrf_field() !!}

csrf_token() {#collection-method}csrf_token() {#collection-method}

csrf_token関数は現在のCSRFトークンの値を取得します。The csrf_token function retrieves the value of the current CSRF token:

$token = csrf_token();

dd() {#collection-method}dd() {#collection-method}

dd関数は指定された変数の内容を表示し、スクリプトの実行を停止します。The dd function dumps the given variable and ends execution of the script:

dd($value);

env() {#collection-method}env() {#collection-method}

env関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。The env function gets the value of an environment variable or returns a default value:

$env = env('APP_ENV');

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

event() {#collection-method}event() {#collection-method}

event関数は指定したイベントをリスナーに対して発行します。The event function dispatches the given event[/docs/{{version}}/events] to its listeners:

event(new UserRegistered($user));

factory() {#collection-method}factory() {#collection-method}

factory関数は指定したクラス、名前、個数のモデルファクトリービルダーを生成します。これはテストやシーディング（DB初期値設定）で使用できます。The factory function creates a model factory builder for a given class, name, and amount. It can be used while testing[/docs/{{version}}/testing#model-factories] or seeding[/docs/{{version}}/seeding#using-model-factories]:

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

method_field() {#collection-method}method_field() {#collection-method}

method_field関数はフォームのHTTP動詞の見せかけの値を保持する「隠し」HTTP入力フィールドを生成します。Blade記法を使う例です。The method_field function generates an HTML hidden input field containing the spoofed value of the form's HTTP verb. For example, using Blade syntax[/docs/{{version}}/blade]:

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

old() {#collection-method}old() {#collection-method}

old関数はセッションにフラッシュデーターとして保存されている直前の入力値を取得します。The old function retrieves[/docs/{{version}}/requests#retrieving-input] an old input value flashed into the session:

$value = old('value');

redirect() {#collection-method}redirect() {#collection-method}

redirect関数はリダイレクトを行うためのインスタンスを返します。The redirect function returns an instance of the redirector to do redirects[/docs/{{version}}/responses#redirects]:

return redirect('/home');

request() {#collection-method}request() {#collection-method}

request関数は現在のリクエストインスタンスを返すか、入力アイテムを取得します。The request function returns the current request[/docs/{{version}}/requests] instance or obtains an input item:

$request = request();

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

response() {#collection-method}response() {#collection-method}

response関数はresponseインスタンスを返すか、レスポンスファクトリーのインスタンスを取得します。The response function creates a response[/docs/{{version}}/responses] instance or obtains an instance of the response factory:

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

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

session() {#collection-method}session() {#collection-method}

　session関数はセッションへ値を設定、もしくは取得するために使用します。The session function may be used to get / set a session value:

$value = session('key');

キー／値ペアの配列を渡し、値を設定することができます。You may set values by passing an array of key / value pairs to the function:

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

関数に引数を渡さない場合は、セッション保存域が返されます。The session store will be returned if no value is passed to the function:

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

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

value() {#collection-method}value() {#collection-method}

value関数は値が指定された場合は、シンプルにその値を返します。しかし「クロージャー」が関数に渡されると、そのクロージャーを実行し結果を返します。The value function's behavior will simply return the value it is given. However, if you pass a Closure to the function, the Closure will be executed then its result will be returned:

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

view() {#collection-method}view() {#collection-method}

view関数はviewインスタンスを返します。The view function retrieves a view[/docs/{{version}}/views] instance:

return view('auth.login');

with() {#collection-method}with() {#collection-method}

with関数は指定された値を返します。この関数は主にメソッドチェーンが他の方法ではできない場合に便利です。The with function returns the value it is given. This function is primarily useful for method chaining where it would otherwise be impossible:

$value = with(new Foo)->work();