Laradoc

Appearance

提示 ​

簡介 ​

Laravel Prompts 是一個 PHP 套件，用於為您的命令列應用程式增加美觀且使用者友善的表單，具備類似瀏覽器的功能，包括預留位置文字和驗證。

Laravel Prompts 非常適合在您的 Artisan 主控台命令 中接受使用者輸入，但它也可以用於任何命令列 PHP 專案。

📌 備註

Laravel Prompts 支援 macOS、Linux，以及搭配 WSL 的 Windows。如需更多資訊，請參閱我們關於 不支援的環境與備援機制 的文件。

安裝 ​

Laravel Prompts 已經包含在最新版本的 Laravel 中。

Laravel Prompts 也可以透過 Composer 套件管理器安裝在您的其他 PHP 專案中：

shell
composer require laravel/prompts

可用提示 ​

文字 ​

text 函式會向使用者提示指定問題，接受其輸入，然後傳回：

php
use function Laravel\Prompts\text;

$name = text('What is your name?');

您也可以包含預留位置文字、預設值和資訊提示：

php
$name = text(
    label: 'What is your name?',
    placeholder: 'E.g. Taylor Otwell',
    default: $user?->name,
    hint: 'This will be displayed on your profile.'
);

必填值 ​

如果您要求必須輸入值，可以傳遞 required 引數：

php
$name = text(
    label: 'What is your name?',
    required: true
);

如果您想自訂驗證訊息，也可以傳遞字串：

php
$name = text(
    label: 'What is your name?',
    required: 'Your name is required.'
);

額外驗證 ​

最後，如果您想執行額外的驗證邏輯，可以傳遞一個閉包給 validate 引數：

php
$name = text(
    label: 'What is your name?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'The name must be at least 3 characters.',
        strlen($value) > 255 => 'The name must not exceed 255 characters.',
        default => null
    }
);

該閉包將接收已輸入的值，並可能傳回錯誤訊息，或者，如果驗證通過，則傳回 null。

此外，您可以利用 Laravel 的 驗證器 的強大功能。為此，您可以提供一個包含屬性名稱和所需驗證規則的陣列給 validate 引數：

php
$name = text(
    label: 'What is your name?',
    validate: ['name' => 'required|max:255|unique:users']
);

文字區域 ​

textarea 函式會向使用者提示指定問題，透過多行文字區域接受其輸入，然後傳回：

php
use function Laravel\Prompts\textarea;

$story = textarea('Tell me a story.');

您也可以包含預留位置文字、預設值和資訊提示：

php
$story = textarea(
    label: 'Tell me a story.',
    placeholder: 'This is a story about...',
    hint: 'This will be displayed on your profile.'
);

必填值 ​

如果您要求必須輸入值，可以傳遞 required 引數：

php
$story = textarea(
    label: 'Tell me a story.',
    required: true
);

如果您想自訂驗證訊息，也可以傳遞字串：

php
$story = textarea(
    label: 'Tell me a story.',
    required: 'A story is required.'
);

額外驗證 ​

最後，如果您想執行額外的驗證邏輯，可以傳遞一個閉包給 validate 引數：

php
$story = textarea(
    label: 'Tell me a story.',
    validate: fn (string $value) => match (true) {
        strlen($value) < 250 => 'The story must be at least 250 characters.',
        strlen($value) > 10000 => 'The story must not exceed 10,000 characters.',
        default => null
    }
);

該閉包將接收已輸入的值，並可能傳回錯誤訊息，或者，如果驗證通過，則傳回 null。

此外，您可以利用 Laravel 的 驗證器 的強大功能。為此，您可以提供一個包含屬性名稱和所需驗證規則的陣列給 validate 引數：

php
$story = textarea(
    label: 'Tell me a story.',
    validate: ['story' => 'required|max:10000']
);

密碼 ​

password 函式與 text 函式類似，但使用者的輸入在終端機輸入時會被隱藏。這在要求輸入密碼等敏感資訊時很有用：

php
use function Laravel\Prompts\password;

$password = password('What is your password?');

您也可以包含預留位置文字和資訊提示：

php
$password = password(
    label: 'What is your password?',
    placeholder: 'password',
    hint: 'Minimum 8 characters.'
);

必填值 ​

如果您要求必須輸入值，可以傳遞 required 引數：

php
$password = password(
    label: 'What is your password?',
    required: true
);

如果您想自訂驗證訊息，也可以傳遞字串：

php
$password = password(
    label: 'What is your password?',
    required: 'The password is required.'
);

額外驗證 ​

最後，如果您想執行額外的驗證邏輯，可以傳遞一個閉包給 validate 引數：

php
$password = password(
    label: 'What is your password?',
    validate: fn (string $value) => match (true) {
        strlen($value) < 8 => 'The password must be at least 8 characters.',
        default => null
    }
);

該閉包將接收已輸入的值，並可能傳回錯誤訊息，或者，如果驗證通過，則傳回 null。

此外，您可以利用 Laravel 的 驗證器 的強大功能。為此，您可以提供一個包含屬性名稱和所需驗證規則的陣列給 validate 引數：

php
$password = password(
    label: 'What is your password?',
    validate: ['password' => 'min:8']
);

確認 ​

如果您需要向使用者提出「是或否」的確認，可以使用 confirm 函式。使用者可以使用箭頭鍵或按 y 或 n 來選擇他們的回應。此函式將傳回 true 或 false。

php
use function Laravel\Prompts\confirm;

$confirmed = confirm('Do you accept the terms?');

您也可以包含預設值、「是」和「否」標籤的自訂措辭以及資訊提示：

php
$confirmed = confirm(
    label: 'Do you accept the terms?',
    default: false,
    yes: 'I accept',
    no: 'I decline',
    hint: 'The terms must be accepted to continue.'
);

必須選擇「是」 ​

如有必要，您可以透過傳遞 required 引數來要求您的使用者選擇「是」：

php
$confirmed = confirm(
    label: 'Do you accept the terms?',
    required: true
);

如果您想自訂驗證訊息，也可以傳遞字串：

php
$confirmed = confirm(
    label: 'Do you accept the terms?',
    required: 'You must accept the terms to continue.'
);

選擇 ​

如果您需要使用者從預定義的選項中進行選擇，您可以使用 select 函式：

php
use function Laravel\Prompts\select;

$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner']
);

您也可以指定預設選項和一個資訊提示：

php
$role = select(
    label: 'What role should the user have?',
    options: ['Member', 'Contributor', 'Owner'],
    default: 'Owner',
    hint: 'The role may be changed at any time.'
);

您也可以傳遞一個關聯式陣列給 options 參數，以便傳回所選的鍵而非其值：

php
$role = select(
    label: 'What role should the user have?',
    options: [
        'member' => 'Member',
        'contributor' => 'Contributor',
        'owner' => 'Owner',
    ],
    default: 'owner'
);

在列表開始捲動之前，最多會顯示五個選項。您可以透過傳遞 scroll 參數來進行自訂：

php
$role = select(
    label: 'Which category would you like to assign?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

額外驗證 ​

與其他提示函式不同，select 函式不接受 required 參數，因為無法不選擇任何東西。然而，如果您需要呈現一個選項但阻止其被選取，您可以傳遞一個閉包給 validate 參數：

php
$role = select(
    label: 'What role should the user have?',
    options: [
        'member' => 'Member',
        'contributor' => 'Contributor',
        'owner' => 'Owner',
    ],
    validate: fn (string $value) =>
        $value === 'owner' && User::where('role', 'owner')->exists()
            ? 'An owner already exists.'
            : null
);

如果 options 參數是關聯式陣列，則閉包將接收所選的鍵；否則將接收所選的值。如果驗證通過，閉包可以傳回錯誤訊息，或 null。

多選 ​

如果您需要使用者能夠選擇多個選項，您可以使用 multiselect 函式：

php
use function Laravel\Prompts\multiselect;

$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: ['Read', 'Create', 'Update', 'Delete']
);

您也可以指定預設選項和一個資訊提示：

php
use function Laravel\Prompts\multiselect;

$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: ['Read', 'Create', 'Update', 'Delete'],
    default: ['Read', 'Create'],
    hint: 'Permissions may be updated at any time.'
);

您也可以傳遞一個關聯式陣列給 options 參數，以便傳回所選選項的鍵而非其值：

php
$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: [
        'read' => 'Read',
        'create' => 'Create',
        'update' => 'Update',
        'delete' => 'Delete',
    ],
    default: ['read', 'create']
);

在列表開始捲動之前，最多會顯示五個選項。您可以透過傳遞 scroll 參數來進行自訂：

php
$categories = multiselect(
    label: 'What categories should be assigned?',
    options: Category::pluck('name', 'id'),
    scroll: 10
);

要求值 ​

預設情況下，使用者可以選擇零個或多個選項。您可以傳遞 required 參數來強制選擇一個或多個選項：

php
$categories = multiselect(
    label: 'What categories should be assigned?',
    options: Category::pluck('name', 'id'),
    required: true
);

如果您想自訂驗證訊息，您可以向 required 參數提供一個字串：

php
$categories = multiselect(
    label: 'What categories should be assigned?',
    options: Category::pluck('name', 'id'),
    required: 'You must select at least one category'
);

額外驗證 ​

如果您需要呈現一個選項但阻止其被選取，您可以傳遞一個閉包給 validate 參數：

php
$permissions = multiselect(
    label: 'What permissions should the user have?',
    options: [
        'read' => 'Read',
        'create' => 'Create',
        'update' => 'Update',
        'delete' => 'Delete',
    ],
    validate: fn (array $values) => ! in_array('read', $values)
        ? 'All users require the read permission.'
        : null
);

如果 options 參數是關聯式陣列，則閉包將接收所選的鍵；否則將接收所選的值。如果驗證通過，閉包可以傳回錯誤訊息，或 null。

建議 ​

suggest 函式可用於為可能的選項提供自動完成功能。使用者仍然可以提供任何答案，無論自動完成提示如何：

php
use function Laravel\Prompts\suggest;

$name = suggest('What is your name?', ['Taylor', 'Dayle']);

或者，您可以將一個閉包作為第二個參數傳遞給 suggest 函式。每次使用者輸入一個字元時，都會呼叫該閉包。該閉包應接受一個包含使用者目前輸入的字串參數，並傳回一個用於自動完成的選項陣列：

php
$name = suggest(
    label: 'What is your name?',
    options: fn ($value) => collect(['Taylor', 'Dayle'])
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
)

您也可以包含佔位符文字、預設值和資訊提示：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    placeholder: 'E.g. Taylor',
    default: $user?->name,
    hint: 'This will be displayed on your profile.'
);

要求值 ​

如果您要求輸入一個值，您可以傳遞 required 參數：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    required: true
);

如果您想自訂驗證訊息，您也可以傳遞一個字串：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    required: 'Your name is required.'
);

額外驗證 ​

最後，如果您想執行額外的驗證邏輯，您可以傳遞一個閉包給 validate 參數：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'The name must be at least 3 characters.',
        strlen($value) > 255 => 'The name must not exceed 255 characters.',
        default => null
    }
);

該閉包將接收已輸入的值，如果驗證通過，它可以傳回錯誤訊息，或 null。

或者，您可以利用 Laravel 的 validator 的功能。為此，請提供一個包含屬性名稱和所需驗證規則的陣列給 validate 參數：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    validate: ['name' => 'required|min:3|max:255']
);

搜尋 ​

如果您有許多選項供使用者選擇，search 函數允許使用者輸入搜尋查詢來篩選結果，然後再使用方向鍵選擇選項：

php
use function Laravel\Prompts\search;

$id = search(
    label: 'Search for the user that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

此閉包將接收使用者目前輸入的文字，並且必須回傳一個選項陣列。如果您回傳一個關聯陣列，則會回傳所選選項的鍵，否則會回傳其值。

當您篩選一個打算回傳值的陣列時，您應該使用 array_values 函數或 values Collection 方法，以確保陣列不會變成關聯陣列：

php
$names = collect(['Taylor', 'Abigail']);

$selected = search(
    label: 'Search for the user that should receive the mail',
    options: fn (string $value) => $names
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
        ->values()
        ->all(),
);

您也可以包含預留位置文字和資訊提示：

php
$id = search(
    label: 'Search for the user that should receive the mail',
    placeholder: 'E.g. Taylor Otwell',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: 'The user will receive an email immediately.'
);

清單開始捲動前會顯示最多五個選項。您可以透過傳遞 scroll 引數來自訂此行為：

php
$id = search(
    label: 'Search for the user that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    scroll: 10
);

額外驗證 ​

如果您想執行額外的驗證邏輯，您可以將閉包傳遞給 validate 引數：

php
$id = search(
    label: 'Search for the user that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    validate: function (int|string $value) {
        $user = User::findOrFail($value);

        if ($user->opted_out) {
            return 'This user has opted-out of receiving mail.';
        }
    }
);

如果 options 閉包回傳關聯陣列，則該閉包將接收所選的鍵；否則，它將接收所選的值。如果驗證通過，該閉包可以回傳錯誤訊息，或回傳 null。

多重搜尋 ​

如果您有許多可搜尋的選項，且需要使用者能夠選擇多個項目，multisearch 函數允許使用者輸入搜尋查詢來篩選結果，然後再使用方向鍵和空白鍵選擇選項：

php
use function Laravel\Prompts\multisearch;

$ids = multisearch(
    'Search for the users that should receive the mail',
    fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : []
);

此閉包將接收使用者目前輸入的文字，並且必須回傳一個選項陣列。如果您回傳一個關聯陣列，則會回傳所選選項的鍵；否則，會回傳它們的值。

當您篩選一個打算回傳值的陣列時，您應該使用 array_values 函數或 values Collection 方法，以確保陣列不會變成關聯陣列：

php
$names = collect(['Taylor', 'Abigail']);

$selected = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => $names
        ->filter(fn ($name) => Str::contains($name, $value, ignoreCase: true))
        ->values()
        ->all(),
);

您也可以包含預留位置文字和資訊提示：

php
$ids = multisearch(
    label: 'Search for the users that should receive the mail',
    placeholder: 'E.g. Taylor Otwell',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    hint: 'The user will receive an email immediately.'
);

清單開始捲動前會顯示最多五個選項。您可以透過提供 scroll 引數來自訂此行為：

php
$ids = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    scroll: 10
);

要求輸入值 ​

預設情況下，使用者可以選擇零個或多個選項。您可以傳遞 required 引數來強制要求選擇一個或多個選項：

php
$ids = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    required: true
);

如果您想自訂驗證訊息，您也可以向 required 引數提供字串：

php
$ids = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    required: 'You must select at least one user.'
);

額外驗證 ​

如果您想執行額外的驗證邏輯，您可以將閉包傳遞給 validate 引數：

php
$ids = multisearch(
    label: 'Search for the users that should receive the mail',
    options: fn (string $value) => strlen($value) > 0
        ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
        : [],
    validate: function (array $values) {
        $optedOut = User::whereLike('name', '%a%')->findMany($values);

        if ($optedOut->isNotEmpty()) {
            return $optedOut->pluck('name')->join(', ', ', and ').' have opted out.';
        }
    }
);

如果 options 閉包回傳關聯陣列，則該閉包將接收所選的鍵；否則，它將接收所選的值。如果驗證通過，該閉包可以回傳錯誤訊息，或回傳 null。

暫停 ​

pause 函數可用於向使用者顯示資訊文字，並等待他們按下 Enter / Return 鍵確認是否繼續：

php
use function Laravel\Prompts\pause;

pause('Press ENTER to continue.');

驗證前轉換輸入 ​

有時您可能希望在驗證發生之前轉換提示輸入。例如，您可能希望從任何提供的字串中移除空白。為此，許多提示函式都提供一個 transform 參數，它接受一個閉包：

php
$name = text(
    label: 'What is your name?',
    transform: fn (string $value) => trim($value),
    validate: fn (string $value) => match (true) {
        strlen($value) < 3 => 'The name must be at least 3 characters.',
        strlen($value) > 255 => 'The name must not exceed 255 characters.',
        default => null
    }
);

表單 ​

通常，您會有許多提示會依序顯示，以便在執行額外動作之前收集資訊。您可以使用 form 函式來建立一組供使用者完成的群組提示：

php
use function Laravel\Prompts\form;

$responses = form()
    ->text('What is your name?', required: true)
    ->password('What is your password?', validate: ['password' => 'min:8'])
    ->confirm('Do you accept the terms?')
    ->submit();

submit 方法將回傳一個包含表單所有提示回應的數字索引陣列。不過，您可以透過 name 引數為每個提示提供一個名稱。當提供名稱時，可以透過該名稱存取具名提示的回應：

php
use App\Models\User;
use function Laravel\Prompts\form;

$responses = form()
    ->text('What is your name?', required: true, name: 'name')
    ->password(
        label: 'What is your password?',
        validate: ['password' => 'min:8'],
        name: 'password'
    )
    ->confirm('Do you accept the terms?')
    ->submit();

User::create([
    'name' => $responses['name'],
    'password' => $responses['password'],
]);

使用 form 函式的主要好處是，使用者可以使用 CTRL + U 返回表單中先前的提示。這讓使用者可以修正錯誤或更改選擇，而無需取消並重新啟動整個表單。

如果您需要更精細地控制表單中的提示，您可以呼叫 add 方法，而不是直接呼叫其中一個提示函式。add 方法會傳遞使用者提供的所有先前回應：

php
use function Laravel\Prompts\form;
use function Laravel\Prompts\outro;
use function Laravel\Prompts\text;

$responses = form()
    ->text('What is your name?', required: true, name: 'name')
    ->add(function ($responses) {
        return text("How old are you, {$responses['name']}?");
    }, name: 'age')
    ->submit();

outro("Your name is {$responses['name']} and you are {$responses['age']} years old.");

資訊訊息 ​

note、info、warning、error 和 alert 函式可用於顯示資訊訊息：

php
use function Laravel\Prompts\info;

info('Package installed successfully.');

表格 ​

table 函式可輕鬆顯示多行多列的資料。您只需提供欄位名稱和表格資料即可：

php
use function Laravel\Prompts\table;

table(
    headers: ['Name', 'Email'],
    rows: User::all(['name', 'email'])->toArray()
);

旋轉 ​

spin 函式會在執行指定的回呼時，顯示一個旋轉指示器和一個可選訊息。它用於指示正在進行的處理程序，並在完成時回傳回呼的結果：

php
use function Laravel\Prompts\spin;

$response = spin(
    callback: fn () => Http::get('http://example.com'),
    message: 'Fetching response...'
);

警告

spin 函式需要 PCNTL PHP 擴充功能才能讓旋轉指示器動起來。當此擴充功能不可用時，將改為顯示靜態版本的旋轉指示器。

進度條 ​

對於長時間執行的任務，顯示一個進度條以告知使用者任務完成度會很有幫助。使用 progress 函式，Laravel 會顯示一個進度條，並在對給定可迭代值進行每次迭代時推進其進度：

php
use function Laravel\Prompts\progress;

$users = progress(
    label: 'Updating users',
    steps: User::all(),
    callback: fn ($user) => $this->performTask($user)
);

progress 函式的作用類似於 map 函式，並將回傳一個陣列，其中包含您回呼每次迭代的回傳值。

回呼也可以接受 Laravel\Prompts\Progress 實例，讓您可以在每次迭代時修改標籤和提示：

php
$users = progress(
    label: 'Updating users',
    steps: User::all(),
    callback: function ($user, $progress) {
        $progress
            ->label("Updating {$user->name}")
            ->hint("Created on {$user->created_at}");

        return $this->performTask($user);
    },
    hint: 'This may take some time.'
);

有時，您可能需要更手動地控制進度條的推進方式。首先，定義處理程序將迭代的總步驟數。然後，在處理每個項目後，透過 advance 方法推進進度條：

php
$progress = progress(label: 'Updating users', steps: 10);

$users = User::all();

$progress->start();

foreach ($users as $user) {
    $this->performTask($user);

    $progress->advance();
}

$progress->finish();

清除終端機 ​

clear 函式可用於清除使用者的終端機：

php
use function Laravel\Prompts\clear;

clear();

終端機考量 ​

終端機寬度 ​

如果任何標籤、選項或驗證訊息的長度超過使用者終端機中的「欄位」數量，它將自動截斷以符合。如果您的使用者可能使用較窄的終端機，請考慮縮短這些字串的長度。通常，安全的建議最大長度為 74 個字元，以支援 80 字元的終端機。

終端機高度 ​

對於任何接受 scroll 引數的提示，其設定值將自動縮減以符合使用者終端機的高度，包含驗證訊息的空間。

不支援的環境與備援機制 ​

Laravel Prompts 支援 macOS、Linux 以及搭配 WSL 的 Windows。由於 PHP 的 Windows 版本存在限制，目前無法在 WSL 之外的 Windows 環境中使用 Laravel Prompts。

因此，Laravel Prompts 支援回退到替代實作，例如 Symfony Console Question Helper。

📌 備註

當使用 Laravel Prompts 搭配 Laravel 框架時，每個提示的備援機制已為您配置完成，並將在不支援的環境中自動啟用。

備援條件 ​

如果您未使用 Laravel 或需要自訂備援行為的使用時機，可以將布林值傳遞給 Prompt 類別上的 fallbackWhen 靜態方法：

php
use Laravel\Prompts\Prompt;

Prompt::fallbackWhen(
    ! $input->isInteractive() || windows_os() || app()->runningUnitTests()
);

備援行為 ​

如果您未使用 Laravel 或需要自訂備援行為，可以將閉包傳遞給每個提示類別上的 fallbackUsing 靜態方法：

php
use Laravel\Prompts\TextPrompt;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Style\SymfonyStyle;

TextPrompt::fallbackUsing(function (TextPrompt $prompt) use ($input, $output) {
    $question = (new Question($prompt->label, $prompt->default ?: null))
        ->setValidator(function ($answer) use ($prompt) {
            if ($prompt->required && $answer === null) {
                throw new \RuntimeException(
                    is_string($prompt->required) ? $prompt->required : 'Required.'
                );
            }

            if ($prompt->validate) {
                $error = ($prompt->validate)($answer ?? '');

                if ($error) {
                    throw new \RuntimeException($error);
                }
            }

            return $answer;
        });

    return (new SymfonyStyle($input, $output))
        ->askQuestion($question);
});

備援機制必須針對每個提示類別獨立配置。該閉包將會收到提示類別的實例，並且必須回傳對於該提示適當的型別。

測試 ​

Laravel 提供多種方法，用於測試您的命令是否顯示預期的 Prompt 訊息：

php
test('report generation', function () {
    $this->artisan('report:generate')
        ->expectsPromptsInfo('Welcome to the application!')
        ->expectsPromptsWarning('This action cannot be undone')
        ->expectsPromptsError('Something went wrong')
        ->expectsPromptsAlert('Important notice!')
        ->expectsPromptsIntro('Starting process...')
        ->expectsPromptsOutro('Process completed!')
        ->expectsPromptsTable(
            headers: ['Name', 'Email'],
            rows: [
                ['Taylor Otwell', '[email protected]'],
                ['Jason Beggs', '[email protected]'],
            ]
        )
        ->assertExitCode(0);
});
php
public function test_report_generation(): void
{
    $this->artisan('report:generate')
        ->expectsPromptsInfo('Welcome to the application!')
        ->expectsPromptsWarning('This action cannot be undone')
        ->expectsPromptsError('Something went wrong')
        ->expectsPromptsAlert('Important notice!')
        ->expectsPromptsIntro('Starting process...')
        ->expectsPromptsOutro('Process completed!')
        ->expectsPromptsTable(
            headers: ['Name', 'Email'],
            rows: [
                ['Taylor Otwell', '[email protected]'],
                ['Jason Beggs', '[email protected]'],
            ]
        )
        ->assertExitCode(0);
}