イントロダクション
Laravelはさまざまな、グローバル「ヘルパ」PHP関数を用意しています。これらの多くはフレームワーク自身で使用されています。便利なものが見つかれば、皆さんのアプリケーションでも大いに活用してください。
使用可能なメソッド
配列とオブジェクト
パス
文字列
Fluent Strings
URL
その他
メソッド一覧
配列とオブジェクト
Arr::accessible()
Arr::accessible
メソッドは、指定した値が配列アクセス可能かどうかを判別します。
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// false
Arr::add()
Arr::add
メソッドは指定キー/値のペアをそのキーが存在していない場合とnull
がセットされている場合に、配列に追加します。
use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
Arr::collapse()
Arr::collapse
メソッドは配列の配列を一次元の配列へ展開します。
use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
Arr::crossJoin()
Arr::crossJoin
メソッドは指定配列をクロス結合し、可能性があるすべての順列の直積集合を返します。
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/
Arr::divide()
Arr::divide
メソッドは2つの配列を返します。1つは指定した配列のキーを含み、もう1つは値を含みます。
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
Arr::dot()
Arr::dot
メソッドは多次元配列を「ドット」記法で深さを表した一次元配列に変換します。
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::except()
Arr::except
メソッドは指定キー/値ペアを配列から削除します。
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']
Arr::exists()
Arr::exists
メソッドは指定キーが指定配列に存在するかをチェックします。
use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// false
Arr::first()
Arr::first
メソッドは指定したテストにパスした最初の要素を返します。
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function ($value, $key) {
return $value >= 150;
});
// 200
デフォルト値を3つ目の引数で指定することもできます。この値はどの値もテストへパスしない場合に返されます。
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);
Arr::flatten()
Arr::flatten
メソッドは、多次元配列を一次元配列へ変換します。
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::forget()
Arr::forget
メソッドは「ドット記法」で指定キー/値のペアを深くネストされた配列から取り除きます。
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::get()
Arr::get
メソッドは「ドット」記法で指定した値を深くネストされた配列から取得します。
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100
Arr::get
メソッドはデフォルト値も引数に取ります。これは、指定したキーが配列で存在しない場合に返されます。
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0
Arr::has()
Arr::has
メソッドは、「ドット」記法で指定したアイテムが配列に存在するかをチェックします。
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::has($array, 'product.name');
// true
$contains = Arr::has($array, ['product.price', 'product.discount']);
// false
Arr::hasAny()
Arr::hasAny
メソッドは「ドット」記法を使い、配列中に一連のアイテムが存在するかを調べます。
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// false
Arr::isAssoc()
Arr::isAssoc
は指定配列が、連想配列の場合にtrue
を返します。0から始まる連続した数値キーを持たない場合に「連想」配列であると判断します。
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::last()
Arr::last
メソッドは、テストでパスした最後の配列要素を返します。
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function ($value, $key) {
return $value >= 150;
});
// 300
メソッドの第3引数には、デフォルト値を渡します。テストでパスする値がない場合に、返されます。
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::only()
Arr::only
メソッドは配列中に存在する、指定したキー/値ペアのアイテムのみを返します。
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
Arr::pluck()
Arr::pluck
メソッドは配列中の指定キーに対する値をすべて取得します。
use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']
さらに、結果のリストのキー項目も指定できます。
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
Arr::prepend
メソッドは配列の先頭にアイテムを追加します。
use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']
必要であれば、値に対するキーを指定できます。
use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]
Arr::pull()
Arr::pull
メソッドは配列から指定キー/値ペアを取得し、同時に削除します。
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
メソッドの第3引数として、デフォルト値を渡せます。この値はキーが存在しない場合に返されます。
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);
Arr::query()
Arr::query
メソッドは配列をクエリ文字列へ変換します。
use Illuminate\Support\Arr;
$array = [
'name' => 'Taylor',
'order' => [
'column' => 'created_at',
'direction' => 'desc'
]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=desc
Arr::random()
Arr::random
メソッドは配列からランダムに値を返します。
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)
オプションの2番目の引数に返すアイテム数を指定することもできます。この引数を指定すると、アイテムが1つだけ必要な場合でも、配列が返されることに注意してください。
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)
Arr::set()
Arr::set
メソッドは「ドット」記法を使用し、深くネストした配列に値をセットします。
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
Arr::shuffle()
Arr::shuffle
メソッドは、配列中のアイテムをランダムにシャッフルします。
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (無作為に入れ替えた結果)
Arr::sort()
Arr::sort
メソッドは、配列の値に基づきソートします。
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']
指定するクロージャの結果で配列を並べ替えることもできます。
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/
Arr::sortRecursive()
Arr::sortRecursive
メソッドは、数値インデックス付きサブ配列の場合はsort
関数を使用し、連想サブ配列の場合はksort
関数を使用して、配列を再帰的に並べ替えます。
use Illuminate\Support\Arr;
$array = [
['Roman', 'Taylor', 'Li'],
['PHP', 'Ruby', 'JavaScript'],
['one' => 1, 'two' => 2, 'three' => 3],
];
$sorted = Arr::sortRecursive($array);
/*
[
['JavaScript', 'PHP', 'Ruby'],
['one' => 1, 'three' => 3, 'two' => 2],
['Li', 'Roman', 'Taylor'],
]
*/
Arr::toCssClasses()
Arr::toCssClasses
は、CSSクラス文字列を条件付きでコンパイルします。この方法はクラスの配列を引数に取り、配列キーに追加したいクラス、値は論理式です。配列要素に数字キーがある場合は、レンダーするクラスリストへ常に含めます。
use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/
このメソッドは、Bladeコンポーネントのアトリビュートバッグを使ったクラスのマージと、@class
Bladeディレクティブを提供するLaravelの機能を強化します。
Arr::undot()
Arr::undot
メソッドは、「ドット」記法を用いた一次元配列を多次元配列へ展開します。
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
Arr::where()
Arr::where
メソッドは、指定したクロージャを使用して配列をフィルタリングします。
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function ($value, $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']
Arr::whereNotNull()
Arr::whereNotNull
メソッドは、指定する配列からすべてのnull
値を削除します。
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]
Arr::wrap()
Arr::wrap
メソッドは、指定した値を配列にラップします。指定した値がすでに配列にある場合は、変更せずに返します。
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
指定値がnull
の場合、空の配列を返します。
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
data_fill()
data_fill
関数は「ドット」記法を使用し、ターゲットの配列やオブジェクトへ足りない値をセットします。
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
この関数はアスタリスクもワイルドカードとして受け取り、それに応じてターゲットにデータを埋め込みます。
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/
data_get()
data_get
関数は「ドット」記法を使用し、ネストした配列やオブジェクトから値を取得します。
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100
data_get
関数は、指定したキーが存在しない場合に返す、デフォルト値も指定できます。
$discount = data_get($data, 'products.desk.discount', 0);
// 0
配列やオブジェクトのいずれのキーにもマッチする、ワイルドカードとしてアスタリスクも使用できます。
$data = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];
data_set()
data_set
関数は「ドット」記法を使用し、ネストした配列やオブジェクトに値をセットします。
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
この関数は、アスタリスクを使用したワイルドカードも受け入れ、それに応じてターゲットに値を設定します。
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_set($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 200],
['name' => 'Desk 2', 'price' => 200],
]
]
*/
デフォルトでは、既存の値はすべて上書きされます。値が存在しない場合にのみ値をセットする場合は、関数の4番目の引数にfalse
を渡してください。
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, $overwrite = false);
// ['products' => ['desk' => ['price' => 100]]]
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
ディレクトリへの完全修飾パスを返します。config_path
関数を使用して、アプリケーションの構成ディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。
$path = config_path();
$path = config_path('app.php');
database_path()
database_path
関数は、アプリケーションのdatabase
ディレクトリへの完全修飾パスを返します。database_path
関数を使用して、データベースディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。
$path = database_path();
$path = database_path('factories/UserFactory.php');
mix()
mix
関数は、バージョンつけしたMixファイルのパスを取得します。
$path = mix('css/app.css');
public_path()
public_path
関数は、アプリケーションのpublic
ディレクトリへの完全修飾パスを返します。public_path
関数を使用して、パブリックディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。
$path = public_path();
$path = public_path('css/app.css');
resource_path()
resource_path
関数は、アプリケーションのresources
ディレクトリへの完全修飾パスを返します。resource_path
関数を使用して、リソースディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path()
storage_path
関数は、アプリケーションのstorage
ディレクトリへの完全修飾パスを返します。storage_path
関数を使用して、ストレージディレクトリ内の特定のファイルへの完全修飾パスを生成することもできます。
$path = storage_path();
$path = storage_path('app/file.txt');
文字列
__()
__
関数は、指定した翻訳文字列か翻訳キーをローカリゼーションファイルを使用し、翻訳します。
echo __('Welcome to our application');
echo __('messages.welcome');
指定した翻訳文字列や翻訳キーが存在しない場合、__
関数は指定値をそのまま返します。たとえば、上記の場合に翻訳キーが存在しなければ、__
関数はmessages.welcome
を返します。
class_basename()
class_basename
関数は、指定クラスの名前から名前空間を取り除いて返します。
$class = class_basename('Foo\Bar\Baz');
// Baz
e()
e
関数は、PHPのhtmlspecialchars
関数をdouble_encode
オプションにデフォルトでtrue
を指定し、実行します。
echo e('<html>foo</html>');
// <html>foo</html>
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
Str::after()
Str::after
関数は、指定値に続く文字列をすべて返します。文字列中に指定値が存在しない場合は、文字列全体を返します。
use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'
Str::afterLast()
Str::afterLast
メソッドは、文字列で指定値が現れる最後の場所から、後ろの部分を返します。文字列中に指定値が存在しない場合は、文字列全体を返します。
use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\');
// 'Controller'
Str::ascii()
Str::ascii
メソッドは文字列をASCII値へ変換しようと試みます。
use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'
Str::before()
Str::before
関数は、文字列中の指定値より前の文字列を全部返します。
use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '
Str::beforeLast()
Str::beforeLast
メソッドは、文字列で指定値が現れる最後の場所から、前の部分を返します。
use Illuminate\Support\Str;
$slice = Str::beforeLast('This is my name', 'is');
// 'This '
Str::between()
Str::between
メソッドは、2つの値間の部分文字列を返します。
use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my '
Str::camel()
Str::camel
メソッドは、文字列をキャメルケース(camelCase
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar
Str::contains()
Str::contains
メソッドは、指定文字列に指定値が含まれているかどうかを判別します。このメソッドは大文字と小文字を区別します。
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', 'my');
// true
値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true
Str::containsAll()
Str::containsAll
メソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true
Str::endsWith()
Str::endsWith
メソッドは、最初の文字列が2つ目の引数の文字列で終わっているか判定します。
use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', 'name');
// true
値の配列を渡し、指定文字列が配列内の値のいずれかで終わるかどうかを判断することもできます。
use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', ['name', 'foo']);
// true
$result = Str::endsWith('This is my name', ['this', 'foo']);
// false
Str::finish()
Str::finish
メソッドは、指定値で終わっていない場合、その値の単一のインスタンスを文字列に追加します。
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/
Str::headline()
Str::headline
メソッドは、大・小文字、ハイフン、アンダースコアにより区切られた文字列から、各単語の最初の文字を大文字にしたスペース区切りの文字列へ変換します。
use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent
Str::is()
Str::is
メソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクをワイルドカード値として使用できます。
use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false
Str::isAscii()
Str::isAscii
メソッドは、指定文字列が7ビットASCIIであるかを判定します。
use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// false
Str::isUuid()
Str::isUuid
メソッドは、指定した文字列が有効なUUIDであることを判定します。
use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false
Str::kebab()
Str::kebab
メソッドは、指定した文字列をケバブケース(kebab-case
)に変換します。
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar
Str::length()
Str::length
メソッドは指定文字列の長さを返します。
use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7
Str::limit()
Str::limit
メソッドは、指定文字列を指定する長さへ切り捨てます。
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...
メソッドに3番目の引数を渡し、切り捨てる文字列の末尾へ追加する文字列を変更できます。
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)
Str::lower()
Str::lower
メソッドは指定文字列を小文字に変換します。
use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel
Str::markdown()
Str::markdown
メソッドは、GitHub風なマークダウンをHTMLに変換します。
use Illuminate\Support\Str;
$html = Str::markdown('# Laravel');
// <h1>Laravel</h1>
$html = Str::markdown('# Taylor <b>Otwell</b>', [
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>
Str::mask()
Str::mask
メソッドは、文字列の一部を繰り返し文字でマスクし、メールアドレスや電話番号などの文字列の一部を難読化するために使用します。
use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 3);
// tay***************
必要であれば、mask
メソッドの第3引数に負の数を指定し、文字列の最後から指定する文字数分戻った箇所からマスキングを開始するように指示できます。
$string = Str::mask('taylor@example.com', '*', -15, 3);
// tay***@example.com
Str::orderedUuid()
Str::orderedUuid
メソッドは、インデックス付きデータベース列に効率的に格納できる「タイムスタンプファースト」UUIDを生成します。このメソッドを使用して生成した各UUIDは、以前にこのメソッドを使用して生成されたUUIDの後にソートされます。
use Illuminate\Support\Str;
return (string) Str::orderedUuid();
Str::padBoth()
Str::padBoth
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::padBoth('James', 10, '_');
// '__James___'
$padded = Str::padBoth('James', 10);
// ' James '
Str::padLeft()
String::padLeft
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// ' James'
Str::padRight()
String::padRight
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James '
Str::plural()
Str::plural
メソッドは単数形の単語文字列を複数形に変換します。この関数は現在、英語のみをサポートしています。
use Illuminate\Support\Str;
$plural = Str::plural('car');
// cars
$plural = Str::plural('child');
// children
整数をこのメソッドの第2引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。
use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child
Str::pluralStudly()
Str::pluralStudly
メソッドは、アッパーキャメルケースでフォーマットされた文字列の単語を複数形に変換します。この機能は現在英語のみサポートしています。
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman');
// VerifiedHumans
$plural = Str::pluralStudly('UserFeedback');
// UserFeedback
文字列の単数形か複数形を取得するため、関数へ2番目の引数に整数を指定できます。
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHuman
Str::random()
Str::random
メソッドは指定した長さのランダムな文字列を生成します。このメソッドは、PHPのrandom_bytes
関数を使用します。
use Illuminate\Support\Str;
$random = Str::random(40);
Str::remove()
Str::remove
メソッドは、文字列から指定する値または値の配列を削除します。
use Illuminate\Support\Str;
$string = 'Peter Piper picked a peck of pickled peppers.';
$removed = Str::remove('e', $string);
// Ptr Pipr pickd a pck of pickld ppprs.
文字列を削除するときにケースを無視するには、remove
メソッドの3番目の引数にfalse
を渡してください。
Str::replace()
Str::replace
メソッドは、文字列内の指定した文字列を置き換えます。
use Illuminate\Support\Str;
$string = 'Laravel 8.x';
$replaced = Str::replace('8.x', '9.x', $string);
// Laravel 9.x
Str::replaceArray()
Str::replaceArray
メソッドは配列を使い、文字列を指定値へ順番に置き換えます。
use Illuminate\Support\Str;
$string = 'The event will take place between ? and ?';
$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00
Str::replaceFirst()
Str::replaceFirst
メソッドは、文字列中で最初に出現した値を指定値で置き換えます。
use Illuminate\Support\Str;
$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');
// a quick brown fox jumps over the lazy dog
Str::replaceLast()
Str::replaceLast
メソッドは、文字列中で最後に出現した値を指定値で置き換えます。
use Illuminate\Support\Str;
$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');
// the quick brown fox jumps over a lazy dog
Str::reverse()
Str::reverse
メソッドは、指定文字列を逆順にします。
use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH
Str::singular()
Str::singular
メソッドは複数形を単数形へ変換します。このメソッドは、現在英語のみサポートしています。
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child
Str::slug()
Str::slug
メソッドは指定された文字列から、URLフレンドリーな「スラグ」を生成します。
use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-framework
Str::snake()
Str::snake
メソッドは文字列をスネークケース(snake_case
)に変換します。
use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-bar
Str::start()
Str::start
メソッドは、文字列が指定値で開始されていない場合、その値の単一インスタンスを文字列の前に追加します。
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string
Str::startsWith()
Str::startsWith
メソッドは指定文字列が、2番めの引数の文字列で始まっているか判定します。
use Illuminate\Support\Str;
$result = Str::startsWith('This is my name', 'This');
// true
可能な値の配列が渡された場合、startsWith
メソッドは、文字列が与えられた値のいずれかで始まる場合にtrue
を返します。
$result = Str::startsWith('This is my name', ['This', 'That', 'There']);
// true
Str::studly()
Str::studly
メソッドは文字列をアッパーキャメルケース(StudlyCase
)に変換します。
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar
Str::substr()
Str::substr
メソッドは開始位置と文字列長の引数で指定した部分文字列を返します。
use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// Laravel
Str::substrCount()
Str::substrCount
メソッドは、指定する文字列内に指定値がいくつ存在しているか返します。
use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2
Str::substrReplace()
Str::substrReplace
メソッドは、文字列の一部分のテキストを置き換えます。第3引数で指定した位置から始まり、第4引数で指定した文字数分を置き換えます。このメソッドの第4引数へ0
を渡すと、文字列内の既存の文字を一切置き換えず、指定位置に文字列を挿入します。
use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2);
// 13:
$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00
Str::title()
Str::title
メソッドは、指定された文字列をタイトルケース(Title Case
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case
Str::toHtmlString()
Str::toHtmlString
メソッドは、文字列インスタンスをIlluminate\Support\HtmlString
インスタンスに変換し、Blade
テンプレートで表示できるようにします。
use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();
Str::ucfirst()
Str::ucfirst
メソッドは、指定文字列の最初の文字を大文字にして返します。
use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo bar
Str::upper()
Str::upper
メソッドは、指定文字列を大文字に変換します。
use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL
Str::uuid()
Str::uuid
メソッドは、UUID(バージョン4)を生成します。
use Illuminate\Support\Str;
return (string) Str::uuid();
Str::wordCount()
Str::wordCount
関数は、文字列に含まれる単語の数を返します。
use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2
Str::words()
Str::words
メソッドは、文字列内の単語数を制限します。3番目の引数で、切り捨てた文字列の末尾に追加する文字列を指定できます。
use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>
trans()
trans
関数は、指定した翻訳キーをローカリゼーションファイルを使用し翻訳します。
echo trans('messages.welcome');
指定した翻訳キーが存在しない場合、trans
関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcome
が返ります。
trans_choice()
trans_choice
関数は、数値をもとにし、指定翻訳キーを翻訳します。
echo trans_choice('messages.notifications', $unreadCount);
指定した翻訳キーが存在しない場合、trans_choice
関数は指定値をそのまま返します。上記の場合に翻訳キーが存在しなければ、messages.welcome
が返ります。
Fluent文字列
Fluent文字列は読み書きしやすい(fluent)、オブジェクト指向で、複数の文字列操作をチェーンできるインターフェイスを提供します。古典的な文字列操作に比較すると、複数の文字列操作を読みやすい文法で使用できます。
after
after
関数は、指定値に続く文字列をすべて返します。文字列中に指定値が存在しない場合は、文字列全体を返します。
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->after('This is');
// ' my name'
afterLast
afterLast
メソッドは、文字列で指定値が最後に現れる場所から、後ろの部分を返します。文字列中に指定値が存在しない場合は、文字列全体を返します。
use Illuminate\Support\Str;
$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');
// 'Controller'
append
append
メソッドは、指定値を文字列へ追加します。
use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'
ascii
ascii
メソッドは、文字列をアスキー値への変換を試みます。
use Illuminate\Support\Str;
$string = Str::of('ü')->ascii();
// 'u'
basename
basename
メソッドは、文字列の最後の名前部分を返します。
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->basename();
// 'baz'
必要であれば、最後の部分から削除したい「拡張子」を指定できます。
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');
// 'baz'
before
before
関数は、文字列中の指定値より前の文字列を全部返します
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->before('my name');
// 'This is '
beforeLast
beforeLast
メソッドは、文字列中で最初に指定値が現れる場所から、前の部分を返します。
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->beforeLast('is');
// 'This '
between
between
メソッドは、2つの値の間にある文字列を返します。
use Illuminate\Support\Str;
$converted = Str::of('This is my name')->between('This', 'name');
// ' is my '
camel
camel
メソッドは、文字列をキャメルケース(camelCase
)へ変換します
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// fooBar
contains
contains
メソッドは、指定された文字列に指定された値が含まれているかどうかを判別します。このメソッドは大文字と小文字を区別します。
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('my');
// true
値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains(['my', 'foo']);
// true
containsAll
containsAll
メソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);
// true
dirname
dirname
メソッドは文字列の親ディレクトリ名部分を返します。
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname();
// '/foo/bar'
必要に応じて、文字列から削除するディレクトリレベル数を指定できます。
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname(2);
// '/foo'
endsWith
endsWith
メソッドは、文字列が指定値で終わっているか判定します。
use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith('name');
// true
値の配列を渡し、指定文字列が配列内の値のいずれかで終わるかどうかを判断することもできます。
use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith(['name', 'foo']);
// true
$result = Str::of('This is my name')->endsWith(['this', 'foo']);
// false
exactly
exactly
メソッドは、文字列と指定値が完全に一致することを判定します。
use Illuminate\Support\Str;
$result = Str::of('Laravel')->exactly('Laravel');
// true
explode
explode
メソッドは文字列を指定デリミッタで分割し、分割した文字列を含むコレクションを返します。
use Illuminate\Support\Str;
$collection = Str::of('foo bar baz')->explode(' ');
// collect(['foo', 'bar', 'baz'])
finish
finish
メソッドは、文字列が指定値で終わっていない場合、その値の単一のインスタンスを追加します。
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->finish('/');
// this/string/
$adjusted = Str::of('this/string/')->finish('/');
// this/string/
is
is
メソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクはワイルドカード値として使用できます
use Illuminate\Support\Str;
$matches = Str::of('foobar')->is('foo*');
// true
$matches = Str::of('foobar')->is('baz*');
// false
isAscii
isAscii
メソッドは、文字列がASCII文字列であるか判定します。
use Illuminate\Support\Str;
$result = Str::of('Taylor')->isAscii();
// true
$result = Str::of('ü')->isAscii();
// false
isEmpty
isEmpty
メソッドは、文字列が空であるか判定します。
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isEmpty();
// true
$result = Str::of('Laravel')->trim()->isEmpty();
// false
isNotEmpty
isNotEmpty
メソッドは、文字列が空でないかを判定します。
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isNotEmpty();
// false
$result = Str::of('Laravel')->trim()->isNotEmpty();
// true
isUuid
isUuid
メソッドは、文字列がUUIDかを判定します。
use Illuminate\Support\Str;
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
// true
$result = Str::of('Taylor')->isUuid();
// false
kebab
kebab
メソッドは、文字列をケバブケース(kebab-case
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->kebab();
// foo-bar
length
length
メソッドは、文字列の長さを返します。
use Illuminate\Support\Str;
$length = Str::of('Laravel')->length();
// 7
limit
limit
メソッドは、指定文字列を指定した長さに切り捨てます。
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);
// The quick brown fox...
2番目の引数を渡して、切り捨てた文字列の末尾に追加する文字列を変更することもできます。
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
// The quick brown fox (...)
lower
lower
メソッドは、文字列を小文字に変換します。
use Illuminate\Support\Str;
$result = Str::of('LARAVEL')->lower();
// 'laravel'
ltrim
ltrim
メソッドは、文字列の左側をトリムします。
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->ltrim();
// 'Laravel '
$string = Str::of('/Laravel/')->ltrim('/');
// 'Laravel/'
markdown
markdown
メソッドはGitHub風マークダウンをHTMLに変換します。
use Illuminate\Support\Str;
$html = Str::of('# Laravel')->markdown();
// <h1>Laravel</h1>
$html = Str::of('# Taylor <b>Otwell</b>')->markdown([
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>
mask
mask
メソッドは、文字列の一部を繰り返し文字でマスクし、メールアドレスや電話番号など、文字列の一部を難読化するのに使用します。
use Illuminate\Support\Str;
$string = Str::of('taylor@example.com')->mask('*', 3);
// tay***************
必要ならば、mask
メソッドの第3引数へ負の数を指定し、文字列の最後から指定した文字数戻った箇所から、マスキングを開始するように指示できます。
$string = Str::of('taylor@example.com')->mask('*', -15, 3);
// tay***@example.com
match
match
メソッドは、指定した正規表現パターンに一致する部分文字列を返します。
use Illuminate\Support\Str;
$result = Str::of('foo bar')->match('/bar/');
// 'bar'
$result = Str::of('foo bar')->match('/foo (.*)/');
// 'bar'
matchAll
matchAll
メソッドは、指定した正規表現パターンに一致した部分文字列を含むコレクションを返します。
use Illuminate\Support\Str;
$result = Str::of('bar foo bar')->matchAll('/bar/');
// collect(['bar', 'bar'])
正規表現にマッチンググループを指定した場合は、そのグループに一致するコレクションを返します。
use Illuminate\Support\Str;
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
// collect(['un', 'ly']);
一致しなかった場合は、空のコレクションを返します。
padBoth
padBoth
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::of('James')->padBoth(10, '_');
// '__James___'
$padded = Str::of('James')->padBoth(10);
// ' James '
padLeft
padLeft
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::of('James')->padLeft(10, '-=');
// '-=-=-James'
$padded = Str::of('James')->padLeft(10);
// ' James'
padRight
padRight
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。
use Illuminate\Support\Str;
$padded = Str::of('James')->padRight(10, '-');
// 'James-----'
$padded = Str::of('James')->padRight(10);
// 'James '
pipe
pipe
メソッドは、現在の値を指定Callableへ渡すことで、文字列を変換します。
use Illuminate\Support\Str;
$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');
// 'Checksum: a5c95b86291ea299fcbe64458ed12702'
$closure = Str::of('foo')->pipe(function ($str) {
return 'bar';
});
// 'bar'
plural
plural
メソッドは、単数形の単語文字列を複数形に変換します。この関数は現在、英語のみをサポートしています。
use Illuminate\Support\Str;
$plural = Str::of('car')->plural();
// cars
$plural = Str::of('child')->plural();
// children
整数をこのメソッドの第2引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。
use Illuminate\Support\Str;
$plural = Str::of('child')->plural(2);
// children
$plural = Str::of('child')->plural(1);
// child
prepend
prepend
メソッドは、指定値を文字列の先頭へ追加します。
use Illuminate\Support\Str;
$string = Str::of('Framework')->prepend('Laravel ');
// Laravel Framework
remove
remove
メソッドは、指定する値か文字列の配列を文字列から削除します。
use Illuminate\Support\Str;
$string = Str::of('Arkansas is quite beautiful!')->remove('quite');
// Arkansas is beautiful!
文字列削除時にケースを無視するため2番目のパラメータへfalse
を渡すこともできます。
replace
replace
メソッドは、文字列中の指定値を置き換えます。
use Illuminate\Support\Str;
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
// Laravel 7.x
replaceArray
replaceArray
メソッドは、配列を使用して文字列中の指定値を置き換えます。
use Illuminate\Support\Str;
$string = 'The event will take place between ? and ?';
$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);
// The event will take place between 8:30 and 9:00
replaceFirst
replaceFirst
メソッドは、文字列中で最初に現れた指定値を置き換えます。
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');
// a quick brown fox jumps over the lazy dog
replaceLast
replaceLast
メソッドは文字列中で最後に現れた指定値を置き換えます。
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');
// the quick brown fox jumps over a lazy dog
replaceMatches
replaceMatches
メソッドは、パターンに一致する文字列のすべての部分を、指定した置換文字列で置き換えます。
use Illuminate\Support\Str;
$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')
// '15015551000'
replaceMatches
メソッドは、指定したパターンに一致する文字列の各部分で呼び出されるクロージャも受け入れます。これにより、クロージャ内で置換ロジックを実行し、置換した値を返せます。
use Illuminate\Support\Str;
$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {
return '['.$match[0].']';
});
// '[1][2][3]'
rtrim
rtrim
メソッドは、指定した文字列の右側をトリムします。
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->rtrim();
// ' Laravel'
$string = Str::of('/Laravel/')->rtrim('/');
// '/Laravel'
scan
scan
メソッドは、sscanf
PHP関数がサポートするフォーマットに従い、文字列からコレクションへの入力をパースします。
use Illuminate\Support\Str;
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
// collect(['filename', 'jpg'])
singular
singular
メソッドは、単語を単数形に変換します。この関数は現在英語のみ対応しています。
use Illuminate\Support\Str;
$singular = Str::of('cars')->singular();
// car
$singular = Str::of('children')->singular();
// child
slug
slug
メソッドは、文字列をURLフレンドリーな「スラグ」へ変換します。
use Illuminate\Support\Str;
$slug = Str::of('Laravel Framework')->slug('-');
// laravel-framework
snake
The snake
method converts the given string to
snake
メソッドは、文字列をスネークケース(snake_case
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->snake();
// foo_bar
split
split
メソッドは正規表現を使い文字列をコレクションへ分割します。
use Illuminate\Support\Str;
$segments = Str::of('one, two, three')->split('/[\s,]+/');
// collect(["one", "two", "three"])
start
start
メソッドは、文字列が指定値で開始されていない場合、その値の単一のインスタンスを追加します。
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->start('/');
// /this/string
$adjusted = Str::of('/this/string')->start('/');
// /this/string
startsWith
startsWith
メソッドは、文字列が指定値から始まっているかを判定します。
use Illuminate\Support\Str;
$result = Str::of('This is my name')->startsWith('This');
// true
studly
studly
メソッドは、文字列をアッパーキャメルケース(StudlyCase
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->studly();
// FooBar
substr
substr
メソッドは、引数で指定された開始位置と長さの部分文字列を返します。
use Illuminate\Support\Str;
$string = Str::of('Laravel Framework')->substr(8);
// Framework
$string = Str::of('Laravel Framework')->substr(8, 5);
// Frame
substrReplace
substrReplace
メソッドは、文字列の一部分を置き換えます。第3引数で指定した位置から始め、第4引数で指定した文字数分置き換えます。このメソッドの第4引数に0
を渡すと、既存の文字列内の文字を一切置き換えることなく、指定された位置に文字列を挿入します。
use Illuminate\Support\Str;
$string = Str::of('1300')->substrReplace(':', 2);
// 13:
$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);
// The Laravel Framework
tap
tap
メソッドは文字列を指定クロージャへ渡し、その文字列自体に影響を与えずに文字列を調べ操作することができます。クロージャが返す値に関係なく、tap
メソッドはオリジナルの文字列を返します。
use Illuminate\Support\Str;
$string = Str::of('Laravel')
->append(' Framework')
->tap(function ($string) {
dump('String after append: ' . $string);
})
->upper();
// LARAVEL FRAMEWORK
test
test
メソッドは、文字列が指定する正規表現パターンと一致するか判定します。
use Illuminate\Support\Str;
$result = Str::of('Laravel Framework')->test('/Laravel/');
// true
title
title
メソッドは、文字列をタイトルケース(Title Case
)へ変換します。
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->title();
// A Nice Title Uses The Correct Case
trim
trim
メソッドは、文字列をトリムします。
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->trim();
// 'Laravel'
$string = Str::of('/Laravel/')->trim('/');
// 'Laravel'
ucfirst
ucfirst
メソッドは、文字列の最初の1文字目を大文字にします。
use Illuminate\Support\Str;
$string = Str::of('foo bar')->ucfirst();
// Foo bar
upper
upper
メソッドは、文字列を大文字に変換します。
use Illuminate\Support\Str;
$adjusted = Str::of('laravel')->upper();
// LARAVEL
when
when
メソッドは指定条件がtrue
の場合、指定したクロージャを呼び出します。クロージャは、fluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('Taylor')
->when(true, function ($string) {
return $string->append(' Otwell');
});
// 'Taylor Otwell'
必要であれば、3番目のパラメータとして別のクロージャをwhen
メソッドに渡せます。このクロージャは、条件パラメータがfalse
と評価された場合に実行します。
whenContains
whenContains
メソッドは、文字列が指定値を含んでいる場合に、渡したクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContains('tony', function ($string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、when
メソッドの第3パラメータへ、もう一つクロージャを渡せます。このクロージャは、文字列が指定値を含んでいない場合に実行されます。
また、値の配列を渡し、指定文字列が配列の中のいずれかの値を含むかを判定することもできます。
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContains(['tony', 'hulk'], function ($string) {
return $string->title();
});
// Tony Stark
whenContainsAll
whenContainsAll
メソッドは、文字列が指定する部分文字列をすべて含んでいる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContainsAll(['tony', 'stark'], function ($string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、when
メソッドの第3パラメータとしてもう一つのクロージャを渡せます。このクロージャは、条件パラメータがfalse
と評価された場合に実行されます。
whenEmpty
文字列が空の場合、whenEmpty
メソッドは指定されたクロージャを呼び出します。クロージャが値を返す場合、その値をwhenEmpty
メソッドも返します。クロージャが値を返さない場合、fluent文字列インスタンスを返します。
use Illuminate\Support\Str;
$string = Str::of(' ')->whenEmpty(function ($string) {
return $string->trim()->prepend('Laravel');
});
// 'Laravel'
whenNotEmpty
whenNotEmpty
メソッドは文字列が空でない場合、指定するクロージャを呼び出します。クロージャが値を返す場合は、whenNotEmpty
メソッドもその値を返します
。クロージャが値を返さない場合は、Fluent文字列インスタンスを返します。
use Illuminate\Support\Str;
$string = Str::of('Framework')->whenNotEmpty(function ($string) {
return $string->prepend('Laravel ');
});
// 'Laravel Framework'
whenStartsWith
whenStartsWith
メソッドは、文字列が指定する部分文字列から始まる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenStartsWith('disney', function ($string) {
return $string->title();
});
// 'Disney World'
whenEndsWith
whenEndsWith
メソッドは、文字列が指定した部分文字列で終了する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenEndsWith('world', function ($string) {
return $string->title();
});
// 'Disney World'
whenExactly
whenExactly
メソッドは、文字列が指定文字列と正確に一致する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('laravel')->whenExactly('laravel', function ($string) {
return $string->title();
});
// 'Laravel'
whenIs
whenIs
メソッドは、文字列が与えられたパターンにマッチする場合、指定クロージャを呼び出します。アスタリスクはワイルドカードとして使用できます。クロージャはFluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIs('foo/*', function ($string) {
return $string->append('/baz');
});
// 'foo/bar/baz'
whenIsAscii
whenIsAscii
メソッドは、文字列が7bitのASCIIの場合、クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIsAscii('laravel', function ($string) {
return $string->title();
});
// 'Laravel'
whenIsUuid
whenIsUuid
メソッドは、文字列が有効なUUIDである場合、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIsUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de', function ($string) {
return $string->substr(0, 8);
});
// 'a0a2a2d2'
whenTest
whenTest
メソッドは、文字列が正規表現にマッチする場合、指定クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。
use Illuminate\Support\Str;
$string = Str::of('laravel framework')->whenTest('/laravel/', function ($string) {
return $string->title();
});
// 'Laravel Framework'
wordCount
wordcount
メソッドは、文字列に含まれる単語の数を返します。
use Illuminate\Support\Str;
Str::of('Hello, world!')->wordCount(); // 2
words
words
メソッドは、文字列内の単語数を制限します。必要に応じ、切り捨てた文字列に追加する文字列を指定できます。
use Illuminate\Support\Str;
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
// Perfectly balanced, as >>>
URL
action()
action
関数は、指定されたコントローラアクションのURLを生成します。
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
メソッドがルートパラメーターを受け付ける場合は、第2引数で指定してください。
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
asset
関数は、現在のリクエストのスキーマ(HTTPかHTTPS)を使い、アセットへのURLを生成します。
$url = asset('img/photo.jpg');
.env
ファイルでASSET_URL
変数を設定することにより、アセットURLホストを設定できます。これは、AmazonS3や別のCDNなどの外部サービスでアセットをホストする場合に役立ちます。
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
route
関数は、指定した名前付きルートのURLを生成します。
$url = route('route.name');
ルートがパラメーターを受け入れる場合は、それらを関数の2番目の引数として渡すことができます。
$url = route('route.name', ['id' => 1]);
デフォルトでは、route
関数は絶対URLを生成します。相対URLを生成する場合は、関数の3番目の引数としてfalse
を渡してください。
$url = route('route.name', ['id' => 1], false);
secure_asset()
secure_asset
関数はHTTPSを使い、アセットへのURLを生成します。
$url = secure_asset('img/photo.jpg');
secure_url()
secure_url
関数は、指定されたパスへの完全修飾HTTPS
URLを生成します。関数の2番目の引数で追加の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);
ブラウザに送信する必要のある例外のメッセージとカスタムHTTP応答ヘッダを指定することもできます。
abort(403, 'Unauthorized.', $headers);
abort_if()
abort_if
関数は、指定された論理値がtrue
と評価された場合に、HTTP例外を投げます。
abort_if(! Auth::user()->isAdmin(), 403);
abort
メソッドと同様に、例外の応答テキストを3番目の引数として指定し、カスタム応答ヘッダの配列を4番目の引数として関数に指定することもできます。
abort_unless()
abort_unless
関数は、指定した論理値がfalse
と評価された場合に、HTTP例外を投げます。
abort_unless(Auth::user()->isAdmin(), 403);
abort
メソッドと同様に、例外の応答テキストを3番目の引数として指定し、カスタム応答ヘッダの配列を4番目の引数として関数に指定することもできます。
app()
app
関数は、サービスコンテナのインスタンスを返します。
$container = app();
コンテナにより依存解決する、クラス名かインターフェイス名を渡すこともできます。
$api = app('HelpSpot\API');
auth()
auth
関数は、Authenticatorインスタンスを返します。Auth
ファサードの代わりに使用できます。
$user = auth()->user();
必要であれば、アクセスしたいガードインスタンスを指定することもできます。
$user = auth('admin')->user();
back()
back
関数はユーザーの直前のロケーションへのリダイレクトHTTPレスポンスを生成します。
return back($status = 302, $headers = [], $fallback = '/');
return back();
bcrypt()
bcrypt
関数はBcryptを使用して指定された値をハッシュします。この関数は、Hash
ファサードの代わりに使用できます。
$password = bcrypt('my-secret-password');
blank()
blank
関数は、指定された値が「空白」であるかどうかを判別します。
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
blank
の逆の動作は、filled
メソッドです。
broadcast()
broadcast
関数は、指定したイベントをリスナへブロードキャストします。
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();
cache()
cache
関数はキャッシュから値を取得するために使用します。キャッシュに指定したキーが存在しない場合、オプション値が返されます。
$value = cache('key');
$value = cache('key', 'default');
関数にキー/値ペアの配列を渡すと、アイテムをキャッシュへ追加します。さらに秒数、もしくはキャッシュ値が有効であると推定される期限を渡すこともできます。
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
class_uses_recursive
関数は、すべての親で使われているものも含め、クラス中で使用されているトレイトをすべて返します。
$traits = class_uses_recursive(App\Models\User::class);
collect()
collect
関数は、指定値からコレクションインスタンスを生成します。
$collection = collect(['taylor', 'abigail']);
config()
config
関数は設定変数の値を取得します。設定値はファイル名とアクセスしたいオプションを「ドット」記法で指定します。デフォルト値が指定でき、設定オプションが存在しない時に返されます。
$value = config('app.timezone');
$value = config('app.timezone', $default);
キー/値ペアの配列を渡すことにより、実行時に設定変数を設定できます。ただし、この関数は現在のリクエストの設定値にのみ影響し、実際の設定値は更新しないことに注意してください。
config(['app.debug' => true]);
cookie()
cookie
関数は新しいクッキーインスタンスを生成します。
$cookie = cookie('name', 'value', $minutes);
csrf_field()
csrf_field
関数は、CSRFトークン値を持つHTML「隠し」入力フィールドを生成します。ブレード記法を使用した例です。
{{ csrf_field() }}
csrf_token()
csrf_token
関数は、現在のCSRFトークン値を取得します。
$token = csrf_token();
dd()
dd
関数は指定された変数の内容を表示し、スクリプトの実行を停止します。
dd($value);
dd($value1, $value2, $value3, ...);
スクリプトの実行を停止したくない場合は、代わりにdump
関数を使ってください。
dispatch()
dispatch
関数は、指定したジョブをLaravelのジョブキューへ投入します。
dispatch(new App\Jobs\SendEmails);
dump()
dump
関数は指定した変数をダンプします。
dump($value);
dump($value1, $value2, $value3, ...);
変数の値をダンプした後に実行を停止したい場合は、代わりにdd
関数を使用してください。
env()
env
関数は環境変数の値を取得します。取得できない場合はデフォルト値を返します。
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
Note: 開発期間中に
config:cache
コマンドを実行する場合は、設定ファイルの中で必ずenv
関数だけを使用してください。設定ファイルがキャッシュされると、.env
ファイルはロードされなくなり、env
関数の呼び出しはすべてnull
を返します。
event()
event
関数は、指定したイベントをリスナにディスパッチします。
event(new UserRegistered($user));
filled()
filled
関数は、指定された値が「空白」でないかどうかを判別します。
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
filled
の逆の動作は、blank
メソッドです。
info()
info
関数は、アプリケーションのlogに情報を書き込みます。
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>
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) !!}
optional
関数は、2番目の引数としてクロージャも受け入れます。最初の引数として指定された値がnullでない場合、クロージャが呼び出されます。
return optional(User::find($id), function ($user) {
return $user->name;
});
policy()
policy
関数は、指定クラスのポリシーインスタンスを取得します。
$policy = policy(App\Models\User::class);
redirect()
redirect
関数は、リダイレクトHTTPレスポンスを返します。引数無しで呼び出した場合は、リダイレクタインスタンスを返します。
return redirect($to = null, $status = 302, $headers = [], $https = null);
return redirect('/home');
return redirect()->route('route.name');
report()
report
関数は例外ハンドラを使用して例外をレポートします。
report($e);
report
関数は文字列を引数に取ります。関数に文字列が与えられると、関数は指定する文字列をメッセージとする例外を作成します。
report('Something went wrong.');
request()
request
関数は、現在のrequestインスタンスを返すか、現在のリクエストから入力フィールドの値を取得します。
$request = request();
$value = request('key', $default);
rescue()
rescue
関数は指定されたクロージャを実行し、その実行中に発生した例外をすべてキャッチします。キャッチした例外はすべて例外ハンドラへ送られますが、リクエストの処理は続行されます。
return rescue(function () {
return $this->method();
});
rescue
関数に2番目の引数を渡すこともできます。この引数は、クロージャの実行で例外が発生した場合に返す「デフォルト」値です。
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
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空け、5回試行する
}, 100);
各試行間でスリープするミリ秒数を自分で計算したい場合は、retry
関数への3番目の引数にクロージャを渡します。
return retry(5, function () {
// ...
}, function ($attempt) {
return $attempt * 100;
});
特定条件下でのみ再試行するには、retry
関数への4番目の引数としてクロージャを渡せます。
return retry(5, function () {
// ...
}, 100, function ($exception) {
return $exception instanceof RetryException;
});
session()
session
関数はセッションへ値を設定、もしくは取得するために使用します。
$value = session('key');
キー/値ペアの配列を渡し、値を設定できます。
session(['chairs' => 7, 'instruments' => 3]);
関数に引数を渡さない場合は、セッション保存域が返されます。
$value = session()->get('key');
session()->put('key', $value);
tap()
tap
関数は、任意の$value
とクロージャの2つの引数を受け入れます。$value
はクロージャに渡され、tap
関数によって返されます。クロージャの戻り値は関係ありません。
$user = tap(User::first(), function ($user) {
$user->name = 'taylor';
$user->save();
});
tap
関数にクロージャが渡されない場合は、指定した$value
で任意のメソッドを呼び出せます。呼び出すメソッドの戻り値は、メソッドがその定義で実際に何を返すかに関係なく、常に$value
になります。たとえば、Eloquentのupdate
メソッドは通常、整数を返します。しかし、tap
関数を介してupdate
メソッド呼び出しをチェーンすることで、メソッドへモデル自体を返すように強制できます。
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
クラスへtap
メソッドを追加するには、Illuminate\Support\Traits\Tappable
トレイトをそのクラスへ追加してください。このトレイトのtap
メソッドはクロージャだけを引数に受け取ります。オブジェクトインスタンス自身がクロージャに渡され、tap
メソッドによりリターンされます。
return $user->tap(function ($user) {
//
});
throw_if()
throw_if
関数は、指定した論理式がtrue
と評価された場合に、指定した例外を投げます。
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
throw_unless()
throw_unless
関数は、指定した論理式がfalse
と評価された場合に、指定した例外を投げます。
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
today()
today
関数は、現在の日付を表す新しいIlluminate\Support\Carbon
インスタンスを生成します。
$today = today();
trait_uses_recursive()
trait_uses_recursive
関数は、そのトレイトで使用されている全トレイトを返します。
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
transform
関数は、値が空白でない場合、指定値に対してクロージャを実行し、クロージャの戻り値を返します。
$callback = function ($value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
デフォルト値またはクロージャは、関数の3番目の引数として渡せます。指定値が空白の場合、この値をが返します。
$result = transform(null, $callback, '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
関数は、指定値を返します。関数の2番目の引数としてクロージャを渡たすと、クロージャが実行され、その戻り値を返します。
$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