字串
簡介
Laravel 包含了多種用於操作字串值的功能。這些功能中有許多被框架本身所使用;然而,如果您覺得方便,您可以自由地在您自己的應用程式中使用它們。
可用方法
字串
__class_basenameepreg_replace_arrayStr::afterStr::afterLastStr::apaStr::asciiStr::beforeStr::beforeLastStr::betweenStr::betweenFirstStr::camelStr::charAtStr::chopStartStr::chopEndStr::containsStr::containsAllStr::doesntContainStr::doesntEndWithStr::doesntStartWithStr::deduplicateStr::endsWithStr::excerptStr::finishStr::fromBase64Str::headlineStr::inlineMarkdownStr::isStr::isAsciiStr::isJsonStr::isUlidStr::isUrlStr::isUuidStr::kebabStr::lcfirstStr::lengthStr::limitStr::lowerStr::markdownStr::maskStr::matchStr::matchAllStr::orderedUuidStr::padBothStr::padLeftStr::padRightStr::passwordStr::pluralStr::pluralStudlyStr::positionStr::randomStr::removeStr::repeatStr::replaceStr::replaceArrayStr::replaceFirstStr::replaceLastStr::replaceMatchesStr::replaceStartStr::replaceEndStr::reverseStr::singularStr::slugStr::snakeStr::squishStr::startStr::startsWithStr::studlyStr::substrStr::substrCountStr::substrReplaceStr::swapStr::takeStr::titleStr::toBase64Str::transliterateStr::trimStr::ltrimStr::rtrimStr::ucfirstStr::ucsplitStr::upperStr::ulidStr::unwrapStr::uuidStr::uuid7Str::wordCountStr::wordWrapStr::wordsStr::wrapstrtranstrans_choice
流暢字串
afterafterLastapaappendasciibasenamebeforebeforeLastbetweenbetweenFirstcamelcharAtclassBasenamechopStartchopEndcontainscontainsAlldecryptdeduplicatedirnamedoesntEndWithdoesntStartWithencryptendsWithexactlyexcerptexplodefinishfromBase64hashheadlineinlineMarkdownisisAsciiisEmptyisNotEmptyisJsonisUlidisUrlisUuidkebablcfirstlengthlimitlowermarkdownmaskmatchmatchAllisMatchnewLinepadBothpadLeftpadRightpipepluralpositionprependremoverepeatreplacereplaceArrayreplaceFirstreplaceLastreplaceMatchesreplaceStartreplaceEndscansingularslugsnakesplitsquishstartstartsWithstripTagsstudlysubstrsubstrReplaceswaptaketaptesttitletoBase64toHtmlStringtoUritransliteratetrimltrimrtrimucfirstucsplitunwrapupperwhenwhenContainswhenContainsAllwhenDoesntEndWithwhenDoesntStartWithwhenEmptywhenNotEmptywhenStartsWithwhenEndsWithwhenExactlywhenNotExactlywhenIswhenIsAsciiwhenIsUlidwhenIsUuidwhenTestwordCountwordswrap
字串
__()
__ 函數會使用您的語言檔案來翻譯給定的翻譯字串或翻譯鍵:
echo __('Welcome to our application');
echo __('messages.welcome');如果指定的翻譯字串或鍵不存在,__ 函數將會回傳給定的值。因此,以上述範例來說,如果翻譯鍵 messages.welcome 不存在,__ 函數將會回傳 messages.welcome。
class_basename()
class_basename 函數會回傳給定類別的類別名稱,並移除其命名空間:
$class = class_basename('Foo\Bar\Baz');
// Baze()
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:00Str::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::apa()
Str::apa 方法會根據 APA 指南 將給定字串轉換為標題大小寫:
use Illuminate\Support\Str;
$title = Str::apa('Creating A Project');
// 'Creating a Project'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 方法會回傳字串中兩個值之間的部分:
use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my 'Str::betweenFirst()
Str::betweenFirst 方法會回傳字串中兩個值之間最小的部分:
use Illuminate\Support\Str;
$slice = Str::betweenFirst('[a] bc [d]', '[', ']');
// 'a'Str::camel()
Str::camel 方法會將給定字串轉換為 camelCase:
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// 'fooBar'Str::charAt()
Str::charAt 方法會回傳指定索引位置的字元。如果索引超出範圍,則回傳 false:
use Illuminate\Support\Str;
$character = Str::charAt('This is my name.', 6);
// 's'Str::chopStart()
Str::chopStart 方法會移除給定值的第一次出現,但僅當該值出現在字串開頭時:
use Illuminate\Support\Str;
$url = Str::chopStart('https://laravel.com', 'https://');
// 'laravel.com'您也可以傳入一個陣列作為第二個引數。如果字串以陣列中的任何值開頭,則該值將從字串中移除:
use Illuminate\Support\Str;
$url = Str::chopStart('http://laravel.com', ['https://', 'http://']);
// 'laravel.com'Str::chopEnd()
Str::chopEnd 方法會移除給定值的最後一次出現,但僅當該值出現在字串結尾時:
use Illuminate\Support\Str;
$url = Str::chopEnd('app/Models/Photograph.php', '.php');
// 'app/Models/Photograph'您也可以傳入一個陣列作為第二個引數。如果字串以陣列中的任何值結尾,則該值將從字串中移除:
use Illuminate\Support\Str;
$url = Str::chopEnd('laravel.com/index.php', ['/index.html', '/index.php']);
// 'laravel.com'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您可以將 ignoreCase 引數設定為 true 來停用大小寫區分:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', 'MY', ignoreCase: true);
// trueStr::containsAll()
Str::containsAll 方法會判斷給定字串是否包含給定陣列中的所有值:
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true您可以將 ignoreCase 引數設定為 true 來停用大小寫區分:
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['MY', 'NAME'], ignoreCase: true);
// trueStr::doesntContain()
Str::doesntContain 方法會判斷給定字串是否不包含給定值。預設情況下,此方法會區分大小寫:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', 'my');
// true您也可以傳入一個值陣列,以判斷給定字串是否不包含陣列中的任何值:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', ['my', 'foo']);
// true您可以將 ignoreCase 引數設定為 true 來停用大小寫區分:
use Illuminate\Support\Str;
$doesntContain = Str::doesntContain('This is name', 'MY', ignoreCase: true);
// trueStr::deduplicate()
Str::deduplicate 方法將給定字串中連續出現的字元替換為該字元的一個單一實例。預設情況下,此方法會去除重複的空格:
use Illuminate\Support\Str;
$result = Str::deduplicate('The Laravel Framework');
// The Laravel Framework您可以透過將不同的字元作為第二個參數傳遞給此方法,來指定要去除重複的字元:
use Illuminate\Support\Str;
$result = Str::deduplicate('The---Laravel---Framework', '-');
// The-Laravel-FrameworkStr::doesntEndWith()
Str::doesntEndWith 方法判斷給定字串是否不以給定值結尾:
use Illuminate\Support\Str;
$result = Str::doesntEndWith('This is my name', 'dog');
// true您也可以傳入一個值陣列,以判斷給定字串是否不以陣列中的任何值結尾:
use Illuminate\Support\Str;
$result = Str::doesntEndWith('This is my name', ['this', 'foo']);
// true
$result = Str::doesntEndWith('This is my name', ['name', 'foo']);
// falseStr::doesntStartWith()
Str::doesntStartWith 方法判斷給定字串是否不以給定值開頭:
use Illuminate\Support\Str;
$result = Str::doesntStartWith('This is my name', 'That');
// true如果傳入一個可能值的陣列,doesntStartWith 方法將會在字串不以任何給定值開頭時返回 true:
$result = Str::doesntStartWith('This is my name', ['What', 'That', 'There']);
// trueStr::endsWith()
Str::endsWith 方法判斷給定字串是否以給定值結尾:
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']);
// falseStr::excerpt()
Str::excerpt 方法從給定字串中提取與該字串中首次出現的詞組相符的摘錄:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'my', [
'radius' => 3
]);
// '...is my na...'radius 選項預設為 100,它允許您定義截斷字串兩側應出現的字元數。
此外,您可以使用 omission 選項來定義將預加和附加到截斷字串的字串:
use Illuminate\Support\Str;
$excerpt = Str::excerpt('This is my name', 'name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'Str::finish()
Str::finish 方法會在字串不以給定值結尾時,向字串末尾添加該值的一個單一實例:
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/Str::fromBase64()
Str::fromBase64 方法解碼給定的 Base64 字串:
use Illuminate\Support\Str;
$decoded = Str::fromBase64('TGFyYXZlbA==');
// LaravelStr::headline()
Str::headline 方法會將以大小寫、連字號或底線分隔的字串轉換為以空格分隔的字串,並且每個單字的首字母都會大寫:
use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification SentStr::inlineMarkdown()
Str::inlineMarkdown 方法使用 CommonMark 將 GitHub 風格的 Markdown 轉換為行內 HTML。然而,與 markdown 方法不同的是,它不會將所有生成的 HTML 包裹在區塊級元素中:
use Illuminate\Support\Str;
$html = Str::inlineMarkdown('**Laravel**');
// <strong>Laravel</strong>Markdown 安全性
預設情況下,Markdown 支援原始 HTML,當與原始使用者輸入一起使用時,這將暴露跨網站指令碼 (XSS) 漏洞。根據 CommonMark 安全性文件,您可以使用 html_input 選項來跳脫或移除原始 HTML,並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許部分原始 HTML,您應該透過 HTML Purifier 處理您編譯的 Markdown:
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 方法判斷給定字串是否符合給定模式。星號可用作萬用字元值:
use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false您可以透過將 ignoreCase 參數設定為 true 來停用大小寫敏感度:
use Illuminate\Support\Str;
$matches = Str::is('*.jpg', 'photo.JPG', ignoreCase: true);
// trueStr::isAscii()
Str::isAscii 方法判斷給定字串是否為 7 位元 ASCII:
use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// falseStr::isJson()
Str::isJson 方法判斷給定字串是否為有效的 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"}');
// falseStr::isUrl()
Str::isUrl 方法判斷給定字串是否為有效的 URL:
use Illuminate\Support\Str;
$isUrl = Str::isUrl('http://example.com');
// true
$isUrl = Str::isUrl('laravel');
// falseisUrl 方法將多種協定視為有效。不過,您可以透過將協定提供給 isUrl 方法來指定應視為有效的協定:
$isUrl = Str::isUrl('http://example.com', ['http', 'https']);Str::isUlid()
Str::isUlid 方法判斷給定字串是否為有效的 ULID:
use Illuminate\Support\Str;
$isUlid = Str::isUlid('01gd6r360bp37zj17nxb55yv40');
// true
$isUlid = Str::isUlid('laravel');
// falseStr::isUuid()
Str::isUuid 方法判斷給定字串是否為有效的 UUID:
use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false您也可以透過版本 (1, 3, 4, 5, 6, 7 或 8) 來驗證給定的 UUID 是否符合 UUID 規範:
use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de', version: 4);
// true
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de', version: 1);
// falseStr::kebab()
Str::kebab 方法將給定字串轉換為 kebab-case:
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-barStr::lcfirst()
Str::lcfirst 方法會將給定字串的第一個字元轉換為小寫:
use Illuminate\Support\Str;
$string = Str::lcfirst('Foo Bar');
// foo BarStr::length()
Str::length 方法會回傳給定字串的長度:
use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7Str::limit()
Str::limit 方法會將給定字串截斷至指定長度:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...您可以傳遞第三個引數給該方法,以更改將附加到截斷字串末尾的字串:
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)如果您希望在截斷字串時保留完整的單字,可以使用 preserveWords 引數。當此引數為 true 時,字串將截斷至最接近的完整單字邊界:
$truncated = Str::limit('The quick brown fox', 12, preserveWords: true);
// The quick...Str::lower()
Str::lower 方法會將給定字串轉換為小寫:
use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravelStr::markdown()
Str::markdown 方法會使用 CommonMark 將 GitHub 風格的 Markdown 轉換為 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>Markdown 安全
預設情況下,Markdown 支援原始 HTML,這在與原始使用者輸入一起使用時會暴露跨站腳本 (XSS) 漏洞。根據 CommonMark 安全文件,您可以使用 html_input 選項來跳脫或刪除原始 HTML,並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML,則應將您編譯的 Markdown 通過 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 方法會使用重複的字元遮罩字串的一部分,可用於模糊化字串片段,例如電子郵件地址和電話號碼:
use Illuminate\Support\Str;
$string = Str::mask('[email protected]', '*', 3);
// tay***************如有需要,您可以將負數作為第三個引數提供給 mask 方法,這會指示該方法從字串末尾的指定距離開始遮罩:
$string = Str::mask('[email protected]', '*', -15, 3);
// tay***@example.comStr::match()
Str::match 方法會回傳與給定正規表示式模式相符的字串部分:
use Illuminate\Support\Str;
$result = Str::match('/bar/', 'foo bar');
// 'bar'
$result = Str::match('/foo (.*)/', 'foo bar');
// 'bar'Str::matchAll()
Str::matchAll 方法會回傳一個包含與給定正規表示式模式相符的字串部分的集合:
use Illuminate\Support\Str;
$result = Str::matchAll('/bar/', 'bar foo bar');
// collect(['bar', 'bar'])如果您在表達式中指定一個匹配群組,Laravel 將回傳第一個匹配群組的匹配項集合:
use Illuminate\Support\Str;
$result = Str::matchAll('/f(\w*)/', 'bar fun bar fly');
// collect(['un', 'ly']);如果未找到任何匹配項,則會回傳一個空集合。
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()
Str::padLeft 方法包裝了 PHP 的 str_pad 函式,用另一個字串填充字串的左側,直到最終字串達到所需長度:
use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// ' James'Str::padRight()
Str::padRight 方法包裝了 PHP 的 str_pad 函式,用另一個字串填充字串的右側,直到最終字串達到所需長度:
use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James 'Str::password()
Str::password 方法可用於生成指定長度的安全隨機密碼。密碼將由字母、數字、符號和空格的組合組成。預設情況下,密碼為 32 個字元長:
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 方法會將單數名詞字串轉換為其複數形式。此函式支援 Laravel 的複數器所支援的任何語言:
use Illuminate\Support\Str;
$plural = Str::plural('car');
// cars
$plural = Str::plural('child');
// children您可以提供一個整數作為函式的第二個引數,以檢索字串的單數或複數形式:
use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child可以提供 prependCount 引數,將格式化的 $count 前置於複數化的字串:
use Illuminate\Support\Str;
$label = Str::plural('car', 1000, prependCount: true);
// 1,000 carsStr::pluralStudly()
Str::pluralStudly 方法會將以 StudlyCaps 格式的單數單字字串轉換為其複數形式。此函式支援 Laravel 的複數器所支援的任何語言:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman');
// VerifiedHumans
$plural = Str::pluralStudly('UserFeedback');
// UserFeedback您可以提供一個整數作為函式的第二個引數,以檢索字串的單數或複數形式:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHumanStr::position()
Str::position 方法會回傳子字串在字串中第一次出現的位置。如果該子字串不存在於指定的字串中,則回傳 false:
use Illuminate\Support\Str;
$position = Str::position('Hello, World!', 'Hello');
// 0
$position = Str::position('Hello, World!', 'W');
// 7Str::random()
Str::random 方法會產生指定長度的隨機字串。此函式使用 PHP 的 random_bytes 函式:
use Illuminate\Support\Str;
$random = Str::random(40);在測試期間,模擬 Str::random 方法回傳的值可能很有用。若要達成此目的,您可以使用 createRandomStringsUsing 方法:
Str::createRandomStringsUsing(function () {
return 'fake-random-string';
});若要指示 random 方法回歸正常產生隨機字串,您可以呼叫 createRandomStringsNormally 方法:
Str::createRandomStringsNormally();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.您也可以傳入 false 作為 remove 方法的第三個引數,以在移除字串時忽略大小寫。
Str::repeat()
Str::repeat 方法會重複指定的字串:
use Illuminate\Support\Str;
$string = 'a';
$repeat = Str::repeat($string, 5);
// aaaaaStr::replace()
Str::replace 方法會取代字串中的指定字串:
use Illuminate\Support\Str;
$string = 'Laravel 11.x';
$replaced = Str::replace('11.x', '12.x', $string);
// Laravel 12.xreplace 方法也接受 caseSensitive 引數。預設情況下,replace 方法會區分大小寫:
$replaced = Str::replace(
'php',
'Laravel',
'PHP Framework for Web Artisans',
caseSensitive: false
);
// Laravel Framework for Web ArtisansStr::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:00Str::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 dogStr::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 dogStr::replaceMatches()
Str::replaceMatches 方法會將字串中所有符合模式的部分替換為指定的替換字串:
use Illuminate\Support\Str;
$replaced = Str::replaceMatches(
pattern: '/[^A-Za-z0-9]++/',
replace: '',
subject: '(+1) 501-555-1000'
)
// '15015551000'replaceMatches 方法也接受一個閉包,該閉包會對字串中每個符合指定模式的部分進行呼叫,允許您在閉包中執行取代邏輯並回傳取代後的值:
use Illuminate\Support\Str;
$replaced = Str::replaceMatches('/\d/', function (array $matches) {
return '['.$matches[0].']';
}, '123');
// '[1][2][3]'Str::replaceStart()
Str::replaceStart 方法會取代指定值的第一次出現,但僅當該值出現在字串開頭時:
use Illuminate\Support\Str;
$replaced = Str::replaceStart('Hello', 'Laravel', 'Hello World');
// Laravel World
$replaced = Str::replaceStart('World', 'Laravel', 'Hello World');
// Hello WorldStr::replaceEnd()
Str::replaceEnd 方法會取代指定值的最後一次出現,但僅當該值出現在字串末尾時:
use Illuminate\Support\Str;
$replaced = Str::replaceEnd('World', 'Laravel', 'Hello World');
// Hello Laravel
$replaced = Str::replaceEnd('Hello', 'Laravel', 'Hello World');
// Hello WorldStr::reverse()
Str::reverse 方法會反轉指定的字串:
use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleHStr::singular()
Str::singular 方法會將字串轉換為單數形式。此函式支援 Laravel 的複數詞轉換器所支援的任何語系:
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// childStr::slug()
Str::slug 方法會從指定的字串產生一個 URL 友善的「slug」:
use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-frameworkStr::snake()
Str::snake 方法會將指定的字串轉換為 snake_case:
use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-barStr::squish()
Str::squish 方法會移除字串中所有多餘的空白,包括單字之間多餘的空白:
use Illuminate\Support\Str;
$string = Str::squish(' laravel framework ');
// laravel frameworkStr::start()
Str::start 方法會向字串新增一個指定值的實例,前提是該字串尚未以此值開頭:
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/stringStr::startsWith()
Str::startsWith 方法會判斷指定字串是否以指定值開頭:
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']);
// trueStr::studly()
Str::studly 方法會將指定的字串轉換為 StudlyCase:
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBarStr::substr()
Str::substr 方法會回傳字串中由起始位置和長度參數指定的片段:
use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// LaravelStr::substrCount()
Str::substrCount 方法會回傳指定值在給定字串中出現的次數:
use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2Str::substrReplace()
Str::substrReplace 方法會取代字串中指定位置的文字,從第三個引數所指定的位置開始,取代第四個引數所指定的字元數。若傳遞 0 到該方法的第四個引數,則會在指定位置插入字串,而不會取代字串中任何現有的字元:
use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2);
// 13:
$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00Str::swap()
Str::swap 方法會使用 PHP 的 strtr 函數,取代給定字串中的多個值:
use Illuminate\Support\Str;
$string = Str::swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
], 'Tacos are great!');
// Burritos are fantastic!Str::take()
Str::take 方法會回傳字串開頭指定數量的字元:
use Illuminate\Support\Str;
$taken = Str::take('Build something amazing!', 5);
// BuildStr::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 CaseStr::toBase64()
Str::toBase64 方法會將給定字串轉換為 Base64:
use Illuminate\Support\Str;
$base64 = Str::toBase64('Laravel');
// TGFyYXZlbA==Str::transliterate()
Str::transliterate 方法會嘗試將給定字串轉換為最接近的 ASCII 表示形式:
use Illuminate\Support\Str;
$email = Str::transliterate('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ');
// '[email protected]'Str::trim()
Str::trim 方法會從給定字串的開頭與結尾移除空白字元 (或其他字元)。與 PHP 原生的 trim 函數不同,Str::trim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::trim(' foo bar ');
// 'foo bar'Str::ltrim()
Str::ltrim 方法會從給定字串的開頭移除空白字元 (或其他字元)。與 PHP 原生的 ltrim 函數不同,Str::ltrim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::ltrim(' foo bar ');
// 'foo bar 'Str::rtrim()
Str::rtrim 方法會從給定字串的結尾移除空白字元 (或其他字元)。與 PHP 原生的 rtrim 函數不同,Str::rtrim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::rtrim(' foo bar ');
// ' foo bar'Str::ucfirst()
Str::ucfirst 方法會回傳第一個字元大寫的給定字串:
use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo barStr::ucsplit()
Str::ucsplit 方法會將給定字串按大寫字元分割成陣列:
use Illuminate\Support\Str;
$segments = Str::ucsplit('FooBar');
// [0 => 'Foo', 1 => 'Bar']Str::upper()
Str::upper 方法會將給定字串轉換為大寫:
use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVELStr::ulid()
Str::ulid 方法會產生一個 ULID,這是一個緊湊、按時間排序的唯一識別碼:
use Illuminate\Support\Str;
return (string) Str::ulid();
// 01gd6r360bp37zj17nxb55yv40如果您想擷取代表給定 ULID 建立的日期和時間的 Illuminate\Support\Carbon 日期實例,您可以使用 Laravel 的 Carbon 整合所提供的 createFromId 方法:
use Illuminate\Support\Carbon;
use Illuminate\Support\Str;
$date = Carbon::createFromId((string) Str::ulid());在測試期間,「偽造」Str::ulid 方法回傳的值可能會很有用。為此,您可以使用 createUlidsUsing 方法:
use Symfony\Component\Uid\Ulid;
Str::createUlidsUsing(function () {
return new Ulid('01HRDBNHHCKNW2AK4Z29SN82T9');
});若要指示 ulid 方法恢復正常產生 ULID,您可以調用 createUlidsNormally 方法:
Str::createUlidsNormally();Str::unwrap()
Str::unwrap 方法會從給定字串的開頭與結尾移除指定的字串:
use Illuminate\Support\Str;
Str::unwrap('-Laravel-', '-');
// Laravel
Str::unwrap('{framework: "Laravel"}', '{', '}');
// framework: "Laravel"Str::uuid()
Str::uuid 方法會產生一個 UUID (版本 4):
use Illuminate\Support\Str;
return (string) Str::uuid();在測試期間,「偽造」Str::uuid 方法回傳的值可能會很有用。為此,您可以使用 createUuidsUsing 方法:
use Ramsey\Uuid\Uuid;
Str::createUuidsUsing(function () {
return Uuid::fromString('eadbfeac-5258-45c2-bab7-ccb9b5ef74f9');
});若要指示 uuid 方法恢復正常產生 UUID,您可以調用 createUuidsNormally 方法:
Str::createUuidsNormally();Str::uuid7()
Str::uuid7 方法會產生一個 UUID (版本 7):
use Illuminate\Support\Str;
return (string) Str::uuid7();DateTimeInterface 可作為可選參數傳入,用於產生有序 UUID:
return (string) Str::uuid7(time: now());Str::wordCount()
Str::wordCount 方法會回傳字串中包含的單字數量:
use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2Str::wordWrap()
Str::wordWrap 方法會將字串換行至指定的字元數:
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 方法會限制字串中的單字數量。可透過其第三個引數傳遞額外的字串給此方法,以指定應附加到截斷字串末尾的字串:
use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>Str::wrap()
Str::wrap 方法會使用一個額外的字串或一對字串來包裝給定的字串:
use Illuminate\Support\Str;
Str::wrap('Laravel', '"');
// "Laravel"
Str::wrap('is', before: 'This ', after: ' Laravel!');
// This is Laravel!str()
str 函式會回傳指定字串的一個新的 Illuminate\Support\Stringable 實例。這個函式等同於 Str::of 方法:
$string = str('Taylor')->append(' Otwell');
// 'Taylor Otwell'如果沒有為 str 函式提供任何引數,這個函式將回傳一個 Illuminate\Support\Str 的實例:
$snake = str()->snake('FooBar');
// 'foo_bar'trans()
trans 函式會使用你的 語言檔 來翻譯指定的翻譯鍵:
echo trans('messages.welcome');如果指定的翻譯鍵不存在,trans 函式將會回傳該鍵。因此,使用上方範例,如果翻譯鍵不存在,trans 函式將會回傳 messages.welcome。
trans_choice()
trans_choice 函式會翻譯帶有詞形變化的指定翻譯鍵:
echo trans_choice('messages.notifications', $unreadCount);如果指定的翻譯鍵不存在,trans_choice 函式將會回傳該鍵。因此,使用上方範例,如果翻譯鍵不存在,trans_choice 函式將會回傳 messages.notifications。
流暢字串
流暢字串 (Fluent strings) 為處理字串值提供了一個更流暢、物件導向的介面,讓您可以利用更具可讀性的語法,將多個字串操作鏈結在一起,而不是傳統的字串操作方式。
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'apa
apa 方法會將給定的字串轉換為標題大小寫,遵循 APA 指南:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->apa();
// A Nice Title Uses the Correct Caseappend
append 方法會將給定的值附加到字串:
use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'ascii
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 方法會回傳字串中兩個值之間的部分:
use Illuminate\Support\Str;
$converted = Str::of('This is my name')->between('This', 'name');
// ' is my 'betweenFirst
betweenFirst 方法會回傳字串中兩個值之間最小的可能部分:
use Illuminate\Support\Str;
$converted = Str::of('[a] bc [d]')->betweenFirst('[', ']');
// 'a'camel
camel 方法會將給定的字串轉換為 camelCase:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// 'fooBar'charAt
charAt 方法會回傳指定索引處的字元。如果索引超出範圍,則回傳 false:
use Illuminate\Support\Str;
$character = Str::of('This is my name.')->charAt(6);
// 's'classBasename
classBasename 方法會回傳給定類別的類別名稱,並移除其命名空間:
use Illuminate\Support\Str;
$class = Str::of('Foo\Bar\Baz')->classBasename();
// 'Baz'chopStart
chopStart 方法僅當指定值出現在字串開頭時,才移除該值的第一次出現:
use Illuminate\Support\Str;
$url = Str::of('https://laravel.com')->chopStart('https://');
// 'laravel.com'您也可以傳入一個陣列。如果字串以陣列中的任何值開頭,則該值將從字串中移除:
use Illuminate\Support\Str;
$url = Str::of('http://laravel.com')->chopStart(['https://', 'http://']);
// 'laravel.com'chopEnd
chopEnd 方法僅當指定值出現在字串結尾時,才移除該值的最後一次出現:
use Illuminate\Support\Str;
$url = Str::of('https://laravel.com')->chopEnd('.com');
// 'https://laravel'您也可以傳入一個陣列。如果字串以陣列中的任何值結尾,則該值將從字串中移除:
use Illuminate\Support\Str;
$url = Str::of('http://laravel.com')->chopEnd(['.com', '.io']);
// 'http://laravel'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您可以透過設定 ignoreCase 參數為 true 來停用大小寫區分:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('MY', ignoreCase: true);
// truecontainsAll
containsAll 方法會判斷給定字串是否包含給定陣列中的所有值:
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);
// true您可以透過設定 ignoreCase 參數為 true 來停用大小寫區分:
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['MY', 'NAME'], ignoreCase: true);
// truedecrypt
decrypt 方法會 解密 加密的字串:
use Illuminate\Support\Str;
$decrypted = $encrypted->decrypt();
// 'secret'關於 decrypt 的反向操作,請參閱 encrypt 方法。
deduplicate
deduplicate 方法會在給定字串中,將字元的連續實例替換為該字元的單一實例。預設情況下,此方法會移除重複的空格:
use Illuminate\Support\Str;
$result = Str::of('The Laravel Framework')->deduplicate();
// The Laravel Framework您可以透過將其作為方法的第二個參數傳入,來指定不同的重複字元:
use Illuminate\Support\Str;
$result = Str::of('The---Laravel---Framework')->deduplicate('-');
// The-Laravel-Frameworkdirname
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'doesntEndWith
doesntEndWith 方法會判斷指定字串是否不以指定值結尾:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->doesntEndWith('dog');
// true您也可以傳遞一個值陣列,來判斷指定字串是否不以陣列中的任何一個值結尾:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->doesntEndWith(['this', 'foo']);
// true
$result = Str::of('This is my name')->doesntEndWith(['name', 'foo']);
// falsedoesntStartWith
doesntStartWith 方法會判斷指定字串是否不以指定值開頭:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->doesntStartWith('That');
// true您也可以傳遞一個值陣列,來判斷指定字串是否不以陣列中的任何一個值開頭:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->doesntStartWith(['What', 'That', 'There']);
// trueencrypt
encrypt 方法會將字串 加密:
use Illuminate\Support\Str;
$encrypted = Str::of('secret')->encrypt();有關 encrypt 的反向操作,請參閱 decrypt 方法。
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']);
// falseexactly
exactly 方法會判斷指定字串是否與另一個字串完全相符:
use Illuminate\Support\Str;
$result = Str::of('Laravel')->exactly('Laravel');
// trueexcerpt
excerpt 方法會從字串中提取與該字串內第一個符合片語的摘錄:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('my', [
'radius' => 3
]);
// '...is my na...'radius 選項預設為 100,允許您定義截斷字串兩側應顯示的字元數。
此外,您還可以使用 omission 選項來更改將前置和附加到截斷字串的字串:
use Illuminate\Support\Str;
$excerpt = Str::of('This is my name')->excerpt('name', [
'radius' => 3,
'omission' => '(...) '
]);
// '(...) my name'explode
explode 方法會依照指定的分隔符號分割字串,並回傳一個包含分割後字串每個部分的 collection:
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/fromBase64
fromBase64 方法會解碼指定的 Base64 字串:
use Illuminate\Support\Str;
$decoded = Str::of('TGFyYXZlbA==')->fromBase64();
// Laravelhash
hash 方法會使用指定的 演算法 對字串進行雜湊處理:
use Illuminate\Support\Str;
$hashed = Str::of('secret')->hash(algorithm: 'sha256');
// '2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b'headline
headline 方法會將由大小寫、連字號或底線分隔的字串轉換為以空白字元分隔的字串,其中每個單字的第一個字母都將大寫:
use Illuminate\Support\Str;
$headline = Str::of('taylor_otwell')->headline();
// Taylor Otwell
$headline = Str::of('EmailNotificationSent')->headline();
// Email Notification SentinlineMarkdown
inlineMarkdown 方法會使用 CommonMark 將 GitHub 風格的 Markdown 轉換為行內 HTML。然而,與 markdown 方法不同,它不會將所有生成的 HTML 包裹在區塊級元素中:
use Illuminate\Support\Str;
$html = Str::of('**Laravel**')->inlineMarkdown();
// <strong>Laravel</strong>Markdown 安全
預設情況下,Markdown 支援原始 HTML,這在與原始使用者輸入一起使用時,會暴露跨站腳本 (XSS) 漏洞。根據 CommonMark 安全文件,您可以使用 html_input 選項來轉義或剝離原始 HTML,以及 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML,您應該將編譯後的 Markdown 透過 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 方法會判斷指定字串是否符合指定的模式。星號可用作萬用字元:
use Illuminate\Support\Str;
$matches = Str::of('foobar')->is('foo*');
// true
$matches = Str::of('foobar')->is('baz*');
// falseisAscii
isAscii 方法會判斷指定字串是否是 ASCII 字串:
use Illuminate\Support\Str;
$result = Str::of('Taylor')->isAscii();
// true
$result = Str::of('ü')->isAscii();
// falseisEmpty
isEmpty 方法會判斷指定字串是否為空:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isEmpty();
// true
$result = Str::of('Laravel')->trim()->isEmpty();
// falseisNotEmpty
isNotEmpty 方法會判斷指定字串是否不為空:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isNotEmpty();
// false
$result = Str::of('Laravel')->trim()->isNotEmpty();
// trueisJson
isJson 方法會判斷指定字串是否是有效的 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();
// falseisUlid
isUlid 方法會判斷指定字串是否是 ULID:
use Illuminate\Support\Str;
$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();
// true
$result = Str::of('Taylor')->isUlid();
// falseisUrl
isUrl 方法判斷給定的字串是否為 URL:
use Illuminate\Support\Str;
$result = Str::of('http://example.com')->isUrl();
// true
$result = Str::of('Taylor')->isUrl();
// falseisUrl 方法認為許多協定都是有效的。不過,您可以透過提供給 isUrl 方法來指定應被視為有效的協定:
$result = Str::of('http://example.com')->isUrl(['http', 'https']);isUuid
isUuid 方法判斷給定的字串是否為 UUID:
use Illuminate\Support\Str;
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
// true
$result = Str::of('Taylor')->isUuid();
// false您也可以透過版本(1、3、4、5、6、7 或 8)來驗證給定的 UUID 是否符合 UUID 規範:
use Illuminate\Support\Str;
$isUuid = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->isUuid(version: 4);
// true
$isUuid = Str::of('a0a2a2d2-0b87-4a18-83f2-2529882be2de')->isUuid(version: 1);
// falsekebab
kebab 方法將給定的字串轉換為 kebab-case:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->kebab();
// foo-barlcfirst
lcfirst 方法回傳給定字串的首個字元小寫後的字串:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->lcfirst();
// foo Barlength
length 方法回傳給定字串的長度:
use Illuminate\Support\Str;
$length = Str::of('Laravel')->length();
// 7limit
limit 方法將給定字串截斷為指定長度:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);
// The quick brown fox...您也可以傳遞第二個引數來更改將附加到截斷字串末尾的字串:
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
// The quick brown fox (...)如果您想在截斷字串時保留完整的單字,可以使用 preserveWords 引數。當此引數為 true 時,字串將截斷到最近的完整單字邊界:
$truncated = Str::of('The quick brown fox')->limit(12, preserveWords: true);
// The quick...lower
lower 方法將給定字串轉換為小寫:
use Illuminate\Support\Str;
$result = Str::of('LARAVEL')->lower();
// 'laravel'markdown
markdown 方法使用 CommonMark 將 GitHub 風格的 Markdown 轉換為 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 支援原始 HTML,這在與原始使用者輸入一起使用時會暴露跨站點腳本 (XSS) 漏洞。根據 CommonMark 安全性文件,您可以使用 html_input 選項來轉義或移除原始 HTML,並使用 allow_unsafe_links 選項來指定是否允許不安全的連結。如果您需要允許某些原始 HTML,則應透過 HTML Purifier 處理您編譯的 Markdown:
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 方法使用重複字元遮蔽字串的一部分,可用於混淆字串片段,例如電子郵件地址和電話號碼:
use Illuminate\Support\Str;
$string = Str::of('[email protected]')->mask('*', 3);
// tay***************如果需要,您可以向 mask 方法提供負數作為第三個或第四個引數,這將指示該方法從字串末尾給定距離處開始遮蔽:
$string = Str::of('[email protected]')->mask('*', -15, 3);
// tay***@example.com
$string = Str::of('[email protected]')->mask('*', 4, -4);
// tayl**********.commatch
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'])如果您在表達式中指定了匹配組,Laravel 將回傳第一個匹配組的匹配項集合:
use Illuminate\Support\Str;
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
// collect(['un', 'ly']);如果找不到任何匹配項,將回傳一個空集合。
isMatch
isMatch 方法將回傳 true,如果字串符合給定的正規表達式:
use Illuminate\Support\Str;
$result = Str::of('foo bar')->isMatch('/foo (.*)/');
// true
$result = Str::of('laravel')->isMatch('/foo (.*)/');
// falsenewLine
newLine 方法會向字串附加一個「行尾」字元:
use Illuminate\Support\Str;
$padded = Str::of('Laravel')->newLine()->append('Framework');
// 'Laravel
// Framework'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;
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 方法會將單數單詞字串轉換為其複數形式。此函式支援 Laravel 的複數器所支援的任何語言:
use Illuminate\Support\Str;
$plural = Str::of('car')->plural();
// cars
$plural = Str::of('child')->plural();
// children您可以提供一個整數引數給此函式,以取得字串的單數或複數形式:
use Illuminate\Support\Str;
$plural = Str::of('child')->plural(2);
// children
$plural = Str::of('child')->plural(1);
// child您可以提供 prependCount 引數,將格式化的 $count 前置於複數化的字串之前:
use Illuminate\Support\Str;
$label = Str::of('car')->plural(1000, prependCount: true);
// 1,000 carsposition
position 方法回傳字串中子字串第一次出現的位置。如果子字串不存在於該字串中,則回傳 false:
use Illuminate\Support\Str;
$position = Str::of('Hello, World!')->position('Hello');
// 0
$position = Str::of('Hello, World!')->position('W');
// 7prepend
prepend 方法會將給定的值前置於字串上:
use Illuminate\Support\Str;
$string = Str::of('Framework')->prepend('Laravel ');
// Laravel Frameworkremove
remove 方法從字串中移除給定的值或值陣列:
use Illuminate\Support\Str;
$string = Str::of('Arkansas is quite beautiful!')->remove('quite ');
// Arkansas is beautiful!您也可以傳遞 false 作為第二個參數,在移除字串時忽略大小寫。
repeat
repeat 方法會重複給定的字串:
use Illuminate\Support\Str;
$repeated = Str::of('a')->repeat(5);
// aaaaareplace
replace 方法會在字串中替換給定的字串:
use Illuminate\Support\Str;
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
// Laravel 7.xreplace 方法也接受 caseSensitive 引數。依預設,replace 方法會區分大小寫:
$replaced = Str::of('macOS 13.x')->replace(
'macOS', 'iOS', caseSensitive: false
);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:00replaceFirst
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 dogreplaceLast
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 dogreplaceMatches
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 (array $matches) {
return '['.$matches[0].']';
});
// '[1][2][3]'replaceStart
replaceStart 方法只有當給定值出現在字串開頭時,才替換其第一次出現的地方:
use Illuminate\Support\Str;
$replaced = Str::of('Hello World')->replaceStart('Hello', 'Laravel');
// Laravel World
$replaced = Str::of('Hello World')->replaceStart('World', 'Laravel');
// Hello WorldreplaceEnd
replaceEnd 方法只有當給定值出現在字串結尾時,才替換其最後一次出現的地方:
use Illuminate\Support\Str;
$replaced = Str::of('Hello World')->replaceEnd('World', 'Laravel');
// Hello Laravel
$replaced = Str::of('Hello World')->replaceEnd('Hello', 'Laravel');
// Hello Worldscan
scan 方法根據 sscanf PHP 函式 支援的格式,將字串輸入解析為集合:
use Illuminate\Support\Str;
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
// collect(['filename', 'jpg'])singular
singular 方法會將字串轉換為其單數形式。此函式支援 Laravel 的複數器所支援的任何語言:
use Illuminate\Support\Str;
$singular = Str::of('cars')->singular();
// car
$singular = Str::of('children')->singular();
// childslug
slug 方法會從給定的字串產生一個對 URL 友善的「slug」:
use Illuminate\Support\Str;
$slug = Str::of('Laravel Framework')->slug('-');
// laravel-frameworksnake
snake 方法會將給定的字串轉換為 snake_case:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->snake();
// foo_barsplit
split 方法會使用正規表達式將字串分割成集合:
use Illuminate\Support\Str;
$segments = Str::of('one, two, three')->split('/[\s,]+/');
// collect(["one", "two", "three"])squish
squish 方法會從字串中移除所有多餘的空白字元,包括單詞之間的多餘空白字元:
use Illuminate\Support\Str;
$string = Str::of(' laravel framework ')->squish();
// laravel frameworkstart
start 方法如果字串尚未以給定值開頭,則將其單一實例新增到字串中:
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->start('/');
// /this/string
$adjusted = Str::of('/this/string')->start('/');
// /this/stringstartsWith
startsWith 方法判斷給定字串是否以給定值開頭:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->startsWith('This');
// truestripTags
stripTags 方法會從字串中移除所有 HTML 和 PHP 標籤:
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 方法會將給定字串轉換為 StudlyCase:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->studly();
// FooBarsubstr
substr 方法會根據給定的起始位置和長度參數,傳回字串的指定部分:
use Illuminate\Support\Str;
$string = Str::of('Laravel Framework')->substr(8);
// Framework
$string = Str::of('Laravel Framework')->substr(8, 5);
// FramesubstrReplace
substrReplace 方法會在字串的指定部分中替換文字,從第二個參數指定的位置開始,替換第三個參數指定的字元數。將 0 傳遞給方法的第三個參數將在指定位置插入字串,而不會替換字串中任何現有字元:
use Illuminate\Support\Str;
$string = Str::of('1300')->substrReplace(':', 2);
// 13:
$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);
// The Laravel Frameworkswap
swap 方法會使用 PHP 的 strtr 函數替換字串中的多個值:
use Illuminate\Support\Str;
$string = Str::of('Tacos are great!')
->swap([
'Tacos' => 'Burritos',
'great' => 'fantastic',
]);
// Burritos are fantastic!take
take 方法會從字串的開頭傳回指定數量的字元:
use Illuminate\Support\Str;
$taken = Str::of('Build something amazing!')->take(5);
// Buildtap
tap 方法會將字串傳遞給給定的閉包,允許您檢查和與字串互動,同時不影響字串本身。無論閉包傳回什麼,tap 方法都會傳回原始字串:
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 FRAMEWORKtest
test 方法會判斷字串是否符合給定的正規表示式模式:
use Illuminate\Support\Str;
$result = Str::of('Laravel Framework')->test('/Laravel/');
// truetitle
title 方法會將給定字串轉換為 Title Case:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->title();
// A Nice Title Uses The Correct CasetoBase64
toBase64 方法會將給定字串轉換為 Base64:
use Illuminate\Support\Str;
$base64 = Str::of('Laravel')->toBase64();
// TGFyYXZlbA==toHtmlString
toHtmlString 方法會將給定字串轉換為 Illuminate\Support\HtmlString 的實例,該實例在 Blade 模板中渲染時將不會被跳脫:
use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();toUri
toUri 方法會將給定字串轉換為 Illuminate\Support\Uri 的實例:
use Illuminate\Support\Str;
$uri = Str::of('https://example.com')->toUri();transliterate
transliterate 方法將嘗試把給定字串轉換為其最接近的 ASCII 表示形式:
use Illuminate\Support\Str;
$email = Str::of('ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ')->transliterate()
// '[email protected]'trim
trim 方法會修剪給定的字串。與 PHP 原生 trim 函數不同,Laravel 的 trim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->trim();
// 'Laravel'
$string = Str::of('/Laravel/')->trim('/');
// 'Laravel'ltrim
ltrim 方法會修剪字串的左側。與 PHP 原生 ltrim 函數不同,Laravel 的 ltrim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->ltrim();
// 'Laravel '
$string = Str::of('/Laravel/')->ltrim('/');
// 'Laravel/'rtrim
rtrim 方法會修剪給定字串的右側。與 PHP 原生 rtrim 函數不同,Laravel 的 rtrim 方法也會移除 Unicode 空白字元:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->rtrim();
// ' Laravel'
$string = Str::of('/Laravel/')->rtrim('/');
// '/Laravel'ucfirst
ucfirst 方法會傳回將第一個字元大寫後的給定字串:
use Illuminate\Support\Str;
$string = Str::of('foo bar')->ucfirst();
// Foo barucsplit
ucsplit 方法會根據大寫字元將給定字串分割成一個集合:
use Illuminate\Support\Str;
$string = Str::of('Foo Bar')->ucsplit();
// collect(['Foo ', 'Bar'])unwrap
unwrap 方法會從給定字串的開頭和結尾移除指定的字串:
use Illuminate\Support\Str;
Str::of('-Laravel-')->unwrap('-');
// Laravel
Str::of('{framework: "Laravel"}')->unwrap('{', '}');
// framework: "Laravel"upper
upper 方法會將給定字串轉換為大寫:
use Illuminate\Support\Str;
$adjusted = Str::of('laravel')->upper();
// LARAVELwhen
如果給定條件為 true,when 方法會呼叫給定的閉包。該閉包將接收流暢的字串實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('Taylor')
->when(true, function (Stringable $string) {
return $string->append(' Otwell');
});
// 'Taylor Otwell'如果需要,您可以將另一個閉包作為 when 方法的第三個參數傳遞。如果條件參數評估為 false,則此閉包將執行。
whenContains
whenContains 方法會在字串包含給定值時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContains('tony', function (Stringable $string) {
return $string->title();
});
// 'Tony Stark'如有需要,您可以將另一個閉包作為第三個參數傳遞給 when 方法。如果字串不包含給定值,此閉包將會執行。
您也可以傳遞一個值陣列,以判斷給定字串是否包含陣列中的任何一個值:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContains(['tony', 'hulk'], function (Stringable $string) {
return $string->title();
});
// Tony StarkwhenContainsAll
whenContainsAll 方法會在字串包含所有給定的子字串時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('tony stark')
->whenContainsAll(['tony', 'stark'], function (Stringable $string) {
return $string->title();
});
// 'Tony Stark'如有需要,您可以將另一個閉包作為第三個參數傳遞給 when 方法。如果條件參數評估為 false,此閉包將會執行。
whenDoesntEndWith
whenDoesntEndWith 方法會在字串不以給定子字串結尾時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('disney world')->whenDoesntEndWith('land', function (Stringable $string) {
return $string->title();
});
// 'Disney World'whenDoesntStartWith
whenDoesntStartWith 方法會在字串不以給定子字串開頭時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('disney world')->whenDoesntStartWith('sea', function (Stringable $string) {
return $string->title();
});
// 'Disney World'whenEmpty
whenEmpty 方法會在字串為空時調用給定的閉包。如果閉包回傳一個值,該值也將由 whenEmpty 方法回傳。如果閉包沒有回傳值,則會回傳 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of(' ')->trim()->whenEmpty(function (Stringable $string) {
return $string->prepend('Laravel');
});
// 'Laravel'whenNotEmpty
whenNotEmpty 方法會在字串不為空時調用給定的閉包。如果閉包回傳一個值,該值也將由 whenNotEmpty 方法回傳。如果閉包沒有回傳值,則會回傳 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('Framework')->whenNotEmpty(function (Stringable $string) {
return $string->prepend('Laravel ');
});
// 'Laravel Framework'whenStartsWith
whenStartsWith 方法會在字串以給定子字串開頭時調用給定的閉包。此閉包將接收 Fluent string 實例:
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 方法會在字串以給定子字串結尾時調用給定的閉包。此閉包將接收 Fluent string 實例:
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 方法會在字串與給定字串完全符合時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('laravel')->whenExactly('laravel', function (Stringable $string) {
return $string->title();
});
// 'Laravel'whenNotExactly
whenNotExactly 方法會在字串與給定字串不完全符合時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('framework')->whenNotExactly('laravel', function (Stringable $string) {
return $string->title();
});
// 'Framework'whenIs
whenIs 方法會在字串符合給定模式時調用給定的閉包。星號可用作萬用字元值。此閉包將接收 Fluent string 實例:
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 方法會在字串為 7 位元 ASCII 時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
use Illuminate\Support\Stringable;
$string = Str::of('laravel')->whenIsAscii(function (Stringable $string) {
return $string->title();
});
// 'Laravel'whenIsUlid
whenIsUlid 方法會在字串是有效的 ULID 時調用給定的閉包。此閉包將接收 Fluent string 實例:
use Illuminate\Support\Str;
$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
return $string->substr(0, 8);
});
// '01gd6r36'whenIsUuid
whenIsUuid 方法會在字串是有效的 UUID 時調用給定的閉包。此閉包將接收 Fluent string 實例:
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 方法會在字串符合給定正規表達式時調用給定的閉包。此閉包將接收 Fluent string 實例:
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 方法會回傳字串中單字的數量:
use Illuminate\Support\Str;
Str::of('Hello, world!')->wordCount(); // 2words
words 方法限制字串中的單字數量。如有必要,您可以指定一個額外的字串,將會被附加到截斷的字串後面:
use Illuminate\Support\Str;
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
// Perfectly balanced, as >>>wrap
wrap 方法使用額外的字串或一對字串來包裝給定的字串:
use Illuminate\Support\Str;
Str::of('Laravel')->wrap('"');
// "Laravel"
Str::is('is')->wrap(before: 'This ', after: ' Laravel!');
// This is Laravel!