イントロダクションIntroduction
Laravelは様々な、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。Laravel includes a variety of global "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 & Objects
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_random array_set array_sort array_sort_recursive array_where array_wrap data_fill data_get data_set head last
パスPaths
文字列Strings
__ 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::orderedUuid 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 Str::uuid
URLURLs
その他Miscellaneous
abort abort_if abort_unless app auth back bcrypt blank broadcast cache class_uses_recursive collect config cookie csrf_field csrf_token dd decrypt dispatch dispatch_now dump encrypt env event factory filled info logger method_field now old optional policy redirect report request rescue resolve response retry session tap today throw_if throw_unless trait_uses_recursive transform validator value view with
メソッド一覧Method Listing
配列とオブジェクトArrays & Objects
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 an 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 collapses 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
関数は2つの配列をリターンします。一つは指定した配列のキー、もう一方は値です。The array_divide
function returns two arrays, one containing the keys, and the other containing the values of the given array:
[$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 = ['products' => ['desk' => ['price' => 100]]];
$flattened = array_dot($array);
// ['products.desk.price' => 100]
array_except()
{#collection-method}array_except()
{#collection-method}
array_except
関数は指定されたキー/値ペアを配列から削除します。The array_except
function removes the given key / value pairs from an array:
$array = ['name' => 'Desk', 'price' => 100];
$filtered = 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];
$first = array_first($array, function ($value, $key) {
return $value >= 150;
});
// 200
デフォルト値を3つ目の引数で指定することもできます。この値はテストでどの値もテストにパスしない場合に返されます。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:
$first = array_first($array, $callback, $default);
array_flatten()
{#collection-method}array_flatten()
{#collection-method}
array_flatten
関数は、多次元配列を一次元配列へ変換します。The array_flatten
function flattens a multi-dimensional array into a single level array:
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = 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]]];
$price = 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:
$discount = array_get($array, 'products.desk.discount', 0);
// 0
array_has()
{#collection-method}array_has()
{#collection-method}
array_has
関数は、「ドット」記法で指定されたアイテムが配列に存在するかをチェックします。The array_has
function checks whether a given item or items exists in an array using "dot" notation:
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = array_has($array, 'product.name');
// true
$contains = array_has($array, ['product.price', 'product.discount']);
// false
array_last()
{#collection-method}array_last()
{#collection-method}
array_last
関数は、テストでパスした最後の配列要素を返します。The array_last
function returns the last element of an array passing a given truth test:
$array = [100, 200, 300, 110];
$last = array_last($array, function ($value, $key) {
return $value >= 150;
});
// 300
メソッドの第3引数には、デフォルト値を渡します。テストでパスする値がない場合に、返されます。A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:
$last = array_last($array, $callback, $default);
array_only()
{#collection-method}array_only()
{#collection-method}
array_only
関数は配列中の指定されたキー/値ペアのアイテムのみを返します。The array_only
function returns only the specified key / value pairs from the given array:
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = array_only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
array_pluck()
{#collection-method}array_pluck()
{#collection-method}
array_pluck
関数は配列中の指定キーに対する値を全て取得します。The array_pluck
function retrieves all of the values for a given key from an array:
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = array_pluck($array, 'developer.name');
// ['Taylor', 'Abigail']
さらに、結果のリストのキー項目も指定できます。You may also specify how you wish the resulting list to be keyed:
$names = array_pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']
array_prepend()
{#collection-method}array_prepend()
{#collection-method}
array_prepend
関数は配列の先頭にアイテムを追加します。The array_prepend
function will push an item onto the beginning of an array:
$array = ['one', 'two', 'three', 'four'];
$array = array_prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']
必要であれば、値に対するキーを指定できます。If needed, you may specify the key that should be used for the value:
$array = ['price' => 100];
$array = array_prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]
array_pull()
{#collection-method}array_pull()
{#collection-method}
array_pull
関数は配列から指定されたキー/値ペアを取得し、同時に削除します。The array_pull
function returns and removes a key / value pair from an array:
$array = ['name' => 'Desk', 'price' => 100];
$name = array_pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
メソッドの第3引数として、デフォルト値を渡せます。この値はキーが存在しない場合に返されます。A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:
$value = array_pull($array, $key, $default);
array_random()
{#collection-method}array_random()
{#collection-method}
array_random
関数は配列からランダムに値を返します。The array_random
function returns a random value from an array:
$array = [1, 2, 3, 4, 5];
$random = array_random($array);
// 4 - (ランダムに取得された値)
第2引数として、返すアイテム数を任意に指定することもできます。この引数を指定した場合、たとえ一つだけ取得したいときでも配列で返されることに注意してください。You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array, even if only one item is desired:
$items = array_random($array, 2);
// [2, 5] - (retrieved randomly)
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 an array by its values:
$array = ['Desk', 'Table', 'Chair'];
$sorted = array_sort($array);
// ['Chair', 'Desk', 'Table']
指定したクロージャの結果に基づき、ソートすることもできます。You may also sort the array by the results of the given Closure:
$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()
{#collection-method}array_sort_recursive()
{#collection-method}
array_sort_recursive
関数はsort
機能を使い配列を再帰的にソートします。The array_sort_recursive
function recursively sorts an array using the sort
function:
$array = [
['Roman', 'Taylor', 'Li'],
['PHP', 'Ruby', 'JavaScript'],
];
$sorted = 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 an array using the given Closure:
$array = [100, '200', 300, '400', 500];
$filtered = array_where($array, function ($value, $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']
array_wrap()
{#collection-method}array_wrap()
{#collection-method}
array_wrap
関数は、指定した値を配列中にラップします。指定した値が配列中に存在している場合は、変更されません。The array_wrap
function wraps the given value in an array. If the given value is already an array it will not be changed:
$string = 'Laravel';
$array = array_wrap($string);
// ['Laravel']
NULL値を指定すると、空の配列が返ってきます。If the given value is null, an empty array will be returned:
$nothing = null;
$array = array_wrap($nothing);
// []
data_fill()
{#collection-method}data_fill()
{#collection-method}
data_fill
関数は「ドット」記法を使用し、ターゲットの配列やオブジェクトへ足りない値をセットします。The data_fill
function sets a missing value within a nested array or object using "dot" notation:
$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]]]
この関数はアスタリスクもワイルドカードとして受け取り、それに応じてターゲットにデータを埋め込みます。This function also accepts asterisks as wildcards and will fill the target accordingly:
$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()
{#collection-method}data_get()
{#collection-method}
data_get
関数は「ドット」記法を使用し、ネストした配列やオブジェクトから値を取得します。The data_get
function retrieves a value from a nested array or object using "dot" notation:
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100
data_get
関数は、指定したキーが存在しない場合に返す、デフォルト値も指定できます。The data_get
function also accepts a default value, which will be returned if the specified key is not found:
$discount = data_get($data, 'products.desk.discount', 0);
// 0
data_set()
{#collection-method}data_set()
{#collection-method}
data_set
関数は「ドット」記法を使用し、ネストした配列やオブジェクトに値をセットします。The data_set
function sets a value within a nested array or object using "dot" notation:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
この関数はアスタリスクもワイルドカードとして受け取り、それに応じてターゲットにデータを埋め込みます。This function also accepts wildcards and will set values on the target accordingly:
$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],
],
]
*/
デフォルトでは、既存の値をオーバーライドします。存在しない場合のみ値を設定したい場合は、第3引数にfalse
を指定してください。By default, any existing values are overwritten. If you wish to only set a value if it doesn't exist, you may pass false
as the third argument:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, false);
// ['products' => ['desk' => ['price' => 100]]]
head()
{#collection-method}head()
{#collection-method}
head
関数は、配列の最初の要素を返します。The head
function 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
ディレクトリへの完全パスを取得します。また、app_path
関数は、ファイルパスをアプリケーションディレクトリからの相対位置で渡し、完全なパスを生成することもできます。The app_path
function returns the fully qualified path to the app
directory. You may also use the app_path
function to generate a fully qualified path to a file relative to the application directory:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path()
{#collection-method}base_path()
{#collection-method}
base_path
関数は、プロジェクトルートの完全パスを返します。base_path
関数はさらに、指定されたプロジェクトルートディレクトリからの相対パスから絶対パスを生成します。The base_path
function returns the fully qualified path to the project root. You may also use the base_path
function to generate a fully qualified path to a given file relative to the project root directory:
$path = base_path();
$path = base_path('vendor/bin');
config_path()
{#collection-method}config_path()
{#collection-method}
config_path
関数は、config
ディレクトリの完全パスを返します。さらに、アプリケーションの設定ディレクトリ中の指定ファイルへの完全パスを生成することもできます。The config_path
function returns the fully qualified path to the config
directory. You may also use the config_path
function to generate a fully qualified path to a given file within the application's configuration directory:
$path = config_path();
$path = config_path('app.php');
database_path()
{#collection-method}database_path()
{#collection-method}
database_path
関数は、database
ディレクトリの完全パスを返します。さらに、データベースディレクトリ中の指定ファイルへの完全パスを生成することもできます。The database_path
function returns the fully qualified path to the database
directory. You may also use the database_path
function to generate a fully qualified path to a given file within the database directory:
$path = database_path();
$path = database_path('factories/UserFactory.php');
mix()
{#collection-method}mix()
{#collection-method}
mix
関数は、バージョンつけしたMixファイルのパスを取得します。The mix
function returns the path to a versioned Mix file[/docs/{{version}}/mix]:
$path = mix('css/app.css');
public_path()
{#collection-method}public_path()
{#collection-method}
public_path
関数は、public
ディレクトリの完全パスを返します。さらに、publicディレクトリ中の指定ファイルへの完全パスを生成することもできます。The public_path
function returns the fully qualified path to the public
directory. You may also use the public_path
function to generate a fully qualified path to a given file within the public directory:
$path = public_path();
$path = public_path('css/app.css');
resource_path()
{#collection-method}resource_path()
{#collection-method}
resource_path
関数は、resources
ディレクトリの完全パスを返します。さらに、リソースディレクトリ中の指定ファイルへの完全パスを生成することもできます。The resource_path
function returns the fully qualified path to the resources
directory. You may also use the resource_path
function to generate a fully qualified path to a given file within the resources directory:
$path = resource_path();
$path = resource_path('assets/sass/app.scss');
storage_path()
{#collection-method}storage_path()
{#collection-method}
storage_path
関数は、storage
ディレクトリの完全パスを返します。さらに、ストレージディレクトリ中の指定ファイルへの完全パスを生成することもできます。The storage_path
function returns the fully qualified path to the storage
directory. You may also use the storage_path
function to generate a fully qualified path to a given file within the storage directory:
$path = storage_path();
$path = storage_path('app/file.txt');
文字列Strings
__()
{#collection-method}__()
{#collection-method}
__
関数は、指定した翻訳文字列か翻訳キーをローカリゼーションファイルを使用し、翻訳します。The __
function translates the given translation string or translation key using your localization files[/docs/{{version}}/localization]:
echo __('Welcome to our application');
echo __('messages.welcome');
指定した翻訳文字列や翻訳キーが存在しない場合、__
関数は指定した値をそのまま返します。たとえば、上記の場合に翻訳キーが存在しなければ、__
関数はmessages.welcome
を返します。If the specified translation string or key does not exist, the __
function will return the given value. So, using the example above, the __
function would return messages.welcome
if that translation key does not exist.
camel_case()
{#collection-method}camel_case()
{#collection-method}
camel_case
関数は、文字列をキャメルケース(2つ目以降の単語の先頭は大文字)へ変換します。The camel_case
function converts the given string to camelCase
:
$converted = 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
関数は、PHPのhtmlspecialchars
関数をdouble_encode
オプションにデフォルトでtrue
を指定し、実行します。The e
function runs PHP's htmlspecialchars
function with the double_encode
option set to true
by default:
echo e('<html>foo</html>');
// <html>foo</html>
ends_with()
{#collection-method}ends_with()
{#collection-method}
ends_with
関数は、最初の文字列が2つ目の引数の文字列で終わっているか調べます。The ends_with
function determines if the given string ends with the given value:
$result = ends_with('This is my name', 'name');
// true
kebab_case()
{#collection-method}kebab_case()
{#collection-method}
kebab_case
関数は、指定した文字列を「ケバブ-ケース」に変換します。The kebab_case
function converts the given string to kebab-case
:
$converted = kebab_case('fooBar');
// foo-bar
preg_replace_array()
{#collection-method}preg_replace_array()
{#collection-method}
preg_replace_array
関数は、指定したパターンを順番に配列中の値に置き換えます。The preg_replace_array
function replaces a given pattern in the string sequentially using an 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()
{#collection-method}snake_case()
{#collection-method}
snake_case
関数は文字列をスネークケース(小文字名下線区切り)に変換します。The snake_case
function converts the given string to snake_case
:
$converted = snake_case('fooBar');
// foo_bar
starts_with()
{#collection-method}starts_with()
{#collection-method}
starts_with
関数は指定した文字列が、2番めの文字列で始まっているか調べます。The starts_with
function determines if the given string begins with the given value:
$result = starts_with('This is my name', 'This');
// true
str_after()
{#collection-method}str_after()
{#collection-method}
str_after
関数は、指定した値に続く文字列を全て返します。The str_after
function returns everything after the given value in a string:
$slice = str_after('This is my name', 'This is');
// ' my name'
str_before()
{#collection-method}str_before()
{#collection-method}
str_before
関数は、文字列中の指定した値より前の文字列を全部返します。The str_before
function returns everything before the given value in a string:
$slice = str_before('This is my name', 'my name');
// 'This is '
str_contains()
{#collection-method}str_contains()
{#collection-method}
str_contains
関数は指定した文字列が、2つ目の文字列を含んでいるか調べます。(大文字小文字の区別あり)The str_contains
function determines if the given string contains the given value (case sensitive):
$contains = str_contains('This is my name', 'my');
// true
指定した文字列に値のどれかが含まれているかを判定するために、値の配列を渡すことも可能です。You may also pass an array of values to determine if the given string contains any of the values:
$contains = str_contains('This is my name', ['my', 'foo']);
// true
str_finish()
{#collection-method}str_finish()
{#collection-method}
str_finish
関数は指定した文字列の最後が、2つ目の引数の値で終了していない場合、その値を追加します。The str_finish
function adds a single instance of the given value to a string if it does not already end with the value:
$adjusted = str_finish('this/string', '/');
// this/string/
$adjusted = 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:
$matches = str_is('foo*', 'foobar');
// true
$matches = str_is('baz*', 'foobar');
// false
str_limit()
{#collection-method}str_limit()
{#collection-method}
str_limit
関数は、指定した長さへ文字列を切り詰めます。The str_limit
function truncates the given string at the specified length:
$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...
また、第3引数として、最長文字列数を超えた場合に末尾へ追加する、文字列を渡すこともできます。You may also pass a third argument to change the string that will be appended to the end:
$truncated = str_limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)
Str::orderedUuid()
{#collection-method}Str::orderedUuid()
{#collection-method}
Str::orderedUuid
メソッドはインデックスのついたデータベースカラムへ効率的に保存される、「タイムスタンプ先行」のUUIDを生成します。The Str::orderedUuid
method generates a "timestamp first" UUID that may be efficiently stored in an indexed database column:
use Illuminate\Support\Str;
return (string) Str::orderedUuid();
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
整数をこの関数の第2引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。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
関数は指定された長さのランダムな文字列を生成します。この関数は、PHPのrandom_bytes
関数を使用します。The str_random
function generates a random string of the specified length. This function uses PHP's random_bytes
function:
$random = str_random(40);
str_replace_array()
{#collection-method}str_replace_array()
{#collection-method}
str_replace_array
関数は配列を使い、文字列を指定値へ順番に置き換えます。The str_replace_array
function replaces a given value in the string sequentially using an 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()
{#collection-method}str_replace_first()
{#collection-method}
str_replace_first
関数は、文字列中で最初に出現した値を指定値で置き換えます。The str_replace_first
function replaces the first occurrence of a given value in a string:
$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()
{#collection-method}str_replace_last()
{#collection-method}
str_replace_last
関数は、文字列中で最後に出現した値を指定値で置き換えます。The str_replace_last
function replaces the last occurrence of a given value in a string:
$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()
{#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
$singular = str_singular('children');
// child
str_slug()
{#collection-method}str_slug()
{#collection-method}
str_slug
関数は指定された文字列から、URLフレンドリーな「スラグ」を生成します。The str_slug
function generates a URL friendly "slug" from the given string:
$slug = str_slug('Laravel 5 Framework', '-');
// laravel-5-framework
str_start()
{#collection-method}str_start()
{#collection-method}
str_start
関数は文字列が指定値から始まっていない場合、先頭にその文字列を追加します。The str_start
function adds a single instance of the given value to a string if it does not already start with the value:
$adjusted = str_start('this/string', '/');
// /this/string
$adjusted = str_start('/this/string', '/');
// /this/string
studly_case()
{#collection-method}studly_case()
{#collection-method}
studly_case
関数は文字列をアッパーキャメルケース(単語の頭文字を大文字)に変換します。The studly_case
function converts the given string to StudlyCase
:
$converted = studly_case('foo_bar');
// FooBar
title_case()
{#collection-method}title_case()
{#collection-method}
title_case
関数は、指定された文字列を「タイトルケース」へ変換します。The title_case
function converts the given string to Title Case
:
$converted = title_case('a nice title uses the correct case');
// A Nice Title Uses The Correct Case
trans()
{#collection-method}trans()
{#collection-method}
trans
関数は、指定した翻訳キーをローカリゼーションファイルを使用し翻訳します。The trans
function translates the given translation key using your localization files[/docs/{{version}}/localization]:
echo trans('messages.welcome');
指定した翻訳キーが存在しない場合、trans
関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcome
が返ります。If the specified translation key does not exist, the trans
function will return the given key. So, using the example above, the trans
function would return messages.welcome
if the translation key does not exist.
trans_choice()
{#collection-method}trans_choice()
{#collection-method}
trans_choice
関数は、指定した指定値を数値を元に翻訳します。The trans_choice
function translates the given translation key with inflection:
echo trans_choice('messages.notifications', $unreadCount);
指定した翻訳キーが存在しない場合、trans_choice
関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcome
が返ります。If the specified translation key does not exist, the trans_choice
function will return the given key. So, using the example above, the trans_choice
function would return messages.notifications
if the translation key does not exist.
Str::uuid()
{#collection-method}Str::uuid()
{#collection-method}
Str::uuid
メソッドは、UUID(バージョン4)を生成します。The Str::uuid
method generates a UUID (version 4):
use Illuminate\Support\Str;
return (string) Str::uuid();
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 of the controller. Instead, pass the controller class name relative to the App\Http\Controllers
namespace:
$url = action('HomeController@index');
メソッドがルートパラメーターを受け付ける場合は、第2引数で指定してください。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}
asset
関数は、現在のリクエストのスキーマ(HTTPかHTTPS)を使い、アセットへのURLを生成します。The asset
function generates 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}
secure_asset
関数はHTTPSを使い、アセットへのURLを生成します。The secure_asset
function generates a URL for an asset using HTTPS:
$url = secure_asset('img/photo.jpg');
route()
{#collection-method}route()
{#collection-method}
route
関数は指定された名前付きルートへのURLを生成します。The route
function generates a URL for the given named route:
$url = route('routeName');
ルートにパラメーターを受け付ける場合は第2引数で指定しますIf the route accepts parameters, you may pass them as the second argument to the method:
$url = route('routeName', ['id' => 1]);
route
関数はデフォルトとして絶対URLを生成します。相対URLを生成したい場合は、第3引数にfalse
を渡してください。By default, the route
function generates an absolute URL. If you wish to generate a relative URL, you may pass false
as the third argument:
$url = route('routeName', ['id' => 1], false);
secure_url()
{#collection-method}secure_url()
{#collection-method}
secure_url
関数は、指定したパスへの完全なHTTPS URLを生成します。The secure_url
function generates a fully qualified HTTPS URL to the given path:
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
url()
{#collection-method}url()
{#collection-method}
url
関数は指定したパスへの完全なURLを生成します。The url
function generates a fully qualified URL to the given path:
$url = url('user/profile');
$url = url('user/profile', [1]);
パスを指定しない場合は、Illuminate\Routing\UrlGenerator
インスタンスを返します。If no path is provided, a Illuminate\Routing\UrlGenerator
instance is returned:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
その他Miscellaneous
abort()
{#collection-method}abort()
{#collection-method}
abort
関数は、例外ハンドラによりレンダーされるであろう、HTTP例外を投げます。The abort
function throws an HTTP exception[/docs/{{version}}/errors#http-exceptions] which will be rendered by the exception handler[/docs/{{version}}/errors#the-exception-handler]:
abort(403);
例外のレスポンステキストと、カスタムヘッダを指定することもできます。You may also provide the exception's response text and custom response headers:
abort(403, 'Unauthorized.', $headers);
abort_if()
{#collection-method}abort_if()
{#collection-method}
abort_if
関数は、指定された論理値がtrue
と評価された場合に、HTTP例外を投げます。The abort_if
function throws an HTTP exception if a given boolean expression evaluates to true
:
abort_if(! Auth::user()->isAdmin(), 403);
abort
メソッドと同様に、例外のレスポンステキストを第3引数に、カスタムレスポンスヘッダを第4引数に指定することもできます。Like the abort
method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument.
abort_unless()
{#collection-method}abort_unless()
{#collection-method}
abort_unless
関数は、指定した論理値がfalse
と評価された場合に、HTTP例外を投げます。The abort_unless
function throws an HTTP exception if a given boolean expression evaluates to false
:
abort_unless(Auth::user()->isAdmin(), 403);
abort
メソッドと同様に、例外のレスポンステキストを第3引数に、カスタムレスポンスヘッダを第4引数に指定することもできます。Like the abort
method, you may also provide the exception's response text as the third argument and an array of custom response headers as the fourth argument.
app()
{#collection-method}app()
{#collection-method}
app
関数は、サービスコンテナのインスタンスを返します。The app
function returns the service container[/docs/{{version}}/container] instance:
$container = app();
コンテナにより依存解決する、クラス名かインターフェイス名を渡すこともできます。You may pass a class or interface name to resolve it from the container:
$api = app('HelpSpot\API');
auth()
{#collection-method}auth()
{#collection-method}
auth
関数は、authenticatorのインスタンスを返します。利便のため、代わりにAuth
ファサードを使用することもできます。The auth
function returns an authenticator[/docs/{{version}}/authentication] instance. You may use it instead of the Auth
facade for convenience:
$user = auth()->user();
必要であれば、アクセスしたいガードインスタンスを指定することもできます。If needed, you may specify which guard instance you would like to access:
$user = auth('admin')->user();
back()
{#collection-method}back()
{#collection-method}
back
関数はユーザーの直前のロケーションへのリダイレクトHTTPレスポンスを生成します。The back
function generates a redirect HTTP response[/docs/{{version}}/responses#redirects] to the user's previous location:
return back($status = 302, $headers = [], $fallback = false);
return back();
bcrypt()
{#collection-method}bcrypt()
{#collection-method}
bcrypt
関数は指定した値をBcryptを使用しハッシュ化します。Hash
ファサードの代用として使用できます。The bcrypt
function hashes[/docs/{{version}}/hashing] the given value using Bcrypt. You may use it as an alternative to the Hash
facade:
$password = bcrypt('my-secret-password');
broadcast()
{#collection-method}broadcast()
{#collection-method}
broadcast
関数は、指定したイベントをリスナへブロードキャストします。The broadcast
function broadcasts[/docs/{{version}}/broadcasting] the given event[/docs/{{version}}/events] to its listeners:
broadcast(new UserRegistered($user));
blank()
{#collection-method}blank()
{#collection-method}
blank
関数は指定値が"blank"であるかどうかを返します。The blank
function returns whether the given value is "blank":
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
blank
の逆の動作は、filled
メソッドです。For the inverse of blank
, see the filled
[#method-filled] method.
cache()
{#collection-method}cache()
{#collection-method}
cache
関数はキャッシュから値を取得するために使用します。キャッシュに指定したキーが存在しない場合、オプション値が返されます。The cache
function may be used to get values from the cache[/docs/{{version}}/cache]. If the given key does not exist in the cache, an optional default value will be returned:
$value = cache('key');
$value = cache('key', 'default');
関数にキー/値ペアの配列を渡すと、アイテムをキャッシュへ追加します。さらに分数、もしくはキャッシュ値が有効であると推定される期限を渡すこともできます。You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of minutes or duration the cached value should be considered valid:
cache(['key' => 'value'], 5);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
{#collection-method}class_uses_recursive()
{#collection-method}
class_uses_recursive
関数は、すべての親で使われているものも含め、クラス中で使用されているトレイトを全て返します。The class_uses_recursive
function returns all traits used by a class, including traits used by all of its parent classes:
$traits = class_uses_recursive(App\User::class);
collect()
{#collection-method}collect()
{#collection-method}
collect
関数は、指定した値からコレクションインスタンスを生成します。The collect
function creates a collection[/docs/{{version}}/collections] instance from the given value:
$collection = collect(['taylor', 'abigail']);
config()
{#collection-method}config()
{#collection-method}
config
関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。The config
function gets the value of a configuration[/docs/{{version}}/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);
キー/値ペアの配列を渡すことにより、実行時に設定変数をセットできます。You may set configuration variables at runtime by passing an array of key / value pairs:
config(['app.debug' => true]);
cookie()
{#collection-method}cookie()
{#collection-method}
cookie
関数は新しいクッキーインスタンスを生成します。The cookie
function creates a new cookie[/docs/{{version}}/requests#cookies] instance:
$cookie = cookie('name', 'value', $minutes);
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 variables and ends execution of the script:
dd($value);
dd($value1, $value2, $value3, ...);
スクリプトの実行を停止したくない場合は、代わりにdump
関数を使ってください。If you do not want to halt the execution of your script, use the dump
[#method-dump] function instead.
decrypt()
{#collection-method}decrypt()
{#collection-method}
decrypt
関数は、指定値をLaravelの暗号化機能を用い、復号します。The decrypt
function decrypts the given value using Laravel's encrypter[/docs/{{version}}/encryption]:
$decrypted = decrypt($encrypted_value);
dispatch()
{#collection-method}dispatch()
{#collection-method}
dispatch
関数は、指定したジョブをLaravelのジョブキューへ投入します。The dispatch
function pushes the given job[/docs/{{version}}/queues#creating-jobs] onto the Laravel job queue[/docs/{{version}}/queues]:
dispatch(new App\Jobs\SendEmails);
dispatch_now()
{#collection-method}dispatch_now()
{#collection-method}
dispatch_now
関数は、指定したジョブを即時に実行し、handle
メソッドからの値を返します。The dispatch_now
function runs the given job[/docs/{{version}}/queues#creating-jobs] immediately and returns the value from its handle
method:
$result = dispatch_now(new App\Jobs\SendEmails);
dump()
{#collection-method}dump()
{#collection-method}
dump
関数は指定した変数をダンプします。The dump
function dumps the given variables:
dump($value);
dump($value1, $value2, $value3, ...);
変数の値をダンプした後に実行を停止したい場合は、代わりにdd
関数を使用してください。If you want to stop executing the script after dumping the variables, use the dd
[#method-dd] function instead.
encrypt()
{#collection-method}encrypt()
{#collection-method}
encrypt
関数は、Laravelの暗号化機能を用い、指定値を暗号化します。The encrypt
function encrypts the given value using Laravel's encrypter[/docs/{{version}}/encryption]:
$encrypted = encrypt($unencrypted_value);
env()
{#collection-method}env()
{#collection-method}
env
関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。The env
function retrieves the value of an environment variable[/docs/{{version}}/configuration#environment-configuration] or returns a default value:
$env = env('APP_ENV');
// APP_ENVがセットされていない場合、'production'が返る
$env = env('APP_ENV', 'production');
Note:
開発期間中にconfig:cache
コマンドを実行する場合は、設定ファイルの中で必ずenv
関数だけを使用してください。設定ファイルがキャッシュされると、.env
ファイルはロードされなくなり、env
関数の呼び出しは全てnull
を返します。{note} If you execute theconfig:cache
command during your deployment process, you should be sure that you are only calling theenv
function from within your configuration files. Once the configuration has been cached, the.env
file will not be loaded and all calls to theenv
function will returnnull
.
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}}/database-testing#writing-factories] or seeding[/docs/{{version}}/seeding#using-model-factories]:
$user = factory(App\User::class)->make();
filled()
{#collection-method}filled()
{#collection-method}
filled
関数は、指定値が"blank"であるかどうかを返します。The filled
function returns whether the given value is not "blank":
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
filled
の逆の動作は、blank
メソッドです。For the inverse of filled
, see the blank
[#method-blank] method.
info()
{#collection-method}info()
{#collection-method}
info
関数はログへ情報(information)を書き出します。The info
function will write information to the log[/docs/{{version}}/errors#logging]:
info('Some helpful information!');
関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:
info('User login attempt failed.', ['id' => $user->id]);
logger()
{#collection-method}logger()
{#collection-method}
logger
関数は、debug
レベルのメッセージをログへ書き出します。The logger
function can be used to write a debug
level message to the log[/docs/{{version}}/errors#logging]:
logger('Debug message');
関連情報の配列を関数へ渡すこともできます。An array of contextual data may also be passed to the function:
logger('User has logged in.', ['id' => $user->id]);
関数に値を渡さない場合は、ロガーインスタンスが返されます。A logger[/docs/{{version}}/errors#logging] instance will be returned if no value is passed to the function:
logger()->error('You are not allowed here.');
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>
now()
{#collection-method}now()
{#collection-method}
now
関数は、現時点を表す新しいIlluminate\Support\Carbon
インスタンスを生成します。The now
function creates a new Illuminate\Support\Carbon
instance for the current time:
$now = now();
old()
{#collection-method}old()
{#collection-method}
old
関数はセッションにフラッシュデーターとして保存されている直前の入力値を取得します。The old
function retrieves[/docs/{{version}}/requests#retrieving-input] an old input[/docs/{{version}}/requests#old-input] value flashed into the session:
$value = old('value');
$value = old('value', 'default');
optional()
{#collection-method}optional()
{#collection-method}
optional
関数はどんな引数も指定でき、そのオブジェクトのプロパティへアクセスできます。指定したオブジェクトがnull
の場合、アクセスしているプロパティは、エラーを発生させる代わりにnull
を返します。The optional
function accepts any argument and allows you to access properties on that object. If the given object is null
, accessing a property will return null
instead of causing an error:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
返却されるオブジェクトのメソッドを呼び出すことも可能です。プロパティのアクセスと同様に、指定されたオブジェクトがnull
の場合、エラーを発生させる代わりに、呼び出したメソッドはnull
を返します。You can also call methods on the returned object. As with property access, if the given object is null
, calling a method will return null
instead of causing an error:
return optional($user)->getTwitterProfile();
呼び出したいメソッドが、実際にはそのオブジェクト自身のものでない場合は、optional
の第2引数としてクロージャを渡します。If the method you want to call is not actually on the object itself, you can pass a Closure to optional
as its second argument:
return optional(User::find($id), function ($user) {
return TwitterApi::findUser($user->twitter_id);
});
指定したオブジェクトがnull
ではない場合にクロージャが呼び出され、その戻り値がそのまま返されます。指定したオブジェクトが実際にはnull
の場合、クロージャは呼び出されず、optional
はエラーを発生させる代わりにnull
を返します。If the given object is not null
, the Closure will be called and its return value will be returned as is. If the given object is actually null
, the Closure will not be called, and optional
will return null
instead of causing an error.
policy()
{#collection-method}policy()
{#collection-method}
policy
関数は、指定クラスのポリシーインスタンスを取得します。The policy
method retrieves a policy[/docs/{{version}}/authorization#creating-policies] instance for a given class:
$policy = policy(App\User::class);
redirect()
{#collection-method}redirect()
{#collection-method}
redirect
関数は、リダイレクトHTTPレスポンスを返します。引数無しで呼び出した場合は、リダイレクタインスタンスを返します。The redirect
function returns a redirect HTTP response[/docs/{{version}}/responses#redirects], or returns the redirector instance if called with no arguments:
return redirect($to = null, $status = 302, $headers = [], $secure = null);
return redirect('/home');
return redirect()->route('route.name');
report()
{#collection-method}report()
{#collection-method}
report
関数は、例外ハンドラのreport
メソッドを利用し、例外をレポートします。The report
function will report an exception using your exception handler[/docs/{{version}}/errors#the-exception-handler]'s report
method:
report($e);
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);
rescue()
{#collection-method}rescue()
{#collection-method}
rescue
関数は指定されたクロージャを実行し、実行時に発生する例外をキャッチします。キャッチされた例外は、すべて例外ハンドラのreport
メソッドに送られます。しかし、リクエストは引き続き処理されます。The rescue
function executes the given Closure and catches any exceptions that occur during its execution. All exceptions that are caught will be sent to your exception handler[/docs/{{version}}/errors#the-exception-handler]'s report
method; however, the request will continue processing:
return rescue(function () {
return $this->method();
});
rescue
関数には第2引数を渡すことができます。クロージャ実行時に例外が発生した場合、第2引数に渡した値が返されるデフォルトの値になります。You may also pass a second argument to the rescue
function. This argument will be the "default" value that should be returned if an exception occurs while executing the Closure:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
resolve()
{#collection-method}resolve()
{#collection-method}
resolve
関数はサービスコンテナを使い、指定されたクラスやインターフェイスの名前から、そのインスタンス自身を依存解決します。The resolve
function resolves a given class or interface name to its instance using the service container[/docs/{{version}}/container]:
$api = resolve('HelpSpot\API');
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);
retry()
{#collection-method}retry()
{#collection-method}
retry
関数は指定された最大試行回数を過ぎるまで、指定されたコールバックを実行します。コールバックが例外を投げなければ、返却値が返されます。コールバックが例外を投げた場合は、自動的にリトライされます。最大試行回数を超えると、例外が投げられます。The retry
function attempts to execute the given callback until the given maximum attempt threshold is met. If the callback does not throw an exception, its return value will be returned. If the callback throws an exception, it will automatically be retried. If the maximum attempt count is exceeded, the exception will be thrown:
return retry(5, function () {
// 実行間で500ms空け、5回試行する
}, 100);
session()
{#collection-method}session()
{#collection-method}
session
関数はセッションへ値を設定、もしくは取得するために使用します。The session
function may be used to get or set session[/docs/{{version}}/session] values:
$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);
tap()
{#collection-method}tap()
{#collection-method}
tap
関数は引数を2つ取ります。アビリティの$value
とクロージャです。$value
はクロージャに渡され、それからtap
関数により返されます。クロージャから返す値は無視されます。The tap
function accepts two arguments: an arbitrary $value
and a Closure. The $value
will be passed to the Closure and then be returned by the tap
function. The return value of the Closure is irrelevant:
$user = tap(User::first(), function ($user) {
$user->name = 'taylor';
$user->save();
});
tap
関数でクロージャを指定しない場合、渡した$value
のメソッドを呼び出せます。メソッド呼び出しの戻り値は常に$value
になり、メソッドが実際に返す値とは無関係です。たとえば、Eloquentのupdate
メソッドは、通常整数値を返します。しかし、update
メソッドをtap
関数にチェーンして呼び出すことで、メソッドにモデル自身を返すように強制できます。If no Closure is passed to the tap
function, you may call any method on the given $value
. The return value of the method you call will always be $value
, regardless of what the method actually returns in its definition. For example, the Eloquent update
method typically returns an integer. However, we can force the method to return the model itself by chaining the update
method call through the tap
function:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
today()
{#collection-method}today()
{#collection-method}
today
関数は、現在の日付を表す新しいIlluminate\Support\Carbon
インスタンスを生成します。The today
function creates a new Illuminate\Support\Carbon
instance for the current date:
$today = today();
throw_if()
{#collection-method}throw_if()
{#collection-method}
throw_if
関数は、指定した論理式がtrue
と評価された場合に、指定した例外を投げます。The throw_if
function throws the given exception if a given boolean expression evaluates to 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()
{#collection-method}throw_unless()
{#collection-method}
throw_unless
関数は、指定した論理式がfalse
と評価された場合に、指定した例外を投げます。The throw_unless
function throws the given exception if a given boolean expression evaluates to 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()
{#collection-method}trait_uses_recursive()
{#collection-method}
trait_uses_recursive
関数は、そのトレイトで使用されている全トレイトを返します。The trait_uses_recursive
function returns all traits used by a trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
{#collection-method}transform()
{#collection-method}
transform
関数は、指定値がblankでない場合に指定値を「クロージャ」で実行し、実行結果を返します。The transform
function executes a Closure
on a given value if the value is not blank[#method-blank] and returns the result of the Closure
:
$callback = function ($value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
デフォルト値か「クロージャ」を第3引数として渡すこともできます。この値は指定値がblankの場合に返されます。A default value or Closure
may also be passed as the third parameter to the method. This value will be returned if the given value is blank:
$result = transform(null, $callback, 'The value is blank');
// The value is blank
validator()
{#collection-method}validator()
{#collection-method}
validator
関数は、指定した引数で新しいバリデータインスタンスを生成します。利便のため、Validator
ファサードを代わりに使うこともできます。The validator
function creates a new validator[/docs/{{version}}/validation] instance with the given arguments. You may use it instead of the Validator
facade for convenience:
$validator = validator($data, $rules, $messages);
value()
{#collection-method}value()
{#collection-method}
value
関数は指定値を返します。「クロージャ」を関数に渡した場合は実行し、結果を返します。The value
function returns 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:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
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
関数は指定値を返します。「クロージャ」を第2引数へ渡した場合は実行し、その結果を返します。The with
function returns the value it is given. If a Closure
is passed as the second argument to the function, the Closure
will be executed and its result will be returned:
$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