字串

簡介
可用方法

簡介

Laravel 包含多種用於操作字串值的功能。其中許多功能由框架本身使用；但是，如果您覺得方便，可以自由地在自己的應用程式中使用它們。

可用方法

字串

__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::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

流暢字串

字串

`__()`

__ 函式會使用您的語言檔案來翻譯給定的翻譯字串或翻譯鍵：

echo __('Welcome to our application');

echo __('messages.welcome');

如果指定的翻譯字串或翻譯鍵不存在，__ 函式會回傳給定的值。因此，以上述範例來說，如果該翻譯鍵不存在，__ 函式將會回傳 messages.welcome。

`class_basename()`

class_basename 函式會回傳給定類別的類別名稱，並移除該類別的命名空間：

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

// Baz

`e()`

e 函式會執行 PHP 的 htmlspecialchars 函式，預設會將 double_encode 選項設定為 true：

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

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

`preg_replace_array()`

preg_replace_array 函式會使用陣列循序地取代字串中給定的模式：

$string = 'The event will take place between :start and :end';

$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

`Str::after()`

Str::after 方法會回傳字串中指定值之後的所有字元。如果字串中不存在該值，則會回傳整個字串：

use Illuminate\Support\Str;

$slice = Str::after('This is my name', 'This is');

// ' my name'

`Str::afterLast()`

Str::afterLast 方法會回傳字串中指定值最後一次出現之後的所有字元。如果字串中不存在該值，則會回傳整個字串：

use Illuminate\Support\Str;

$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');

// 'Controller'

`Str::apa()`

Str::apa 方法會將給定的字串轉換為標題大小寫 (title case)，遵循 APA 準則：

use Illuminate\Support\Str;

$title = Str::apa('Creating A Project');

// 'Creating a Project'

`Str::ascii()`

Str::ascii 方法會嘗試將字串音譯 (transliterate) 為 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);

// true

`Str::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);

// true

`Str::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);

// true

`Str::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-Framework

`Str::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']);

// false

`Str::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::headline()`

Str::headline 方法會將以大小寫、連字號或底線分隔的字串，轉換成以空白字元分隔的字串，其中每個單字的第一個字母會大寫：

use Illuminate\Support\Str;

$headline = Str::headline('steve_jobs');

// Steve Jobs

$headline = Str::headline('EmailNotificationSent');

// Email Notification Sent

`Str::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，您應該將編譯後的 Markdown 透過 HTML Purifier 進行處理：

use Illuminate\Support\Str;

Str::inlineMarkdown('Inject: <script>alert("Hello XSS!");</script>', [
    'html_input' => 'strip',
    'allow_unsafe_links' => false,
]);

// Inject: alert(&quot;Hello XSS!&quot;);

`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);     

// true

`Str::isAscii()`

Str::isAscii 方法會判斷給定字串是否為 7 位元 ASCII：

use Illuminate\Support\Str;

$isAscii = Str::isAscii('Taylor');

// true

$isAscii = Str::isAscii('ü');

// false

`Str::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"}');

// false

`Str::isUrl()`

Str::isUrl 方法會判斷給定字串是否為有效的 URL：

use Illuminate\Support\Str;

$isUrl = Str::isUrl('http://example.com');

// true

$isUrl = Str::isUrl('laravel');

// false

isUrl 方法將廣泛的通訊協定視為有效。然而，您可以透過將它們提供給 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');

// false

`Str::isUuid()`

Str::isUuid 方法會判斷給定字串是否為有效的 UUID：

use Illuminate\Support\Str;

$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');

// true

$isUuid = Str::isUuid('laravel');

// false

`Str::kebab()`

Str::kebab 方法會將給定字串轉換為 kebab-case 格式：

use Illuminate\Support\Str;

$converted = Str::kebab('fooBar');

// foo-bar

`Str::lcfirst()`

Str::lcfirst 方法會回傳將給定字串的第一個字元轉換為小寫的結果：

use Illuminate\Support\Str;

$string = Str::lcfirst('Foo Bar');

// foo Bar

`Str::length()`

Str::length 方法會回傳給定字串的長度：

use Illuminate\Support\Str;

$length = Str::length('Laravel');

// 7

`Str::limit()`

Str::limit 方法會將給定字串截斷為指定長度：

use Illuminate\Support\Str;

$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);

// The quick brown fox...

您可以將第三個引數傳遞給該方法，以改變將附加到截斷字串末尾的字串：

$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');

// laravel

`Str::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(&quot;Hello XSS!&quot;);</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.com

`Str::orderedUuid()`

Str::orderedUuid 方法會產生一個「時間戳優先」的 UUID，該 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

`Str::pluralStudly()`

Str::pluralStudly 方法會將以 StudlyCase 格式的單數詞字串轉換為複數形式。此函式支援 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);

// VerifiedHuman

`Str::position()`

Str::position 方法會回傳子字串在字串中第一次出現的位置。如果子字串不存在於給定的字串中，則回傳 false：

use Illuminate\Support\Str;

$position = Str::position('Hello, World!', 'Hello');

// 0

$position = Str::position('Hello, World!', 'W');

// 7

`Str::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.

您也可以為 remove 方法傳遞 false 作為第三個參數，以在移除字串時忽略大小寫。

`Str::repeat()`

Str::repeat 方法會重複給定的字串：

php

use Illuminate\Support\Str;

$string = 'a';

$repeat = Str::repeat($string, 5);

// aaaaa

`Str::replace()`

Str::replace 方法會替換字串中的指定字串：

use Illuminate\Support\Str;

$string = 'Laravel 10.x';

$replaced = Str::replace('10.x', '11.x', $string);

// Laravel 11.x

replace 方法也接受 caseSensitive 參數。預設情況下，replace 方法區分大小寫：

Str::replace('Framework', 'Laravel', caseSensitive: false);

`Str::replaceArray()`

Str::replaceArray 方法會使用陣列依序替換字串中的指定值：

use Illuminate\Support\Str;

$string = 'The event will take place between ? and ?';

$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);

// The event will take place between 8:30 and 9:00

`Str::replaceFirst()`

Str::replaceFirst 方法替換字串中第一次出現的指定值：

use Illuminate\Support\Str;

$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');

// a quick brown fox jumps over the lazy dog

`Str::replaceLast()`

Str::replaceLast 方法替換字串中最後一次出現的指定值：

use Illuminate\Support\Str;

$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');

// the quick brown fox jumps over a lazy dog

`Str::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 World

`Str::replaceEnd()`

Str::replaceEnd 方法僅在字串末尾出現指定值時，替換該值的最後一次出現：

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 方法反轉給定的字串：

use Illuminate\Support\Str;

$reversed = Str::reverse('Hello World');

// dlroW olleH

`Str::singular()`

Str::singular 方法將字串轉換為單數形式。此函數支援 Laravel 的複數化器 (pluralizer) 所支援的任何語言：

use Illuminate\Support\Str;

$singular = Str::singular('cars');

// car

$singular = Str::singular('children');

// child

`Str::slug()`

Str::slug 方法從給定字串生成一個對 URL 友好的「slug」：

use Illuminate\Support\Str;

$slug = Str::slug('Laravel 5 Framework', '-');

// laravel-5-framework

`Str::snake()`

Str::snake 方法將給定字串轉換為 snake_case：

use Illuminate\Support\Str;

$converted = Str::snake('fooBar');

// foo_bar

$converted = Str::snake('fooBar', '-');

// foo-bar

`Str::squish()`

Str::squish 方法從字串中移除所有多餘的空白字元，包括單字之間的多餘空白字元：

use Illuminate\Support\Str;

$string = Str::squish('    laravel    framework    ');

// laravel framework

`Str::start()`

Str::start 方法在字串不以指定值開頭時，為其添加一個該值的實例：

use Illuminate\Support\Str;

$adjusted = Str::start('this/string', '/');

// /this/string

$adjusted = Str::start('/this/string', '/');

// /this/string

`Str::startsWith()`

Str::startsWith 方法判斷給定字串是否以指定值開頭：

use Illuminate\Support\Str;

$result = Str::startsWith('This is my name', 'This');

// true

如果傳入一個可能值的陣列，startsWith 方法會在字串以陣列中的任何一個值開頭時返回 true：

$result = Str::startsWith('This is my name', ['This', 'That', 'There']);

// true

`Str::studly()`

Str::studly 方法將給定字串轉換為 StudlyCase：

use Illuminate\Support\Str;

$converted = Str::studly('foo_bar');

// FooBar

`Str::substr()`

Str::substr 方法返回由 start 和 length 參數指定的字串部分：

use Illuminate\Support\Str;

$converted = Str::substr('The Laravel Framework', 4, 7);

// Laravel

`Str::substrCount()`

Str::substrCount 方法返回給定字串中指定值的出現次數：

use Illuminate\Support\Str;

$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');

// 2

`Str::substrReplace()`

Str::substrReplace 方法替換字串中從第三個參數指定位置開始，並替換第四個參數指定字元數量的文本。將 0 傳遞給方法的第四個參數將在指定位置插入字串，而不替換字串中任何現有字元：

use Illuminate\Support\Str;

$result = Str::substrReplace('1300', ':', 2);
// 13:

$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00

`Str::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);

// Build

`Str::title()`

Str::title 方法將給定字串轉換為 Title Case：

use Illuminate\Support\Str;

$converted = Str::title('a nice title uses the correct case');

// A Nice Title Uses The Correct Case

`Str::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 bar

`Str::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');

// LARAVEL

`Str::ulid()`

Str::ulid 方法會產生一個 ULID，這是一個緊湊的、按時間排序的唯一識別碼：

use Illuminate\Support\Str;

return (string) Str::ulid();

// 01gd6r360bp37zj17nxb55yv40

如果您想檢索一個代表給定 ULID 建立日期和時間的 Illuminate\Support\Carbon 日期實例，您可以使用 Laravel 的 Carbon 整合提供的 createFromId 方法：

php

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::wordCount()`

Str::wordCount 方法會回傳字串包含的單詞數量：

php

use Illuminate\Support\Str;

Str::wordCount('Hello, world!'); // 2

`Str::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

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 Case

`append`

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);

// true

`containsAll`

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);

// true

`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-Framework

`dirname`

dirname 方法回傳給定字串的父目錄部分：

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname();

// '/foo/bar'

若有需要，您可以指定要從字串中刪除多少層目錄：

use Illuminate\Support\Str;

$string = Str::of('/foo/bar/baz')->dirname(2);

// '/foo'

`endsWith`

endsWith 方法用於判斷給定字串是否以給定值結尾：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->endsWith('name');

// true

您也可以傳入一個值陣列，以判斷給定字串是否以陣列中的任一值結尾：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->endsWith(['name', 'foo']);

// true

$result = Str::of('This is my name')->endsWith(['this', 'foo']);

// false

`exactly`

exactly 方法用於判斷給定字串是否與另一個字串完全相符：

use Illuminate\Support\Str;

$result = Str::of('Laravel')->exactly('Laravel');

// true

`excerpt`

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/

`headline`

headline 方法會將以大小寫、連字號或底線分隔的字串轉換為以空白字元分隔的字串，並將每個單字的首字母大寫：

use Illuminate\Support\Str;

$headline = Str::of('taylor_otwell')->headline();

// Taylor Otwell

$headline = Str::of('EmailNotificationSent')->headline();

// Email Notification Sent

`inlineMarkdown`

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(&quot;Hello XSS!&quot;);

`is`

is 方法用於判斷給定字串是否符合給定模式。星號可用作萬用字元：

use Illuminate\Support\Str;

$matches = Str::of('foobar')->is('foo*');

// true

$matches = Str::of('foobar')->is('baz*');

// false

`isAscii`

isAscii 方法用於判斷給定字串是否為 ASCII 字串：

use Illuminate\Support\Str;

$result = Str::of('Taylor')->isAscii();

// true

$result = Str::of('ü')->isAscii();

// false

`isEmpty`

isEmpty 方法用於判斷給定字串是否為空：

use Illuminate\Support\Str;

$result = Str::of('  ')->trim()->isEmpty();

// true

$result = Str::of('Laravel')->trim()->isEmpty();

// false

`isNotEmpty`

isNotEmpty 方法用於判斷給定字串是否不為空：

use Illuminate\Support\Str;

$result = Str::of('  ')->trim()->isNotEmpty();

// false

$result = Str::of('Laravel')->trim()->isNotEmpty();

// true

`isJson`

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();

// false

`isUlid`

isUlid 方法用於判斷給定字串是否為 ULID：

use Illuminate\Support\Str;

$result = Str::of('01gd6r360bp37zj17nxb55yv40')->isUlid();

// true

$result = Str::of('Taylor')->isUlid();

// false

`isUrl`

isUrl 方法用於判斷給定字串是否為 URL：

use Illuminate\Support\Str;

$result = Str::of('http://example.com')->isUrl();

// true

$result = Str::of('Taylor')->isUrl();

// false

isUrl 方法認定多種協定為有效。然而，您可以透過將協定提供給 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

`kebab`

kebab 方法會將給定字串轉換為 kebab-case：

use Illuminate\Support\Str;

$converted = Str::of('fooBar')->kebab();

// foo-bar

`lcfirst`

lcfirst 方法會回傳給定字串，且首字元為小寫：

use Illuminate\Support\Str;

$string = Str::of('Foo Bar')->lcfirst();

// foo Bar

`length`

length 方法會回傳給定字串的長度：

use Illuminate\Support\Str;

$length = Str::of('Laravel')->length();

// 7

`limit`

limit 方法會將給定字串截斷至指定長度：

use Illuminate\Support\Str;

$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);

// The quick brown fox...

您也可以傳遞第二個引數來變更要附加至截斷字串末尾的字串：

$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 方法會將 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 Security

預設情況下，Markdown 支援原始 HTML，這在與原始使用者輸入一起使用時，會暴露跨站指令碼 (XSS) 漏洞。根據 CommonMark Security documentation，您可以使用 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(&quot;Hello XSS!&quot;);</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**********.com

`match`

match 方法會回傳符合給定正規表達式模式的字串部分：

use Illuminate\Support\Str;

$result = Str::of('foo bar')->match('/bar/');

// 'bar'

$result = Str::of('foo bar')->match('/foo (.*)/');

// 'bar'

`matchAll`

matchAll 方法會回傳一個包含符合給定正規表達式模式的字串部分的集合 (collection)：

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 (.*)/');

// false

`newLine`

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

`position`

position 方法會回傳子字串在字串中第一次出現的位置。如果子字串不存在於字串中，則回傳 false：

use Illuminate\Support\Str;

$position = Str::of('Hello, World!')->position('Hello');

// 0

$position = Str::of('Hello, World!')->position('W');

// 7

`prepend`

prepend 方法會將給定值附加到字串的開頭：

use Illuminate\Support\Str;

$string = Str::of('Framework')->prepend('Laravel ');

// Laravel Framework

`remove`

remove 方法會從字串中移除給定值或值陣列：

use Illuminate\Support\Str;

$string = Str::of('Arkansas is quite beautiful!')->remove('quite');

// Arkansas is beautiful!

您也可以傳遞 false 作為第二個參數，以便在移除字串時忽略大小寫。

`repeat`

repeat 方法會重複給定字串：

php

use Illuminate\Support\Str;

$repeated = Str::of('a')->repeat(5);

// aaaaa

`replace`

replace 方法會取代字串中給定的一個字串：

use Illuminate\Support\Str;

$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');

// Laravel 7.x

replace 方法也接受一個 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:00

`replaceFirst`

replaceFirst 方法會取代字串中給定值的第一個出現位置：

use Illuminate\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');

// a quick brown fox jumps over the lazy dog

`replaceLast`

replaceLast 方法會取代字串中給定值的最後一個出現位置：

use Illuminate\Support\Str;

$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');

// the quick brown fox jumps over a lazy dog

`replaceMatches`

replaceMatches 方法會取代字串中符合某個模式的所有部分，並使用給定的取代字串：

use Illuminate\Support\Str;

$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')

// '15015551000'

replaceMatches 方法也接受一個閉包，該閉包會對字串中每個符合給定模式的部分進行呼叫，讓您能在閉包內執行取代邏輯，並回傳取代後的值：

use Illuminate\Support\Str;

$replaced = Str::of('123')->replaceMatches('/\d/', function (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 World

`replaceEnd`

replaceEnd 方法會取代給定值的最後一個出現位置，僅在該值出現在字串結尾時：

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 方法會根據 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();

// child

`slug`

slug 方法會從給定字串中產生一個對 URL 友善的「slug」：

use Illuminate\Support\Str;

$slug = Str::of('Laravel Framework')->slug('-');

// laravel-framework

`snake`

snake 方法會將給定字串轉換為 snake_case：

use Illuminate\Support\Str;

$converted = Str::of('fooBar')->snake();

// foo_bar

`split`

split 方法會使用正規表達式將字串分割成一個集合：

use Illuminate\Support\Str;

$segments = Str::of('one, two, three')->split('/[\s,]+/');

// collect(["one", "two", "three"])

`squish`

squish 方法會移除字串中所有多餘的空白，包含單字間的多餘空白：

use Illuminate\Support\Str;

$string = Str::of('    laravel    framework    ')->squish();

// laravel framework

`start`

start 方法會將給定值的一個單一實例加入字串，如果字串還沒有以該值開頭的話：

use Illuminate\Support\Str;

$adjusted = Str::of('this/string')->start('/');

// /this/string

$adjusted = Str::of('/this/string')->start('/');

// /this/string

`startsWith`

startsWith 方法會判斷給定字串是否以給定值開頭：

use Illuminate\Support\Str;

$result = Str::of('This is my name')->startsWith('This');

// true

`stripTags`

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();

// FooBar

`substr`

substr 方法會回傳字串中由給定開始與長度參數所指定的部分：

use Illuminate\Support\Str;

$string = Str::of('Laravel Framework')->substr(8);

// Framework

$string = Str::of('Laravel Framework')->substr(8, 5);

// Frame

`substrReplace`

substrReplace 方法會取代字串中某個部分內的文字，從第二個引數所指定的位置開始，並取代由第三個引數所指定數量的字元。若將 0 傳遞給該方法的第三個引數，則會在指定位置插入字串，而不會取代字串中任何現有字元：

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 方法會使用 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);

// Build

`tap`

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 FRAMEWORK

`test`

test 方法會判斷字串是否符合指定的正規表達式模式：

use Illuminate\Support\Str;

$result = Str::of('Laravel Framework')->test('/Laravel/');

// true

`title`

title 方法會將給定的字串轉換為 Title Case 格式：

use Illuminate\Support\Str;

$converted = Str::of('a nice title uses the correct case')->title();

// A Nice Title Uses The Correct Case

`toBase64`

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();

`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 bar

`ucsplit`

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();

// LARAVEL

`when`

when 方法若給定的條件為 true，則呼叫指定的閉包。閉包將會接收 fluent 字串實例：

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 字串實例：

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 Stark

`whenContainsAll`

whenContainsAll 方法若字串包含所有給定的子字串，則呼叫指定的閉包。閉包將會接收 fluent 字串實例：

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，則會執行這個閉包。

`whenEmpty`

whenEmpty 方法若字串為空，則呼叫指定的閉包。如果閉包回傳一個值，該值也會由 whenEmpty 方法回傳。如果閉包沒有回傳值，則會回傳 fluent 字串實例：

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

$string = Str::of('  ')->whenEmpty(function (Stringable $string) {
    return $string->trim()->prepend('Laravel');
});

// 'Laravel'

`whenNotEmpty`

whenNotEmpty 方法若字串不為空，則呼叫指定的閉包。如果閉包回傳一個值，該值也會由 whenNotEmpty 方法回傳。如果閉包沒有回傳值，則會回傳 fluent 字串實例：

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

$string = Str::of('Framework')->whenNotEmpty(function (Stringable $string) {
    return $string->prepend('Laravel ');
});

// 'Laravel Framework'

`whenStartsWith`

whenStartsWith 方法會在其字串以給定的子字串開頭時呼叫給定的閉包。此閉包會接收流暢字串實例：

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 方法會在其字串以給定的子字串結尾時呼叫給定的閉包。此閉包會接收流暢字串實例：

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 方法會在其字串與給定字串完全符合時呼叫給定的閉包。此閉包會接收流暢字串實例：

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

$string = Str::of('laravel')->whenExactly('laravel', function (Stringable $string) {
    return $string->title();
});

// 'Laravel'

`whenNotExactly`

whenNotExactly 方法會在其字串與給定字串不完全符合時呼叫給定的閉包。此閉包會接收流暢字串實例：

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

$string = Str::of('framework')->whenNotExactly('laravel', function (Stringable $string) {
    return $string->title();
});

// 'Framework'

`whenIs`

whenIs 方法會在其字串符合給定樣式時呼叫給定的閉包。星號可用作萬用字元值。此閉包會接收流暢字串實例：

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 字元時呼叫給定的閉包。此閉包會接收流暢字串實例：

use Illuminate\Support\Str;
use Illuminate\Support\Stringable;

$string = Str::of('laravel')->whenIsAscii(function (Stringable $string) {
    return $string->title();
});

// 'Laravel'

`whenIsUlid`

whenIsUlid 方法會在其字串為有效的 ULID 時呼叫給定的閉包。此閉包會接收流暢字串實例：

use Illuminate\Support\Str;

$string = Str::of('01gd6r360bp37zj17nxb55yv40')->whenIsUlid(function (Stringable $string) {
    return $string->substr(0, 8);
});

// '01gd6r36'

`whenIsUuid`

whenIsUuid 方法會在其字串為有效的 UUID 時呼叫給定的閉包。此閉包會接收流暢字串實例：

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 方法會在其字串符合給定的正規表達式時呼叫給定的閉包。此閉包會接收流暢字串實例：

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 方法會回傳字串中包含的單詞數量：

php

use Illuminate\Support\Str;

Str::of('Hello, world!')->wordCount(); // 2

`words`

words 方法會限制字串中的單詞數量。如有必要，您可以指定一個額外的字串，該字串將附加到截斷的字串末尾：

use Illuminate\Support\Str;

$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');

// Perfectly balanced, as >>>

`wrap`

wrap 方法會使用一個額外的字串或一對字串來包裹給定的字串：

use Illuminate\Support\Str;

Str::of('Laravel')->wrap('"');

// "Laravel"

Str::of('is')->wrap(before: 'This ', after: ' Laravel!');

// This is Laravel!

字串 ​

簡介 ​

可用方法 ​

字串 ​

流暢字串 ​

字串 ​

__() ​

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() ​

Markdown 安全性 ​

Str::is() ​

Str::isAscii() ​

Str::isJson() ​

Str::isUrl() ​

Str::isUlid() ​

Str::isUuid() ​

Str::kebab() ​

Str::lcfirst() ​

Str::length() ​

Str::limit() ​

Str::lower() ​

Str::markdown() ​

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::transliterate() ​

字串

簡介

可用方法

字串

流暢字串

字串

`__()`

`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()`

Markdown 安全性

`Str::is()`

`Str::isAscii()`

`Str::isJson()`

`Str::isUrl()`

`Str::isUlid()`

`Str::isUuid()`

`Str::kebab()`

`Str::lcfirst()`

`Str::length()`

`Str::limit()`

`Str::lower()`

`Str::markdown()`

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::transliterate()`