イントロダクションIntroduction
Laravelには、文字列値を操作する様々な関数があります。これらの関数の多くはフレームワーク自体で使用されていますが、便利に感じるなら、あなたのアプリケーションでも自由にご利用ください。Laravel includes a variety of functions for manipulating string values. 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
文字列Strings
__ class_basename e preg_replace_array Str::after Str::afterLast Str::apa Str::ascii Str::before Str::beforeLast Str::between Str::betweenFirst Str::camel Str::charAt Str::chopStart Str::chopEnd Str::contains Str::containsAll Str::doesntContain Str::deduplicate Str::endsWith Str::excerpt Str::finish Str::headline Str::inlineMarkdown Str::is Str::isAscii Str::isJson Str::isUlid Str::isUrl Str::isUuid Str::kebab Str::lcfirst Str::length Str::limit Str::lower Str::markdown Str::mask Str::orderedUuid Str::padBoth Str::padLeft Str::padRight Str::password Str::plural Str::pluralStudly Str::position Str::random Str::remove Str::repeat Str::replace Str::replaceArray Str::replaceFirst Str::replaceLast Str::replaceMatches Str::replaceStart Str::replaceEnd Str::reverse Str::singular Str::slug Str::snake Str::squish Str::start Str::startsWith Str::studly Str::substr Str::substrCount Str::substrReplace Str::swap Str::take Str::title Str::toBase64 Str::toHtmlString Str::transliterate Str::trim Str::ltrim Str::rtrim Str::ucfirst Str::ucsplit Str::upper Str::ulid Str::unwrap Str::uuid Str::wordCount Str::wordWrap Str::words Str::wrap str trans trans_choice
Fluent文字列Fluent Strings
after afterLast apa append ascii basename before beforeLast between betweenFirst camel charAt classBasename chopStart chopEnd contains containsAll deduplicate dirname endsWith exactly excerpt explode finish headline inlineMarkdown is isAscii isEmpty isNotEmpty isJson isUlid isUrl isUuid kebab lcfirst length limit lower markdown mask match matchAll isMatch newLine padBoth padLeft padRight pipe plural position prepend remove repeat replace replaceArray replaceFirst replaceLast replaceMatches replaceStart replaceEnd scan singular slug snake split squish start startsWith stripTags studly substr substrReplace swap take tap test title toBase64 transliterate trim ltrim rtrim ucfirst ucsplit unwrap upper when whenContains whenContainsAll whenEmpty whenNotEmpty whenStartsWith whenEndsWith whenExactly whenNotExactly whenIs whenIsAscii whenIsUlid whenIsUuid whenTest wordCount words wrap
文字列Strings
__()
__()
__
関数は、指定する翻訳文字列や翻訳キーを言語ファイルを使って翻訳します。The __
function translates the given translation string or translation key using your language 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.
class_basename()
class_basename()
class_basename
関数は、指定クラスの名前から名前空間を取り除いて返します。The class_basename
function returns the class name of the given class with the class's namespace removed:
$class = class_basename('Foo\Bar\Baz');
// Baz
e()
e()
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>
preg_replace_array()
preg_replace_array()
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
Str::after()
Str::after()
Str::after
関数は、指定値に続く文字列をすべて返します。文字列中に指定値が存在しない場合は、文字列全体を返します。The Str::after
method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'
Str::afterLast()
Str::afterLast()
Str::afterLast
メソッドは、文字列で指定値が現れる最後の場所から、後ろの部分を返します。文字列中に指定値が存在しない場合は、文字列全体を返します。The Str::afterLast
method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\');
// 'Controller'
Str::apa()
Str::apa()
Str::apa
メソッドは指定文字列をAPAガイドラインに従ってタイトルケースに変換します。The Str::apa
method converts the given string to title case following the APA guidelines[https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case]:
use Illuminate\Support\Str;
$title = Str::apa('Creating A Project');
// 'Creating a Project'
Str::ascii()
Str::ascii()
Str::ascii
メソッドは文字列をASCII値へ変換しようと試みます。The Str::ascii
method will attempt to transliterate the string into an ASCII value:
use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'
Str::before()
Str::before()
Str::before
関数は、文字列中の指定値より前の文字列を全部返します。The Str::before
method returns everything before the given value in a string:
use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '
Str::beforeLast()
Str::beforeLast()
Str::beforeLast
メソッドは、文字列で指定値が現れる最後の場所から、前の部分を返します。The Str::beforeLast
method returns everything before the last occurrence of the given value in a string:
use Illuminate\Support\Str;
$slice = Str::beforeLast('This is my name', 'is');
// 'This '
Str::between()
Str::between()
Str::between
メソッドは、2つの値間の部分文字列を返します。The Str::between
method returns the portion of a string between two values:
use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my '
Str::betweenFirst()
Str::betweenFirst()
Str::betweenFirst
メソッドは、2つの値の間にある文字列のうち、可能な限り小さい部分を返します。The Str::betweenFirst
method returns the smallest possible portion of a string between two values:
use Illuminate\Support\Str;
$slice = Str::betweenFirst('[a] bc [d]', '[', ']');
// 'a'
Str::camel()
Str::camel()
Str::camel
メソッドは、文字列をキャメルケース(camelCase
)へ変換します。The Str::camel
method converts the given string to camelCase
:
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// 'fooBar'
Str::charAt()
Str::charAt()
Str::charAt
メソッドは、指定インデックスの文字を返します。インデックスが範囲外の場合はfalse
を返します。The Str::charAt
method returns the character at the specified index. If the index is out of bounds, false
is returned:
use Illuminate\Support\Str;
$character = Str::charAt('This is my name.', 6);
// 's'
Str::chopStart()
Str::chopStart()
Str::chopStart
メソッドは、指定値が文字列の最初に現れる場合のみ、その値を削除します。The Str::chopStart
method removes the first occurrence of the given value only if the value appears at the start of the string:
use Illuminate\Support\Str;
$url = Str::chopStart('https://laravel.com', 'https://');
// 'laravel.com'
第2引数へ配列を渡すこともできます。文字列が配列のいずれかの値で始まる場合、その値を文字列から削除します。You may also pass an array as the second argument. If the string starts with any of the values in the array then that value will be removed from string:
use Illuminate\Support\Str;
$url = Str::chopStart('http://laravel.com', ['https://', 'http://']);
// 'laravel.com'
Str::chopEnd()
Str::chopEnd()
Str::chopEnd
メソッドは、指定値が文字列の最後に現れる場合のみ、その値を削除します。The Str::chopEnd
method removes the last occurrence of the given value only if the value appears at the end of the string:
use Illuminate\Support\Str;
$url = Str::chopEnd('app/Models/Photograph.php', '.php');
// 'app/Models/Photograph'
第2引数へ配列を渡すこともできます。文字列が配列のいずれかの値で終わる場合、その値を文字列から削除します。You may also pass an array as the second argument. If the string ends with any of the values in the array then that value will be removed from string:
use Illuminate\Support\Str;
$url = Str::chopEnd('laravel.com/index.php', ['/index.html', '/index.php']);
// 'laravel.com'
Str::contains()
Str::contains()
Str::contains
メソッドは、指定文字列に指定値が含まれているかどうかを判別します。このメソッドはデフォルトで、大文字と小文字を区別します。The Str::contains
method determines if the given string contains the given value. By default this method is case sensitive:
use Illuminate\Support\Str;
$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 in the array:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true
ignoreCase
引数をtrue
へ設定することで、大文字小文字を区別しないようにできます。You may disable case sensitivity by setting the ignoreCase
argument to true
:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', 'MY', ignoreCase: true);
// true
Str::containsAll()
Str::containsAll()
Str::containsAll
メソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。The Str::containsAll
method determines if the given string contains all of the values in a given array:
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true
ignoreCase
引数をtrue
へ設定することで、大文字小文字を区別しないようにできます。You may disable case sensitivity by setting the ignoreCase
argument to true
:
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['MY', 'NAME'], ignoreCase: true);
// true
Str::doesntContain()
Str::doesntContain()
Str::doesntContain
メソッドは、指定文字列に指定値が含まれていないことを判別します。このメソッドはデフォルトで、大文字と小文字を区別します。The Str::doesntContain
method determines if the given string doesn't contain the given value. By default this method is case sensitive:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', 'my');
// true
値の配列を渡して、指定文字列に配列内の値が一つも含まれていないことを判断することもできます。You may also pass an array of values to determine if the given string doesn't contain any of the values in the array:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', ['my', 'foo']);
// true
ignoreCase
引数をtrue
へ設定することで、大文字小文字を区別しないようにできます。You may disable case sensitivity by setting the ignoreCase
argument to true
:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', 'MY', ignoreCase: true);
// true
Str::deduplicate()
Str::deduplicate()
Str::deduplicate
メソッドは、指定文字列内の連続する文字を、その文字の単一のインスタンスに置き換えます。デフォルトでは、このメソッドはスペースを重複除去します:The Str::deduplicate
method replaces consecutive instances of a character with a single instance of that character in the given string. By default, the method deduplicates spaces:
use Illuminate\Support\Str;
$result = Str::deduplicate('The Laravel Framework');
// The Laravel Framework
メソッドの第2引数に別の文字を渡せば、重複を排除する文字を指定できます。You may specify a different character to deduplicate by passing it in as the second argument to the method:
use Illuminate\Support\Str;
$result = Str::deduplicate('The---Laravel---Framework', '-');
// The-Laravel-Framework
Str::endsWith()
Str::endsWith()
Str::endsWith
メソッドは、最初の文字列が2つ目の引数の文字列で終わっているか判定します。The Str::endsWith
method determines if the given string ends with the given value:
use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', 'name');
// true
値の配列を渡し、指定文字列が配列内の値のいずれかで終わるかどうかを判断することもできます。You may also pass an array of values to determine if the given string ends with any of the values in the array:
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::excerpt()
Str::excerpt()
Str::excerpt
メソッドは指定した文字列から、その文字列内のフレーズの最初のインスタンスにマッチする部分を抜き出します。The Str::excerpt
method extracts an excerpt from a given string that matches the first instance of a phrase within that string:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'my', [
'radius' => 3
]);
// '...is my na...'
radius
オプションはデフォルトが100
で、抜き出した文字列の両側に表示する文字数を定義します。The radius
option, which defaults to 100
, allows you to define the number of characters that should appear on each side of the truncated string.
さらに、omission
オプションを使い、抜き出した文字列の前後に追加する文字列を定義できます。In addition, you may use the omission
option to define the string that will be prepended and appended to the truncated string:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'
Str::finish()
Str::finish()
Str::finish
メソッドは、指定値で終わっていない場合、その値の単一のインスタンスを文字列に追加します。The Str::finish
method adds a single instance of the given value to a string if it does not already end with that value:
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/
Str::headline()
Str::headline()
Str::headline
メソッドは、大・小文字、ハイフン、アンダースコアにより区切られた文字列から、各単語の最初の文字を大文字にしたスペース区切りの文字列へ変換します。The Str::headline
method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:
use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent
Str::inlineMarkdown()
Str::inlineMarkdown()
Str::inlineMarkdown
メソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdown
メソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。The Str::inlineMarkdown
method converts GitHub flavored Markdown into inline HTML using CommonMark[https://commonmark.thephpleague.com/]. However, unlike the markdown
method, it does not wrap all generated HTML in a block-level element:
use Illuminate\Support\Str;
$html = Str::inlineMarkdown('**Laravel**');
// <strong>Laravel</strong>
Markdownの安全性Markdown Security
デフォルトでMarkdownは素のHTMLをサポートしており、ユーザー入力を直接使用すると、クロスサイト・スクリプティング(XSS)の脆弱性が生まれます。CommonMarkの安全性のドキュメントにあるように、html_input
オプションを使い、素のHTMLをエスケープ処理もしくは除去できます。また、allow_unsafe_links
オプションを使って安全でないリンクを許可するかも指定できます。素のHTMLを許可する必要がある場合は、コンパイル済みのMarkdownをHTML Purifierへ通す必要があります。By default, Markdown supports raw HTML, which will expose Cross-Site Scripting (XSS) vulnerabilities when used with raw user input. As per the CommonMark Security documentation[https://commonmark.thephpleague.com/security/], you may use the html_input
option to either escape or strip raw HTML, and the allow_unsafe_links
option to specify whether to allow unsafe links. If you need to allow some raw HTML, you should pass your compiled Markdown through an HTML Purifier:
use Illuminate\Support\Str;
Str::inlineMarkdown('Inject: <script>alert("Hello XSS!");</script>', [
'html_input' => 'strip',
'allow_unsafe_links' => false,
]);
// Inject: alert("Hello XSS!");
Str::is()
Str::is()
Str::is
メソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクをワイルドカード値として使用できます。The Str::is
method determines if a given string matches a given pattern. Asterisks may be used as wildcard values:
use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false
Str::isAscii()
Str::isAscii()
Str::isAscii
メソッドは、指定文字列が7ビットASCIIであるかを判定します。The Str::isAscii
method determines if a given string is 7 bit ASCII:
use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// false
Str::isJson()
Str::isJson()
Str::isJson
メソッドは、指定文字列が有効なJSONであるかを判定します。The Str::isJson
method determines if the given string is valid JSON:
use Illuminate\Support\Str;
$result = Str::isJson('[1,2,3]');
// true
$result = Str::isJson('{"first": "John", "last": "Doe"}');
// true
$result = Str::isJson('{first: "John", last: "Doe"}');
// false
Str::isUrl()
Str::isUrl()
Str::isUrl
メソッドは、指定文字列が有効なURLかを判定します。The Str::isUrl
method determines if the given string is a valid URL:
use Illuminate\Support\Str;
$isUrl = Str::isUrl('http://example.com');
// true
$isUrl = Str::isUrl('laravel');
// false
isUrl
メソッドは幅広いプロトコルを有効とみなします。しかし、isUrl
メソッドへ有効なプロトコルを指定することもできます。The isUrl
method considers a wide range of protocols as valid. However, you may specify the protocols that should be considered valid by providing them to the isUrl
method:
$isUrl = Str::isUrl('http://example.com', ['http', 'https']);
Str::isUlid()
Str::isUlid()
Str::isUlid
メソッドは、指定文字列が有効なULIDであることを判定します。The Str::isUlid
method determines if the given string is a valid ULID:
use Illuminate\Support\Str;
$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');
// true
$isUlid = Str::isUlid('laravel');
// false
Str::isUuid()
Str::isUuid()
Str::isUuid
メソッドは、指定した文字列が有効なUUIDであることを判定します。The Str::isUuid
method determines if the given string is a valid UUID:
use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false
Str::kebab()
Str::kebab()
Str::kebab
メソッドは、指定した文字列をケバブケース(kebab-case
)に変換します。The Str::kebab
method converts the given string to kebab-case
:
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar
Str::lcfirst()
Str::lcfirst()
Str::lcfirst
メソッドは、指定した文字列の最初の文字を小文字に変換して返します。The Str::lcfirst
method returns the given string with the first character lowercased:
use Illuminate\Support\Str;
$string = Str::lcfirst('Foo Bar');
// foo Bar
Str::length()
Str::length()
Str::length
メソッドは、指定文字列の長さを返します。The Str::length
method returns the length of the given string:
use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7
Str::limit()
Str::limit()
Str::limit
メソッドは、指定文字列を指定する長さへ切り捨てます。The Str::limit
method truncates the given string to the specified length:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...
メソッドに3番目の引数を渡し、切り捨てる文字列の末尾へ追加する文字列を変更できます。You may pass a third argument to the method to change the string that will be appended to the end of the truncated string:
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)
文字列を切り詰める際に完全な単語を保持したい場合は、preserveWords
引数を使用します。この引数がtrue
の場合、文字列を完全な単語に最も近い境界で切り捨てます。If you would like to preserve complete words when truncating the string, you may utilize the preserveWords
argument. When this argument is true
, the string will be truncated to the nearest complete word boundary:
$truncated = Str::limit('The quick brown fox', 12, preserveWords: true);
// The quick...
Str::lower()
Str::lower()
Str::lower
メソッドは指定文字列を小文字に変換します。The Str::lower
method converts the given string to lowercase:
use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel
Str::markdown()
Str::markdown()
Str::markdown
メソッドは、GitHub風なマークダウンをHTMLへ、CommonMarkを用い変換します。The Str::markdown
method converts GitHub flavored Markdown into HTML using CommonMark[https://commonmark.thephpleague.com/]:
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>
Markdownの安全性Markdown Security
デフォルトでMarkdownは素のHTMLをサポートしており、ユーザー入力を直接使用すると、クロスサイト・スクリプティング(XSS)の脆弱性が生まれます。CommonMarkの安全性のドキュメントにあるように、html_input
オプションを使い、素のHTMLをエスケープ処理もしくは除去できます。また、allow_unsafe_links
オプションを使って安全でないリンクを許可するかも指定できます。素のHTMLを許可する必要がある場合は、コンパイル済みのMarkdownをHTML Purifierへ通す必要があります。By default, Markdown supports raw HTML, which will expose Cross-Site Scripting (XSS) vulnerabilities when used with raw user input. As per the CommonMark Security documentation[https://commonmark.thephpleague.com/security/], you may use the html_input
option to either escape or strip raw HTML, and the allow_unsafe_links
option to specify whether to allow unsafe links. If you need to allow some raw HTML, you should pass your compiled Markdown through an HTML Purifier:
use Illuminate\Support\Str;
Str::markdown('Inject: <script>alert("Hello XSS!");</script>', [
'html_input' => 'strip',
'allow_unsafe_links' => false,
]);
// <p>Inject: alert("Hello XSS!");</p>
Str::mask()
Str::mask()
Str::mask
メソッドは、文字列の一部を繰り返し文字でマスクし、メールアドレスや電話番号などの文字列の一部を難読化するために使用します。The Str::mask
method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:
use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 3);
// tay***************
必要であれば、mask
メソッドの第3引数に負の数を指定し、文字列の最後から指定する文字数分戻った箇所からマスキングを開始するように指示できます。If needed, you provide a negative number as the third argument to the mask
method, which will instruct the method to begin masking at the given distance from the end of the string:
$string = Str::mask('taylor@example.com', '*', -15, 3);
// tay***@example.com
Str::orderedUuid()
Str::orderedUuid()
Str::orderedUuid
メソッドは、インデックス付きデータベース列に効率的に格納できる「タイムスタンプファースト」UUIDを生成します。このメソッドを使用して生成した各UUIDは、以前にこのメソッドを使用して生成されたUUIDの後にソートされます。The Str::orderedUuid
method generates a "timestamp first" UUID that may be efficiently stored in an indexed database column. Each UUID that is generated using this method will be sorted after UUIDs previously generated using the method:
use Illuminate\Support\Str;
return (string) Str::orderedUuid();
Str::padBoth()
Str::padBoth()
Str::padBoth
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。The Str::padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padBoth('James', 10, '_');
// '__James___'
$padded = Str::padBoth('James', 10);
// ' James '
Str::padLeft()
Str::padLeft()
String::padLeft
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。The Str::padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until the final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// ' James'
Str::padRight()
Str::padRight()
String::padRight
メソッドは、PHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。The Str::padRight
method wraps PHP's str_pad
function, padding the right side of a string with another string until the final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James '
Str::password()
Str::password()
Str::password
メソッドは、指定した長さの安全でランダムなパスワードを生成します。パスワードは文字、数字、シンボル、スペースの組み合わせで構成します。パスワードの長さは、デフォルトで32文字です。The Str::password
method may be used to generate a secure, random password of a given length. The password will consist of a combination of letters, numbers, symbols, and spaces. By default, passwords are 32 characters long:
use Illuminate\Support\Str;
$password = Str::password();
// 'EbJo2vE-AS:U,$%_gkrV4n,q~1xy/-_4'
$password = Str::password(12);
// 'qwuar>#V|i]N'
Str::plural()
Str::plural()
Str::plural
メソッドは、単数形の単語文字列を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The Str::plural
method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$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:
use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child
Str::pluralStudly()
Str::pluralStudly()
Str::pluralStudly
メソッドは、アッパーキャメルケースでフォーマットされた文字列の単語を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The Str::pluralStudly
method converts a singular word string formatted in studly caps case to its plural form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman');
// VerifiedHumans
$plural = Str::pluralStudly('UserFeedback');
// UserFeedback
整数をこのメソッドの第2引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHuman
Str::position()
Str::position()
Str::position
メソッドは、文字列内で部分文字列が最初に出現する位置を返します。部分文字列が指定した文字列内に存在しない場合は、false
を返します。The Str::position
method returns the position of the first occurrence of a substring in a string. If the substring does not exist in the given string, false
is returned:
use Illuminate\Support\Str;
$position = Str::position('Hello, World!', 'Hello');
// 0
$position = Str::position('Hello, World!', 'W');
// 7
Str::random()
Str::random()
Str::random
メソッドは指定した長さのランダムな文字列を生成します。このメソッドは、PHPのrandom_bytes
関数を使用します。The Str::random
method generates a random string of the specified length. This function uses PHP's random_bytes
function:
use Illuminate\Support\Str;
$random = Str::random(40);
テスト中に、Str::random
メソッドが返す値を「Fake」できると便利でしょう。これを行うには、createRandomStringsUsing
メソッドを使用します。During testing, it may be useful to "fake" the value that is returned by the Str::random
method. To accomplish this, you may use the createRandomStringsUsing
method:
Str::createRandomStringsUsing(function () {
return 'fake-random-string';
});
random
メソッドへ、通常通りのランダム文字列の生成に戻るよう指示するには、createRandomStringsNormally
メソッドを呼び出します。To instruct the random
method to return to generating random strings normally, you may invoke the createRandomStringsNormally
method:
Str::createRandomStringsNormally();
Str::remove()
Str::remove()
Str::remove
メソッドは、文字列から指定する値または値の配列を削除します。The Str::remove
method removes the given value or array of values from the string:
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
を渡してください。You may also pass false
as a third argument to the remove
method to ignore case when removing strings.
Str::repeat()
Str::repeat()
Str::repeat
メソッドは、指定文字列を繰り返します。The Str::repeat
method repeats the given string:
use Illuminate\Support\Str;
$string = 'a';
$repeat = Str::repeat($string, 5);
// aaaaa
Str::replace()
Str::replace()
Str::replace
メソッドは、文字列内の指定した文字列を置き換えます。The Str::replace
method replaces a given string within the string:
use Illuminate\Support\Str;
$string = 'Laravel 10.x';
$replaced = Str::replace('10.x', '11.x', $string);
// Laravel 11.x
replace
メソッドは、caseSensitive
引数も指定できます。デフォルトでreplace
メソッドは、大・小文字を区別します。The replace
method also accepts a caseSensitive
argument. By default, the replace
method is case sensitive:
Str::replace('Framework', 'Laravel', caseSensitive: false);
Str::replaceArray()
Str::replaceArray()
Str::replaceArray
メソッドは配列を使い、文字列を指定値へ順番に置き換えます。The Str::replaceArray
method replaces a given value in the string sequentially using an array:
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()
Str::replaceFirst
メソッドは、文字列中で最初に出現した値を指定値で置き換えます。The Str::replaceFirst
method replaces the first occurrence of a given value in a string:
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()
Str::replaceLast
メソッドは、文字列中で最後に出現した値を指定値で置き換えます。The Str::replaceLast
method replaces the last occurrence of a given value in a string:
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::replaceMatches()
Str::replaceMatches()
Str::replaceMatches
メソッドは、パターンと一致する全ての文字列を指定置換文字列に置き換えます。The Str::replaceMatches
method replaces all portions of a string matching a pattern with the given replacement string:
use Illuminate\Support\Str;
$replaced = Str::replaceMatches(
pattern: '/[^A-Za-z0-9]++/',
replace: '',
subject: '(+1) 501-555-1000'
)
// '15015551000'
replaceMatches
メソッドは、指定パターンと一致する文字列の各部分で呼び出すクロージャも引数に取ります。クロージャ内で置換ロジックを実行し、置換済みの値を返してください。The replaceMatches
method also accepts a closure that will be invoked with each portion of the string matching the given pattern, allowing you to perform the replacement logic within the closure and return the replaced value:
use Illuminate\Support\Str;
$replaced = Str::replaceMatches('/\d/', function (array $matches) {
return '['.$matches[0].']';
}, '123');
// '[1][2][3]'
Str::replaceStart()
Str::replaceStart()
Str::replaceStart
メソッドは、指定値が文字列の最初に現れる場合のみ、その値を置き換えます。The Str::replaceStart
method replaces the first occurrence of the given value only if the value appears at the start of the string:
use Illuminate\Support\Str;
$replaced = Str::replaceStart('Hello', 'Laravel', 'Hello World');
// Laravel World
$replaced = Str::replaceStart('World', 'Laravel', 'Hello World');
// Hello World
Str::replaceEnd()
Str::replaceEnd()
Str::replaceEnd
メソッドは、指定値が文字列の最後に現れる場合のみ、その値を置き換えます。The Str::replaceEnd
method replaces the last occurrence of the given value only if the value appears at the end of the string:
use Illuminate\Support\Str;
$replaced = Str::replaceEnd('World', 'Laravel', 'Hello World');
// Hello Laravel
$replaced = Str::replaceEnd('Hello', 'Laravel', 'Hello World');
// Hello World
Str::reverse()
Str::reverse()
Str::reverse
メソッドは、指定文字列を逆順にします。The Str::reverse
method reverses the given string:
use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH
Str::singular()
Str::singular()
Str::singular
メソッドは複数形を単数形へ変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The Str::singular
method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child
Str::slug()
Str::slug()
Str::slug
メソッドは指定された文字列から、URLフレンドリーな「スラグ」を生成します。The Str::slug
method generates a URL friendly "slug" from the given string:
use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-framework
Str::snake()
Str::snake()
Str::snake
メソッドは文字列をスネークケース(snake_case
)に変換します。The Str::snake
method converts the given string to snake_case
:
use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-bar
Str::squish()
Str::squish()
Str::squish
メソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。The Str::squish
method removes all extraneous white space from a string, including extraneous white space between words:
use Illuminate\Support\Str;
$string = Str::squish(' laravel framework ');
// laravel framework
Str::start()
Str::start()
Str::start
メソッドは、文字列が指定値で開始されていない場合、その値の単一インスタンスを文字列の前に追加します。The Str::start
method adds a single instance of the given value to a string if it does not already start with that value:
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string
Str::startsWith()
Str::startsWith()
Str::startsWith
メソッドは指定文字列が、2番めの引数の文字列で始まっているか判定します。The Str::startsWith
method determines if the given string begins with the given value:
use Illuminate\Support\Str;
$result = Str::startsWith('This is my name', 'This');
// true
可能な値の配列が渡された場合、startsWith
メソッドは、文字列が与えられた値のいずれかで始まる場合にtrue
を返します。If an array of possible values is passed, the startsWith
method will return true
if the string begins with any of the given values:
$result = Str::startsWith('This is my name', ['This', 'That', 'There']);
// true
Str::studly()
Str::studly()
Str::studly
メソッドは文字列をアッパーキャメルケース(StudlyCase
)に変換します。The Str::studly
method converts the given string to StudlyCase
:
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar
Str::substr()
Str::substr()
Str::substr
メソッドは開始位置と文字列長の引数で指定した部分文字列を返します。The Str::substr
method returns the portion of string specified by the start and length parameters:
use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// Laravel
Str::substrCount()
Str::substrCount()
Str::substrCount
メソッドは、指定する文字列内に指定値がいくつ存在しているか返します。The Str::substrCount
method returns the number of occurrences of a given value in the given string:
use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2
Str::substrReplace()
Str::substrReplace()
Str::substrReplace
メソッドは、文字列の一部分のテキストを置き換えます。第3引数で指定した位置から始まり、第4引数で指定した文字数分を置き換えます。このメソッドの第4引数へ0
を渡すと、文字列内の既存の文字を一切置き換えず、指定位置に文字列を挿入します。The Str::substrReplace
method replaces text within a portion of a string, starting at the position specified by the third argument and replacing the number of characters specified by the fourth argument. Passing 0
to the method's fourth argument will insert the string at the specified position without replacing any of the existing characters in the string:
use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2);
// 13:
$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00
Str::swap()
Str::swap()
Str::swap
メソッドは、PHPのstrtr
関数を使い、指定した文字列中の複数の値を置き換えます。The Str::swap
method replaces multiple values in the given string using PHP's strtr
function:
use Illuminate\Support\Str;
$string = Str::swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
], 'Tacos are great!');
// Burritos are fantastic!
Str::take()
Str::take()
Str::take
メソッドは、文字列の先頭から指定した文字数を返します。The Str::take
method returns a specified number of characters from the beginning of a string:
use Illuminate\Support\Str;
$taken = Str::take('Build something amazing!', 5);
// Build
Str::title()
Str::title()
Str::title
メソッドは、指定された文字列をタイトルケース(Title Case
)へ変換します。The Str::title
method converts the given string to Title Case
:
use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case
Str::toBase64()
Str::toBase64()
Str::toBase64
メソッドは、指定文字列をBase64へ変換します。The Str::toBase64
method converts the given string to Base64:
use Illuminate\Support\Str;
$base64 = Str::toBase64('Laravel');
// TGFyYXZlbA==
Str::toHtmlString()
Str::toHtmlString()
Str::toHtmlString
メソッドは、文字列インスタンスをIlluminate\Support\HtmlString
インスタンスに変換し、Blade テンプレートで表示できるようにします。The Str::toHtmlString
method converts the string instance to an instance of Illuminate\Support\HtmlString
, which may be displayed in Blade templates:
use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();
Str::transliterate()
Str::transliterate()
Str::transliterate
メソッドは、指定文字列を最も近いASCII表現に変換しようと試みます。The Str::transliterate
method will attempt to convert a given string into its closest ASCII representation:
use Illuminate\Support\Str;
$email = Str::transliterate('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ');
// 'test@laravel.com'
Str::trim()
Str::trim()
Str::trim
メソッドは、指定した文字列の先頭と末尾から空白文字 (またはその他の文字) を除去します。PHPネイティブのtrim
関数と異なり、Str::trim
メソッドはユニコードの空白文字も除去します。The Str::trim
method strips whitespace (or other characters) from the beginning and end of the given string. Unlike PHP's native trim
function, the Str::trim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::trim(' foo bar ');
// 'foo bar'
Str::ltrim()
Str::ltrim()
Str::ltrim
メソッドは、指定した文字列の先頭から空白文字 (またはその他の文字) を除去します。PHPネイティブのltrim
関数と異なり、Str::ltrim
メソッドはユニコードの空白文字も除去します。The Str::ltrim
method strips whitespace (or other characters) from the beginning of the given string. Unlike PHP's native ltrim
function, the Str::ltrim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::ltrim(' foo bar ');
// 'foo bar '
Str::rtrim()
Str::rtrim()
Str::rtrim
メソッドは、与えられた文字列の末尾から空白文字 (またはその他の文字) を除去します。PHPネイティブのrtrim
関数と異なり、Str::rtrim
メソッドはユニコードの空白文字も除去します。The Str::rtrim
method strips whitespace (or other characters) from the end of the given string. Unlike PHP's native rtrim
function, the Str::rtrim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::rtrim(' foo bar ');
// ' foo bar'
Str::ucfirst()
Str::ucfirst()
Str::ucfirst
メソッドは、指定文字列の最初の文字を大文字にして返します。The Str::ucfirst
method returns the given string with the first character capitalized:
use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo bar
Str::ucsplit()
Str::ucsplit()
Str::ucsplit
メソッドは、指定した文字列を文字列を大文字で分割して配列にします。The Str::ucsplit
method splits the given string into an array by uppercase characters:
use Illuminate\Support\Str;
$segments = Str::ucsplit('FooBar');
// [0 => 'Foo', 1 => 'Bar']
Str::upper()
Str::upper()
Str::upper
メソッドは、指定文字列を大文字に変換します。The Str::upper
method converts the given string to uppercase:
use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL
Str::ulid()
Str::ulid()
Str::ulid
メソッドは、コンパクトで時間順に並んだ一意の識別子であるULIDを生成します。The Str::ulid
method generates a ULID, which is a compact, time-ordered unique identifier:
use Illuminate\Support\Str;
return (string) Str::ulid();
// 01gd6r360bp37zj17nxb55yv40
指定したULIDが作成された日時を表すIlluminate\Support\Carbon
日付インスタンスを取得したい場合、LaravelのCarbon統合が提供しているcreateFromId
メソッドを使用してください。If you would like to retrieve a Illuminate\Support\Carbon
date instance representing the date and time that a given ULID was created, you may use the createFromId
method provided by Laravel's Carbon integration:
use Illuminate\Support\Carbon;
use Illuminate\Support\Str;
$date = Carbon::createFromId((string) Str::ulid());
テスト中に、Str::ulid
メソッドが返す値を「Fake」できると便利でしょう。これを行うには、createUlidsUsing
メソッドを使用します。During testing, it may be useful to "fake" the value that is returned by the Str::ulid
method. To accomplish this, you may use the createUlidsUsing
method:
use Symfony\Component\Uid\Ulid;
Str::createUlidsUsing(function () {
return new Ulid('01HRDBNHHCKNW2AK4Z29SN82T9');
});
ulid
メソッドへ、通常通りのランダム文字列の生成に戻るよう指示するには、createUlidsNormally
メソッドを呼び出します。To instruct the ulid
method to return to generating ULIDs normally, you may invoke the createUlidsNormally
method:
Str::createUlidsNormally();
Str::unwrap()
Str::unwrap()
Str::unwrap
メソッドは、指定文字列の先頭と末尾から指定文字列を取り除きます。The Str::unwrap
method removes the specified strings from the beginning and end of a given string:
use Illuminate\Support\Str;
Str::unwrap('-Laravel-', '-');
// Laravel
Str::unwrap('{framework: "Laravel"}', '{', '}');
// framework: "Laravel"
Str::uuid()
Str::uuid()
Str::uuid
メソッドは、UUID(バージョン4)を生成します。The Str::uuid
method generates a UUID (version 4):
use Illuminate\Support\Str;
return (string) Str::uuid();
テスト中に、Str::uuid
メソッドが返す値を「Fake」できると便利でしょう。これを行うには、createUuidsUsing
メソッドを使用します。During testing, it may be useful to "fake" the value that is returned by the Str::uuid
method. To accomplish this, you may use the createUuidsUsing
method:
use Ramsey\Uuid\Uuid;
Str::createUuidsUsing(function () {
return Uuid::fromString('eadbfeac-5258-45c2-bab7-ccb9b5ef74f9');
});
uuid
メソッドへ、通常通りのランダム文字列の生成に戻るよう指示するには、createUuidsNormally
メソッドを呼び出します。To instruct the uuid
method to return to generating UUIDs normally, you may invoke the createUuidsNormally
method:
Str::createUuidsNormally();
Str::wordCount()
Str::wordCount()
Str::wordCount
関数は、文字列に含まれる単語の数を返します。The Str::wordCount
method returns the number of words that a string contains:
use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2
Str::wordWrap()
Str::wordWrap()
Str::wordWrap
メソッドは、文字列を指定文字数で折り返します。The Str::wordWrap
method wraps a string to a given number of characters:
use Illuminate\Support\Str;
$text = "The quick brown fox jumped over the lazy dog."
Str::wordWrap($text, characters: 20, break: "<br />\n");
/*
The quick brown fox<br />
jumped over the lazy<br />
dog.
*/
Str::words()
Str::words()
Str::words
メソッドは、文字列内の単語数を制限します。3番目の引数で、切り捨てた文字列の末尾に追加する文字列を指定できます。The Str::words
method limits the number of words in a string. An additional string may be passed to this method via its third argument to specify which string should be appended to the end of the truncated string:
use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>
Str::wrap()
Str::wrap()
Str::wrap
メソッドは、指定文字列を追加の文字列か文字列のペアでラップします。The Str::wrap
method wraps the given string with an additional string or pair of strings:
use Illuminate\Support\Str;
Str::wrap('Laravel', '"');
// "Laravel"
Str::wrap('is', before: 'This ', after: ' Laravel!');
// This is Laravel!
str()
str()
str
関数は、指定した文字列の新しいIlluminate\Support\Stringable
インスタンスを返します。この関数は Str::of
メソッドと等価です。The str
function returns a new Illuminate\Support\Stringable
instance of the given string. This function is equivalent to the Str::of
method:
$string = str('Taylor')->append(' Otwell');
// 'Taylor Otwell'
str
関数に引数を与えなかった場合、Illuminate\Support\Str
のインスタンスを返します。If no argument is provided to the str
function, the function returns an instance of Illuminate\Support\Str
:
$snake = str()->snake('FooBar');
// 'foo_bar'
trans()
trans()
trans
関数は、指定した翻訳キーを言語ファイルを使い、翻訳します。The trans
function translates the given translation key using your language 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()
trans_choice()
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.
Fluent文字列Fluent Strings
Fluent文字列は読み書きしやすい(fluent)、オブジェクト指向で、複数の文字列操作をチェーンできるインターフェイスを提供します。古典的な文字列操作に比較すると、複数の文字列操作を読みやすい文法で使用できます。Fluent strings provide a more fluent, object-oriented interface for working with string values, allowing you to chain multiple string operations together using a more readable syntax compared to traditional string operations.
after
after
after
関数は、指定値に続く文字列をすべて返します。文字列中に指定値が存在しない場合は、文字列全体を返します。The after
method returns everything after the given value in a string. The entire string will be returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->after('This is');
// ' my name'
afterLast
afterLast
afterLast
メソッドは、文字列で指定値が最後に現れる場所から、後ろの部分を返します。文字列中に指定値が存在しない場合は、文字列全体を返します。The afterLast
method returns everything after the last occurrence of the given value in a string. The entire string will be returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');
// 'Controller'
apa
apa
apa
メソッドは指定文字列をAPAガイドラインに従ってタイトルケースに変換します。The apa
method converts the given string to title case following the APA guidelines[https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case]:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->apa();
// A Nice Title Uses the Correct Case
append
append
append
メソッドは、指定値を文字列へ追加します。The append
method appends the given values to the string:
use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'
ascii
ascii
ascii
メソッドは、文字列をアスキー値への変換を試みます。The ascii
method will attempt to transliterate the string into an ASCII value:
use Illuminate\Support\Str;
$string = Str::of('ü')->ascii();
// 'u'
basename
basename
basename
メソッドは、文字列の最後の名前部分を返します。The basename
method will return the trailing name component of the given string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->basename();
// 'baz'
必要であれば、最後の部分から削除したい「拡張子」を指定できます。If needed, you may provide an "extension" that will be removed from the trailing component:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');
// 'baz'
before
before
before
関数は、文字列中の指定値より前の文字列を全部返しますThe before
method returns everything before the given value in a string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->before('my name');
// 'This is '
beforeLast
beforeLast
beforeLast
メソッドは、文字列中で最初に指定値が現れる場所から、前の部分を返します。The beforeLast
method returns everything before the last occurrence of the given value in a string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->beforeLast('is');
// 'This '
between
between
between
メソッドは、2つの値の間にある文字列を返します。The between
method returns the portion of a string between two values:
use Illuminate\Support\Str;
$converted = Str::of('This is my name')->between('This', 'name');
// ' is my '
betweenFirst
betweenFirst
betweenFirst
メソッドは、2つの値の間にある文字列のうち、可能な限り小さい部分を返します。The betweenFirst
method returns the smallest possible portion of a string between two values:
use Illuminate\Support\Str;
$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');
// 'a'
camel
camel
camel
メソッドは、文字列をキャメルケース(camelCase
)へ変換しますThe camel
method converts the given string to camelCase
:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// 'fooBar'
charAt
charAt
charAt
メソッドは指定インデックスの文字を返します。インデックスが範囲外の場合はfalse
を返します。The charAt
method returns the character at the specified index. If the index is out of bounds, false
is returned:
use Illuminate\Support\Str;
$character = Str::of('This is my name.')->charAt(6);
// 's'
classBasename
classBasename
classBasename
メソッドは、指定したクラスから名前空間を削除したクラス名を返す。The classBasename
method returns the class name of the given class with the class's namespace removed:
use Illuminate\Support\Str;
$class = Str::of('Foo\Bar\Baz')->classBasename();
// 'Baz'
chopStart
chopStart
chopStart
メソッドは、指定値が文字列の最初に現れる場合のみ、その値を削除します。The chopStart
method removes the first occurrence of the given value only if the value appears at the start of the string:
use Illuminate\Support\Str;
$url = Str::of('https://laravel.com')->chopStart('https://');
// 'laravel.com'
配列を渡すこともできます。文字列が配列のいずれかの値で始まる場合、その値を文字列から取り取きます。You may also pass an array. If the string starts with any of the values in the array then that value will be removed from string:
use Illuminate\Support\Str;
$url = Str::of('http://laravel.com')->chopStart(['https://', 'http://']);
// 'laravel.com'
chopEnd
chopEnd
chopEnd
メソッドは、指定値が文字列の最後に現れる場合のみ、その値を削除します。The chopEnd
method removes the last occurrence of the given value only if the value appears at the end of the string:
use Illuminate\Support\Str;
$url = Str::of('https://laravel.com')->chopEnd('.com');
// 'https://laravel'
配列を渡すこともできます。文字列が配列のいずれかの値で始まる場合、その値を文字列から取り除きます。You may also pass an array. If the string ends with any of the values in the array then that value will be removed from string:
use Illuminate\Support\Str;
$url = Str::of('http://laravel.com')->chopEnd(['.com', '.io']);
// 'http://laravel'
contains
contains
contains
メソッドは、指定された文字列に指定された値が含まれているかどうかを判別します。このメソッドはデフォルトで、大文字と小文字を区別します。The contains
method determines if the given string contains the given value. By default this method is case sensitive:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('my');
// true
値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。You may also pass an array of values to determine if the given string contains any of the values in the array:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains(['my', 'foo']);
// true
ignoreCase
引数をtrue
へ設定することで、大文字小文字を区別しないようにできます。You can disable case sensitivity by setting the ignoreCase
argument to true
:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('MY', ignoreCase: true);
// true
containsAll
containsAll
containsAll
メソッドは、指定文字列に指定配列のすべての値が含まれているかどうかを判別します。The containsAll
method determines if the given string contains all of the values in the given array:
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);
// true
You can disable case sensitivity by setting the ignoreCase
argument to true
:You can disable case sensitivity by setting the ignoreCase
argument to true
:
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['MY', 'NAME'], ignoreCase: true);
// true
deduplicate
deduplicate
Str::deduplicate
メソッドは、指定文字列内の連続する文字を、その文字の単一のインスタンスに置き換えます。デフォルトでは、このメソッドはスペースを重複除去します:The deduplicate
method replaces consecutive instances of a character with a single instance of that character in the given string. By default, the method deduplicates spaces:
use Illuminate\Support\Str;
$result = Str::of('The Laravel Framework')->deduplicate();
// The Laravel Framework
メソッドの第2引数に別の文字を渡せば、重複を排除する文字を指定できます。You may specify a different character to deduplicate by passing it in as the second argument to the method:
use Illuminate\Support\Str;
$result = Str::of('The---Laravel---Framework')->deduplicate('-');
// The-Laravel-Framework
dirname
dirname
dirname
メソッドは、指定文字列の親ディレクトリ部分を返します。The dirname
method returns the parent directory portion of the given string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname();
// '/foo/bar'
必要であれば、文字列からいくつのディレクトリ・レベルを切り捨てるかを指定することもできます。If necessary, you may specify how many directory levels you wish to trim from the string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname(2);
// '/foo'
endsWith
endsWith
endsWith
メソッドは、文字列が指定値で終わっているか判定します。The endsWith
method determines if the given string ends with the given value:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith('name');
// true
値の配列を渡し、指定文字列が配列内の値のいずれかで終わるかどうかを判断することもできます。You may also pass an array of values to determine if the given string ends with any of the values in the array:
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
exactly
メソッドは、文字列と指定値が完全に一致することを判定します。The exactly
method determines if the given string is an exact match with another string:
use Illuminate\Support\Str;
$result = Str::of('Laravel')->exactly('Laravel');
// true
excerpt
excerpt
excerpt
メソッドは文字列内から、その文字列内のフレーズの最初のインスタンスにマッチする部分を抜粋して抜き出します。The excerpt
method extracts an excerpt from the string that matches the first instance of a phrase within that string:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('my', [
'radius' => 3
]);
// '...is my na...'
radius
オプションはデフォルトが100
で、抜き出した文字列の両側に表示する文字数を定義します。The radius
option, which defaults to 100
, allows you to define the number of characters that should appear on each side of the truncated string.
さらに、omission
オプションを使い、抜き出した文字列の前後に追加する文字列を定義できます。In addition, you may use the omission
option to change the string that will be prepended and appended to the truncated string:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'
explode
explode
explode
メソッドは文字列を指定デリミッタで分割し、分割した文字列を含むコレクションを返します。The explode
method splits the string by the given delimiter and returns a collection containing each section of the split string:
use Illuminate\Support\Str;
$collection = Str::of('foo bar baz')->explode(' ');
// collect(['foo', 'bar', 'baz'])
finish
finish
finish
メソッドは、文字列が指定値で終わっていない場合、その値の単一のインスタンスを追加します。The finish
method adds a single instance of the given value to a string if it does not already end with that value:
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->finish('/');
// this/string/
$adjusted = Str::of('this/string/')->finish('/');
// this/string/
headline
headline
headline
メソッドは、大小文字、ハイフン、アンダースコアで区切られた文字列の各単語の頭文字を大文字にし、スペースで区切った文字列へ変換します。The headline
method will convert strings delimited by casing, hyphens, or underscores into a space delimited string with each word's first letter capitalized:
use Illuminate\Support\Str;
$headline = Str::of('taylor_otwell')->headline();
// Taylor Otwell
$headline = Str::of('EmailNotificationSent')->headline();
// Email Notification Sent
inlineMarkdown
inlineMarkdown
inlineMarkdown
メソッドは、GitHub仕様のMarkdownをCommonMarkにより、インラインHTMLへ変換します。しかし、markdown
メソッドとは異なり、生成したすべてのHTMLをブロックレベルの要素中へラップはできません。The inlineMarkdown
method converts GitHub flavored Markdown into inline HTML using CommonMark[https://commonmark.thephpleague.com/]. However, unlike the markdown
method, it does not wrap all generated HTML in a block-level element:
use Illuminate\Support\Str;
$html = Str::of('**Laravel**')->inlineMarkdown();
// <strong>Laravel</strong>
Markdownの安全性Markdown Security
デフォルトでMarkdownは素のHTMLをサポートしており、ユーザー入力を直接使用すると、クロスサイト・スクリプティング(XSS)の脆弱性が生まれます。CommonMarkの安全性のドキュメントにあるように、html_input
オプションを使い、素のHTMLをエスケープ処理もしくは除去できます。また、allow_unsafe_links
オプションを使って安全でないリンクを許可するかも指定できます。素のHTMLを許可する必要がある場合は、コンパイル済みのMarkdownをHTML Purifierへ通す必要があります。By default, Markdown supports raw HTML, which will expose Cross-Site Scripting (XSS) vulnerabilities when used with raw user input. As per the CommonMark Security documentation[https://commonmark.thephpleague.com/security/], you may use the html_input
option to either escape or strip raw HTML, and the allow_unsafe_links
option to specify whether to allow unsafe links. If you need to allow some raw HTML, you should pass your compiled Markdown through an HTML Purifier:
use Illuminate\Support\Str;
Str::of('Inject: <script>alert("Hello XSS!");</script>')->inlineMarkdown([
'html_input' => 'strip',
'allow_unsafe_links' => false,
]);
// Inject: alert("Hello XSS!");
is
is
is
メソッドは、指定文字列が指定パターンに一致するかどうかを判別します。アスタリスクはワイルドカード値として使用できますThe is
method determines if a given string matches a given pattern. Asterisks may be used as wildcard values
use Illuminate\Support\Str;
$matches = Str::of('foobar')->is('foo*');
// true
$matches = Str::of('foobar')->is('baz*');
// false
isAscii
isAscii
isAscii
メソッドは、文字列がASCII文字列であるか判定します。The isAscii
method determines if a given string is an ASCII string:
use Illuminate\Support\Str;
$result = Str::of('Taylor')->isAscii();
// true
$result = Str::of('ü')->isAscii();
// false
isEmpty
isEmpty
isEmpty
メソッドは、文字列が空であるか判定します。The isEmpty
method determines if the given string is empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isEmpty();
// true
$result = Str::of('Laravel')->trim()->isEmpty();
// false
isNotEmpty
isNotEmpty
isNotEmpty
メソッドは、文字列が空でないかを判定します。The isNotEmpty
method determines if the given string is not empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isNotEmpty();
// false
$result = Str::of('Laravel')->trim()->isNotEmpty();
// true
isJson
isJson
isJson
メソッドは、指定文字列が有効なJSONであるかを判定します。The isJson
method determines if a given string is valid JSON:
use Illuminate\Support\Str;
$result = Str::of('[1,2,3]')->isJson();
// true
$result = Str::of('{"first": "John", "last": "Doe"}')->isJson();
// true
$result = Str::of('{first: "John", last: "Doe"}')->isJson();
// false
isUlid
isUlid
isUlid
メソッドは、指定文字列が有効なULIDであることを判定します。The isUlid
method determines if a given string is a ULID:
use Illuminate\Support\Str;
$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();
// true
$result = Str::of('Taylor')->isUlid();
// false
isUrl
isUrl
isUrl
メソッドは、指定文字列がURLであるか判定します。The isUrl
method determines if a given string is a URL:
use Illuminate\Support\Str;
$result = Str::of('http://example.com')->isUrl();
// true
$result = Str::of('Taylor')->isUrl();
// false
isUrl
メソッドは幅広いプロトコルを有効とみなします。しかし、isUrl
メソッドへ有効なプロトコルを指定することもできます。The isUrl
method considers a wide range of protocols as valid. However, you may specify the protocols that should be considered valid by providing them to the isUrl
method:
$result = Str::of('http://example.com')->isUrl(['http', 'https']);
isUuid
isUuid
isUuid
メソッドは、文字列がUUIDかを判定します。The isUuid
method determines if a given string is a UUID:
use Illuminate\Support\Str;
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
// true
$result = Str::of('Taylor')->isUuid();
// false
kebab
kebab
kebab
メソッドは、文字列をケバブケース(kebab-case
)へ変換します。The kebab
method converts the given string to kebab-case
:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->kebab();
// foo-bar
lcfirst
lcfirst
lcfirst
メソッドは、指定した文字列の最初の文字を小文字にしたものを返します。The lcfirst
method returns the given string with the first character lowercased:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->lcfirst();
// foo Bar
length
length
length
メソッドは、文字列の長さを返します。The length
method returns the length of the given string:
use Illuminate\Support\Str;
$length = Str::of('Laravel')->length();
// 7
limit
limit
limit
メソッドは、指定文字列を指定した長さに切り捨てます。The limit
method truncates the given string to the specified length:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);
// The quick brown fox...
2番目の引数を渡して、切り捨てた文字列の末尾に追加する文字列を変更することもできます。You may also pass a second argument to change the string that will be appended to the end of the truncated string:
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
// The quick brown fox (...)
文字列を切り詰める際に完全な単語を保持したい場合は、preserveWords
引数を使用します。この引数がtrue
の場合、文字列を完全な単語に最も近い境界で切り捨てます。If you would like to preserve complete words when truncating the string, you may utilize the preserveWords
argument. When this argument is true
, the string will be truncated to the nearest complete word boundary:
$truncated = Str::of('The quick brown fox')->limit(12, preserveWords: true);
// The quick...
lower
lower
lower
メソッドは、文字列を小文字に変換します。The lower
method converts the given string to lowercase:
use Illuminate\Support\Str;
$result = Str::of('LARAVEL')->lower();
// 'laravel'
markdown
markdown
markdown
メソッドはGitHub風マークダウンをHTMLに変換します。The markdown
method converts GitHub flavored Markdown into 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>
Markdownの安全性Markdown Security
デフォルトでMarkdownは素のHTMLをサポートしており、ユーザー入力を直接使用すると、クロスサイト・スクリプティング(XSS)の脆弱性が生まれます。CommonMarkの安全性のドキュメントにあるように、html_input
オプションを使い、素のHTMLをエスケープ処理もしくは除去できます。また、allow_unsafe_links
オプションを使って安全でないリンクを許可するかも指定できます。素のHTMLを許可する必要がある場合は、コンパイル済みのMarkdownをHTML Purifierへ通す必要があります。By default, Markdown supports raw HTML, which will expose Cross-Site Scripting (XSS) vulnerabilities when used with raw user input. As per the CommonMark Security documentation[https://commonmark.thephpleague.com/security/], you may use the html_input
option to either escape or strip raw HTML, and the allow_unsafe_links
option to specify whether to allow unsafe links. If you need to allow some raw HTML, you should pass your compiled Markdown through an HTML Purifier:
use Illuminate\Support\Str;
Str::of('Inject: <script>alert("Hello XSS!");</script>')->markdown([
'html_input' => 'strip',
'allow_unsafe_links' => false,
]);
// <p>Inject: alert("Hello XSS!");</p>
mask
mask
mask
メソッドは、文字列の一部を繰り返し文字でマスクし、メールアドレスや電話番号など、文字列の一部を難読化するのに使用します。The mask
method masks a portion of a string with a repeated character, and may be used to obfuscate segments of strings such as email addresses and phone numbers:
use Illuminate\Support\Str;
$string = Str::of('taylor@example.com')->mask('*', 3);
// tay***************
必要であれば、mask
メソッドの第3・4引数に負の数を指定し、文字列の最後から指定する文字数分戻った箇所からマスキングを開始するように指示できます。If needed, you may provide negative numbers as the third or fourth argument to the mask
method, which will instruct the method to begin masking at the given distance from the end of the string:
$string = Str::of('taylor@example.com')->mask('*', -15, 3);
// tay***@example.com
$string = Str::of('taylor@example.com')->mask('*', 4, -4);
// tayl**********.com
match
match
match
メソッドは、指定した正規表現パターンに一致する部分文字列を返します。The match
method will return the portion of a string that matches a given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('foo bar')->match('/bar/');
// 'bar'
$result = Str::of('foo bar')->match('/foo (.*)/');
// 'bar'
matchAll
matchAll
matchAll
メソッドは、指定した正規表現パターンに一致した部分文字列を含むコレクションを返します。The matchAll
method will return a collection containing the portions of a string that match a given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('bar foo bar')->matchAll('/bar/');
// collect(['bar', 'bar'])
式の中でマッチさせるグループを指定した場合、Laravelは最初に一致したグループのコレクションを返します。If you specify a matching group within the expression, Laravel will return a collection of the first matching group's matches:
use Illuminate\Support\Str;
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
// collect(['un', 'ly']);
一致しなかった場合は、空のコレクションを返します。If no matches are found, an empty collection will be returned.
isMatch
isMatch
isMatch
メソッドは、文字列が指定正規表現にマッチした場合にtrue
を返します。The isMatch
method will return true
if the string matches a given regular expression:
use Illuminate\Support\Str;
$result = Str::of('foo bar')->isMatch('/foo (.*)/');
// true
$result = Str::of('laravel')->isMatch('/foo (.*)/');
// false
newLine
newLine
newLine
メソッドは、文字列に「行末」コードを追加します。The newLine
method appends an "end of line" character to a string:
use Illuminate\Support\Str;
$padded = Str::of('Laravel')->newLine()->append('Framework');
// 'Laravel
// Framework'
padBoth
padBoth
padBoth
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の両側を別の文字列でパディングします。The padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padBoth(10, '_');
// '__James___'
$padded = Str::of('James')->padBoth(10);
// ' James '
padLeft
padLeft
padLeft
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の左側を別の文字列でパディングします。The padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until the final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padLeft(10, '-=');
// '-=-=-James'
$padded = Str::of('James')->padLeft(10);
// ' James'
padRight
padRight
padRight
メソッドはPHPのstr_pad
関数をラップし、最後の文字列が目的の長さに達するまで、文字列の右側を別の文字列でパディングします。The padRight
method wraps PHP's str_pad
function, padding the right side of a string with another string until the final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padRight(10, '-');
// 'James-----'
$padded = Str::of('James')->padRight(10);
// 'James '
pipe
pipe
pipe
メソッドは、現在の値を指定Callableへ渡すことで、文字列を変換します。The pipe
method allows you to transform the string by passing its current value to the given callable:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');
// 'Checksum: a5c95b86291ea299fcbe64458ed12702'
$closure = Str::of('foo')->pipe(function (Stringable $str) {
return 'bar';
});
// 'bar'
plural
plural
plural
メソッドは、単数形の単語文字列を複数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The plural
method converts a singular word string to its plural form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$plural = Str::of('car')->plural();
// cars
$plural = Str::of('child')->plural();
// children
整数をこのメソッドの第2引数に指定することで、文字列の単数形と複数形を切り替えて取得できます。You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
use Illuminate\Support\Str;
$plural = Str::of('child')->plural(2);
// children
$plural = Str::of('child')->plural(1);
// child
position
position
position
メソッドは、文字列内で部分文字列が最初に出現する位置を返します。部分文字列が指定した文字列内に存在しない場合は、false
を返します。The position
method returns the position of the first occurrence of a substring in a string. If the substring does not exist within the string, false
is returned:
use Illuminate\Support\Str;
$position = Str::of('Hello, World!')->position('Hello');
// 0
$position = Str::of('Hello, World!')->position('W');
// 7
prepend
prepend
prepend
メソッドは、指定値を文字列の先頭へ追加します。The prepend
method prepends the given values onto the string:
use Illuminate\Support\Str;
$string = Str::of('Framework')->prepend('Laravel ');
// Laravel Framework
remove
remove
remove
メソッドは、指定する値か文字列の配列を文字列から削除します。The remove
method removes the given value or array of values from the string:
use Illuminate\Support\Str;
$string = Str::of('Arkansas is quite beautiful!')->remove('quite');
// Arkansas is beautiful!
文字列削除時にケースを無視するため2番目のパラメータへfalse
を渡すこともできます。You may also pass false
as a second parameter to ignore case when removing strings.
repeat
repeat
repeat
メソッドは、指定文字列を繰り返します。The repeat
method repeats the given string:
use Illuminate\Support\Str;
$repeated = Str::of('a')->repeat(5);
// aaaaa
replace
replace
replace
メソッドは、文字列中の指定値を置き換えます。The replace
method replaces a given string within the string:
use Illuminate\Support\Str;
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
// Laravel 7.x
replace
メソッドは、caseSensitive
引数も指定できます。デフォルトでreplace
メソッドは、大・小文字を区別します。The replace
method also accepts a caseSensitive
argument. By default, the replace
method is case sensitive:
$replaced = Str::of('macOS 13.x')->replace(
'macOS', 'iOS', caseSensitive: false
);
replaceArray
replaceArray
replaceArray
メソッドは、配列を使用して文字列中の指定値を置き換えます。The replaceArray
method replaces a given value in the string sequentially using an array:
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
replaceFirst
メソッドは、文字列中で最初に現れた指定値を置き換えます。The replaceFirst
method replaces the first occurrence of a given value in a string:
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
replaceLast
メソッドは文字列中で最後に現れた指定値を置き換えます。The replaceLast
method replaces the last occurrence of a given value in a string:
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
replaceMatches
メソッドは、パターンに一致する文字列のすべての部分を、指定した置換文字列で置き換えます。The replaceMatches
method replaces all portions of a string matching a pattern with the given replacement string:
use Illuminate\Support\Str;
$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')
// '15015551000'
replaceMatches
メソッドは、指定パターンと一致する文字列の各部分で呼び出すクロージャも引数に取ります。クロージャ内で置換ロジックを実行し、置換済みの値を返してください。The replaceMatches
method also accepts a closure that will be invoked with each portion of the string matching the given pattern, allowing you to perform the replacement logic within the closure and return the replaced value:
use Illuminate\Support\Str;
$replaced = Str::of('123')->replaceMatches('/\d/', function (array $matches) {
return '['.$matches[0].']';
});
// '[1][2][3]'
replaceStart
replaceStart
replaceStart
メソッドは、指定値が文字列の最初に現れる場合のみ、その値を置き換えます。The replaceStart
method replaces the first occurrence of the given value only if the value appears at the start of the string:
use Illuminate\Support\Str;
$replaced = Str::of('Hello World')->replaceStart('Hello', 'Laravel');
// Laravel World
$replaced = Str::of('Hello World')->replaceStart('World', 'Laravel');
// Hello World
replaceEnd
replaceEnd
replaceEnd
メソッドは、与えられた値が文字列の最後に現れる場合のみ、その値を置き換えます。The replaceEnd
method replaces the last occurrence of the given value only if the value appears at the end of the string:
use Illuminate\Support\Str;
$replaced = Str::of('Hello World')->replaceEnd('World', 'Laravel');
// Hello Laravel
$replaced = Str::of('Hello World')->replaceEnd('Hello', 'Laravel');
// Hello World
scan
scan
scan
メソッドは、sscanf
PHP関数がサポートするフォーマットに従い、文字列からコレクションへの入力をパースします。The scan
method parses input from a string into a collection according to a format supported by the sscanf
PHP function[https://www.php.net/manual/en/function.sscanf.php]:
use Illuminate\Support\Str;
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
// collect(['filename', 'jpg'])
singular
singular
singular
メソッドは、単語を単数形に変換します。この関数は、Laravelの複数形化機能により、どんな言語もサポートしています。The singular
method converts a string to its singular form. This function supports any of the languages support by Laravel's pluralizer[/docs/{{version}}/localization#pluralization-language]:
use Illuminate\Support\Str;
$singular = Str::of('cars')->singular();
// car
$singular = Str::of('children')->singular();
// child
slug
slug
slug
メソッドは、文字列をURLフレンドリーな「スラグ」へ変換します。The slug
method generates a URL friendly "slug" from the given string:
use Illuminate\Support\Str;
$slug = Str::of('Laravel Framework')->slug('-');
// laravel-framework
snake
snake
The snake
method converts the given string to snake
メソッドは、文字列をスネークケース(snake_case
)へ変換します。The snake
method converts the given string to snake_case
:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->snake();
// foo_bar
split
split
split
メソッドは正規表現を使い文字列をコレクションへ分割します。The split
method splits a string into a collection using a regular expression:
use Illuminate\Support\Str;
$segments = Str::of('one, two, three')->split('/[\s,]+/');
// collect(["one", "two", "three"])
squish
squish
squish
メソッドは、単語間の余分な空白を含め、文字列から余分な空白をすべて削除します。The squish
method removes all extraneous white space from a string, including extraneous white space between words:
use Illuminate\Support\Str;
$string = Str::of(' laravel framework ')->squish();
// laravel framework
start
start
start
メソッドは、文字列が指定値で開始されていない場合、その値の単一のインスタンスを追加します。The start
method adds a single instance of the given value to a string if it does not already start with that value:
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->start('/');
// /this/string
$adjusted = Str::of('/this/string')->start('/');
// /this/string
startsWith
startsWith
startsWith
メソッドは、文字列が指定値から始まっているかを判定します。The startsWith
method determines if the given string begins with the given value:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->startsWith('This');
// true
stripTags
stripTags
stripTags
メソッドは、文字列からすべてのHTMLタグとPHPタグを削除します。The stripTags
method removes all HTML and PHP tags from a string:
use Illuminate\Support\Str;
$result = Str::of('<a href="https://laravel.com">Taylor <b>Otwell</b></a>')->stripTags();
// Taylor Otwell
$result = Str::of('<a href="https://laravel.com">Taylor <b>Otwell</b></a>')->stripTags('<b>');
// Taylor <b>Otwell</b>
studly
studly
studly
メソッドは、文字列をアッパーキャメルケース(StudlyCase
)へ変換します。The studly
method converts the given string to StudlyCase
:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->studly();
// FooBar
substr
substr
substr
メソッドは、引数で指定された開始位置と長さの部分文字列を返します。The substr
method returns the portion of the string specified by the given start and length parameters:
use Illuminate\Support\Str;
$string = Str::of('Laravel Framework')->substr(8);
// Framework
$string = Str::of('Laravel Framework')->substr(8, 5);
// Frame
substrReplace
substrReplace
substrReplace
メソッドは、文字列の一部分のテキストを置き換えるもので、第2引数で指定した位置から始まり、第3引数で指定した文字数分を置き換えます。このメソッドの第3引数に0
を渡すと、文字列内の既存の文字を一切置き換えることなく、指定された位置に文字列を挿入します。The substrReplace
method replaces text within a portion of a string, starting at the position specified by the second argument and replacing the number of characters specified by the third argument. Passing 0
to the method's third argument will insert the string at the specified position without replacing any of the existing characters in the string:
use Illuminate\Support\Str;
$string = Str::of('1300')->substrReplace(':', 2);
// 13:
$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);
// The Laravel Framework
swap
swap
swap
メソッドは、PHPのstrtr
関数を用いて、文字列内の複数の値を置き換えます。The swap
method replaces multiple values in the string using PHP's strtr
function:
use Illuminate\Support\Str;
$string = Str::of('Tacos are great!')
->swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
]);
// Burritos are fantastic!
take
take
take
メソッドは、文字列の先頭から指定した文字数を返します。The take
method returns a specified number of characters from the beginning of the string:
use Illuminate\Support\Str;
$taken = Str::of('Build something amazing!')->take(5);
// Build
tap
tap
tap
メソッドは文字列を指定クロージャへ渡し、その文字列自体に影響を与えずに文字列を調べ操作することができます。クロージャが返す値に関係なく、tap
メソッドはオリジナルの文字列を返します。The tap
method passes the string to the given closure, allowing you to examine and interact with the string while not affecting the string itself. The original string is returned by the tap
method regardless of what is returned by the closure:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('Laravel')
->append(' Framework')
->tap(function (Stringable $string) {
dump('String after append: '.$string);
})
->upper();
// LARAVEL FRAMEWORK
test
test
test
メソッドは、文字列が指定する正規表現パターンと一致するか判定します。The test
method determines if a string matches the given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('Laravel Framework')->test('/Laravel/');
// true
title
title
title
メソッドは、文字列をタイトルケース(Title Case
)へ変換します。The title
method converts the given string to Title Case
:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->title();
// A Nice Title Uses The Correct Case
toBase64()
toBase64()
toBase64
メソッドは、指定文字列をBase64に変換します。The toBase64
method converts the given string to Base64:
use Illuminate\Support\Str;
$base64 = Str::of('Laravel')->toBase64();
// TGFyYXZlbA==
transliterate
transliterate
transliterate
メソッドは、指定文字列を最も近いASCII表現に変換しようと試みます。The transliterate
method will attempt to convert a given string into its closest ASCII representation:
use Illuminate\Support\Str;
$email = Str::of('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ')->transliterate()
// 'test@laravel.com'
trim
trim
trim
メソッドは指定文字列をトリムします。PHPネイティブのtrim
関数と異なり、Laravelのtrim
メソッドはユニコードの空白文字も除去します。The trim
method trims the given string. Unlike PHP's native trim
function, Laravel's trim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->trim();
// 'Laravel'
$string = Str::of('/Laravel/')->trim('/');
// 'Laravel'
ltrim
ltrim
ltrim
メソッドは指定文字列の左側をトリムします。PHPネイティブのltrim
関数と異なり、Laravelのltrim
メソッドはユニコードの空白文字も除去します。The ltrim
method trims the left side of the string. Unlike PHP's native ltrim
function, Laravel's ltrim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->ltrim();
// 'Laravel '
$string = Str::of('/Laravel/')->ltrim('/');
// 'Laravel/'
rtrim
rtrim
rtrim
メソッドは指定文字列の右側をトリムします。PHPネイティブのrtrim
関数と異なり、Laravelのrtrim
メソッドはユニコードの空白文字も除去します。The rtrim
method trims the right side of the given string. Unlike PHP's native rtrim
function, Laravel's rtrim
method also removes unicode whitespace characters:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->rtrim();
// ' Laravel'
$string = Str::of('/Laravel/')->rtrim('/');
// '/Laravel'
ucfirst
ucfirst
ucfirst
メソッドは、文字列の最初の1文字目を大文字にします。The ucfirst
method returns the given string with the first character capitalized:
use Illuminate\Support\Str;
$string = Str::of('foo bar')->ucfirst();
// Foo bar
ucsplit
ucsplit
ucsplit
メソッドは、指定した文字列を文字列を大文字で分割して配列にします。The ucsplit
method splits the given string into a collection by uppercase characters:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->ucsplit();
// collect(['Foo', 'Bar'])
unwrap
unwrap
unwrap
メソッドは、指定文字列の先頭と末尾から指定文字列を取り除きます。The unwrap
method removes the specified strings from the beginning and end of a given string:
use Illuminate\Support\Str;
Str::of('-Laravel-')->unwrap('-');
// Laravel
Str::of('{framework: "Laravel"}')->unwrap('{', '}');
// framework: "Laravel"
upper
upper
upper
メソッドは、文字列を大文字に変換します。The upper
method converts the given string to uppercase:
use Illuminate\Support\Str;
$adjusted = Str::of('laravel')->upper();
// LARAVEL
when
when
when
メソッドは指定条件がtrue
の場合、指定したクロージャを呼び出します。クロージャは、fluent文字列インスタンスを受け取ります。The when
method invokes the given closure if a given condition is true
. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('Taylor')
->when(true, function (Stringable $string) {
return $string->append(' Otwell');
});
// 'Taylor Otwell'
必要であれば、3番目のパラメータとして別のクロージャをwhen
メソッドに渡せます。このクロージャは、条件パラメータがfalse
と評価された場合に実行します。If necessary, you may pass another closure as the third parameter to the when
method. This closure will execute if the condition parameter evaluates to false
.
whenContains
whenContains
whenContains
メソッドは、文字列が指定値を含んでいる場合に、渡したクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenContains
method invokes the given closure if the string contains the given value. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContains('tony', function (Stringable $string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、when
メソッドの第3パラメータへ、もう一つクロージャを渡せます。このクロージャは、文字列が指定値を含んでいない場合に実行されます。If necessary, you may pass another closure as the third parameter to the when
method. This closure will execute if the string does not contain the given value.
値の配列を渡して、指定文字列に配列内の値が含まれているかどうかを判断することもできます。You may also pass an array of values to determine if the given string contains any of the values in the array:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContains(['tony', 'hulk'], function (Stringable $string) {
return $string->title();
});
// Tony Stark
whenContainsAll
whenContainsAll
whenContainsAll
メソッドは、文字列が指定する部分文字列をすべて含んでいる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenContainsAll
method invokes the given closure if the string contains all of the given sub-strings. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContainsAll(['tony', 'stark'], function (Stringable $string) {
return $string->title();
});
// 'Tony Stark'
必要であれば、3番目のパラメータとして別のクロージャをwhen
メソッドに渡せます。このクロージャは、条件パラメータがfalse
と評価された場合に実行します。If necessary, you may pass another closure as the third parameter to the when
method. This closure will execute if the condition parameter evaluates to false
.
whenEmpty
whenEmpty
文字列が空の場合、whenEmpty
メソッドは指定されたクロージャを呼び出します。クロージャが値を返す場合、その値をwhenEmpty
メソッドも返します。クロージャが値を返さない場合、fluent文字列インスタンスを返します。The whenEmpty
method invokes the given closure if the string is empty. If the closure returns a value, that value will also be returned by the whenEmpty
method. If the closure does not return a value, the fluent string instance will be returned:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of(' ')->whenEmpty(function (Stringable $string) {
return $string->trim()->prepend('Laravel');
});
// 'Laravel'
whenNotEmpty
whenNotEmpty
whenNotEmpty
メソッドは文字列が空でない場合、指定するクロージャを呼び出します。クロージャが値を返す場合は、whenNotEmpty
メソッドもその値を返します 。クロージャが値を返さない場合は、Fluent文字列インスタンスを返します。The whenNotEmpty
method invokes the given closure if the string is not empty. If the closure returns a value, that value will also be returned by the whenNotEmpty
method. If the closure does not return a value, the fluent string instance will be returned:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('Framework')->whenNotEmpty(function (Stringable $string) {
return $string->prepend('Laravel ');
});
// 'Laravel Framework'
whenStartsWith
whenStartsWith
whenStartsWith
メソッドは、文字列が指定する部分文字列から始まる場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenStartsWith
method invokes the given closure if the string starts with the given sub-string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('disney world')->whenStartsWith('disney', function (Stringable $string) {
return $string->title();
});
// 'Disney World'
whenEndsWith
whenEndsWith
whenEndsWith
メソッドは、文字列が指定した部分文字列で終了する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenEndsWith
method invokes the given closure if the string ends with the given sub-string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('disney world')->whenEndsWith('world', function (Stringable $string) {
return $string->title();
});
// 'Disney World'
whenExactly
whenExactly
whenExactly
メソッドは、文字列が指定文字列と厳密に一致する場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenExactly
method invokes the given closure if the string exactly matches the given string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('laravel')->whenExactly('laravel', function (Stringable $string) {
return $string->title();
});
// 'Laravel'
whenNotExactly
whenNotExactly
whenNotExactly
メソッドは、文字列が指定文字列と厳密に一致しない場合に、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenNotExactly
method invokes the given closure if the string does not exactly match the given string. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('framework')->whenNotExactly('laravel', function (Stringable $string) {
return $string->title();
});
// 'Framework'
whenIs
whenIs
whenIs
メソッドは、文字列が与えられたパターンにマッチする場合、指定クロージャを呼び出します。アスタリスクはワイルドカードとして使用できます。クロージャはFluent文字列インスタンスを受け取ります。The whenIs
method invokes the given closure if the string matches a given pattern. Asterisks may be used as wildcard values. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('foo/bar')->whenIs('foo/*', function (Stringable $string) {
return $string->append('/baz');
});
// 'foo/bar/baz'
whenIsAscii
whenIsAscii
whenIsAscii
メソッドは、文字列が7bitのASCIIの場合、クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。The whenIsAscii
method invokes the given closure if the string is 7 bit ASCII. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('laravel')->whenIsAscii(function (Stringable $string) {
return $string->title();
});
// 'Laravel'
whenIsUlid
whenIsUlid
whenIsUlid
メソッドは、文字列が有効なULIDである場合、指定するクロージャを呼び出します。クロージャは、Fluent文字列のインスタンスを受け取ります。The whenIsUlid
method invokes the given closure if the string is a valid ULID. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
return $string->substr(0, 8);
});
// '01gd6r36'
whenIsUuid
whenIsUuid
whenIsUuid
メソッドは、文字列が有効なUUIDである場合、指定クロージャを呼び出します。クロージャは、Fluent文字列インスタンスを受け取ります。The whenIsUuid
method invokes the given closure if the string is a valid UUID. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->whenIsUuid(function (Stringable $string) {
return $string->substr(0, 8);
});
// 'a0a2a2d2'
whenTest
whenTest
whenTest
メソッドは、文字列が正規表現にマッチする場合、指定クロージャを呼び出します。クロージャはFluent文字列インスタンスを受け取ります。The whenTest
method invokes the given closure if the string matches the given regular expression. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('laravel framework')->whenTest('/laravel/', function (Stringable $string) {
return $string->title();
});
// 'Laravel Framework'
wordCount
wordCount
wordcount
メソッドは、文字列に含まれる単語の数を返します。The wordCount
method returns the number of words that a string contains:
use Illuminate\Support\Str;
Str::of('Hello, world!')->wordCount(); // 2
words
words
words
メソッドは、文字列内の単語数を制限します。必要に応じ、切り捨てた文字列に追加する文字列を指定できます。The words
method limits the number of words in a string. If necessary, you may specify an additional string that will be appended to the truncated string:
use Illuminate\Support\Str;
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
// Perfectly balanced, as >>>
wrap
wrap
wrap
メソッドは、指定文字列を追加の文字列または文字列のペアでラップします。The wrap
method wraps the given string with an additional string or pair of strings:
use Illuminate\Support\Str;
Str::of('Laravel')->wrap('"');
// "Laravel"
Str::is('is')->wrap(before: 'This ', after: ' Laravel!');
// This is Laravel!