Laradoc

Appearance

Prompts ​

簡介 ​

Laravel Prompts 是一個 PHP 套件，可用於在您的命令列應用程式中加入美觀且使用者友好的表單，並提供包括佔位文字與驗證在內等類似瀏覽器的功能。

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

📌 備註

Laravel Prompts 支援 macOS、Linux 以及搭載 WSL 的 Windows。欲了解更多資訊，請參閱我們的不支援的環境與回退機制文件。

安裝 ​

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

您也可以使用 Composer 套件管理工具將 Laravel Prompts 安裝到您的其他 PHP 專案中：

shell
composer require laravel/prompts

可用的 Prompts ​

文字 ​

text 函式會根據給定的問題提示使用者，接收其輸入，然後將其回傳：

php
use function Laravel\Prompts\text;

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

您也可以包含佔位文字 (placeholder text)、預設值以及資訊提示 (informational hint)：

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 驗證器 (validator) 的強大功能。若要這樣做，請向 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 驗證器 (validator) 的強大功能。若要這樣做，請向 validate 引數提供一個包含屬性名稱與所需驗證規則的陣列：

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

數字 ​

number 函式會根據給定的問題提示使用者，接收其數字輸入，然後將其回傳。number 函式允許使用者使用方向鍵的上、下鍵來調整數字：

php
use function Laravel\Prompts\number;

$number = number('How many copies would you like?');

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

php
$name = number(
    label: 'How many copies would you like?',
    placeholder: '5',
    default: 1,
    hint: 'This will be determine how many copies to create.'
);

必填值 ​

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

php
$copies = number(
    label: 'How many copies would you like?',
    required: true
);

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

php
$copies = number(
    label: 'How many copies would you like?',
    required: 'A number of copies is required.'
);

額外驗證 ​

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

php
$copies = number(
    label: 'How many copies would you like?',
    validate: fn (?int $value) => match (true) {
        $value < 1 => 'At least one copy is required.',
        $value > 100 => 'You may not create more than 100 copies.',
        default => null
    }
);

該閉包將接收已輸入的值，並在驗證通過時回傳 null，否則回傳錯誤訊息。

或者，您也可以利用 Laravel 驗證器 (validator) 的強大功能。若要這樣做，請向 validate 引數提供一個包含屬性名稱與所需驗證規則的陣列：

php
$copies = number(
    label: 'How many copies would you like?',
    validate: ['copies' => 'required|integer|min:1|max:100']
);

密碼 ​

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 驗證器 (validator) 的強大功能。若要這樣做，請向 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 引數，以便回傳所選的鍵（key）而非其值（value）：

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

次要資訊 ​

info 引數可用於顯示關於目前高亮選項的額外資訊。當提供一個閉包時，它將接收目前高亮選項的值，並應回傳一個字串或 null：

php
$role = select(
    label: 'What role should the user have?',
    options: [
        'member' => 'Member',
        'contributor' => 'Contributor',
        'owner' => 'Owner',
    ],
    info: fn (string $value) => match ($value) {
        'member' => 'Can view and comment.',
        'contributor' => 'Can view, comment, and edit.',
        'owner' => 'Full access to all resources.',
        default => null,
    }
);

如果資訊不依賴於高亮選項，您也可以將靜態字串傳遞給 info 引數：

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

額外驗證 ​

與其他 Prompt 函式不同，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
);

次要資訊 ​

info 引數可用於顯示關於目前高亮選項的額外資訊。當提供一個閉包時，它將接收目前高亮選項的值，並應回傳一個字串或 null：

php
$permissions = multiselect(
    label: 'What permissions should be assigned?',
    options: [
        'read' => 'Read',
        'create' => 'Create',
        'update' => 'Update',
        'delete' => 'Delete',
    ],
    info: fn (string $value) => match ($value) {
        'read' => 'View resources and their properties.',
        'create' => 'Create new resources.',
        'update' => 'Modify existing resources.',
        'delete' => 'Permanently remove resources.',
        default => null,
    }
);

要求輸入值 ​

預設情況下，使用者可以選擇零個或多個選項。您可以傳遞 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.'
);

次要資訊 ​

info 引數可用於顯示關於目前高亮選項的額外資訊。當提供閉包時，它將接收目前高亮選項的值，並應回傳一個字串或 null：

php
$name = suggest(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle'],
    info: fn (string $value) => match ($value) {
        'Taylor' => 'Administrator',
        'Dayle' => 'Contributor',
        default => null,
    }
);

必要值 ​

如果您要求必須輸入值，可以傳遞 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()
        : []
);

該閉包將接收使用者目前為止輸入的文字，且必須回傳一個選項陣列。如果您回傳的是關聯陣列，則會回傳所選選項的鍵 (key)；否則將回傳其值 (value)。

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

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

次要資訊 ​

info 引數可用於顯示關於目前高亮選項的額外資訊。當提供閉包時，它將接收目前高亮選項的值，並應回傳一個字串或 null：

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()
        : [],
    info: fn (int $userId) => User::find($userId)?->email
);

額外驗證 ​

如果您想要執行額外的驗證邏輯，可以將一個閉包傳遞給 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 閉包回傳關聯陣列，則該閉包將接收所選的鍵 (key)；否則，它將接收所選的值 (value)。該閉包可以在驗證通過時回傳 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()
        : []
);

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

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

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

次要資訊 ​

info 引數可用於顯示關於目前高亮選項的附加資訊。當提供閉包時，它將接收目前高亮選項的值，並應回傳一個字串或 null：

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()
        : [],
    info: fn (int $userId) => User::find($userId)?->email
);

要求輸入值 ​

預設情況下，使用者可以選擇零個或多個選項。您可以傳遞 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.');

自動完成 ​

autocomplete 函式可用於為可能的選擇提供行內自動完成。當使用者輸入時，與其輸入匹配的建議將以幽靈文字 (ghost text) 形式出現，可以透過按下 Tab 或右方向鍵來接受：

php
use function Laravel\Prompts\autocomplete;

$name = autocomplete(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle', 'Jess', 'Nuno', 'Tim']
);

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

php
$name = autocomplete(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle', 'Jess', 'Nuno', 'Tim'],
    placeholder: 'E.g. Taylor',
    default: $user?->name,
    hint: 'Use tab to accept, up/down to cycle.'
);

動態選項 ​

您也可以傳遞一個閉包，根據使用者的輸入動態生成選項。每當使用者輸入一個字元時，該閉包都會被呼叫，並應回傳一個用於自動完成的選項陣列：

php
$file = autocomplete(
    label: 'Which file?',
    options: fn (string $value) => collect($files)
        ->filter(fn ($file) => str_starts_with(strtolower($file), strtolower($value)))
        ->values()
        ->all(),
);

要求輸入值 ​

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

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

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

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

額外驗證 ​

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

php
$name = autocomplete(
    label: 'What is your name?',
    options: ['Taylor', 'Dayle', 'Jess', 'Nuno', 'Tim'],
    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。

在驗證前轉換輸入 ​

有時您可能希望在驗證執行之前先轉換 prompt 的輸入。例如，您可能希望移除提供字串中的空白字元。為了達成此目的，許多 prompt 函數提供了一個 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
    }
);

表單 ​

通常，您會有數個按順序顯示的 prompt，用以在執行其他操作前收集資訊。您可以使用 form 函數來建立一組讓使用者填寫的 prompt 組合：

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 方法將返回一個以數字為索引的陣列，其中包含表單中所有 prompt 的回應。不過，您也可以透過 name 引數為每個 prompt 提供名稱。當提供了名稱時，即可透過該名稱來存取該具名 prompt 的回應：

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 返回表單中的上一個 prompt。這讓使用者能夠修正錯誤或更改選擇，而無需取消並重新開始整個表單。

如果您需要對表單中的 prompt 進行更精細的控制，可以調用 add 方法，而不是直接調用 prompt 函數。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 函數在執行指定的回呼 (callback) 時，會顯示一個載入動畫 (spinner) 以及一個可選的訊息。它用於指示正在進行的行程，並在完成時返回回呼的結果：

php
use function Laravel\Prompts\spin;

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

⚠️ 警告

spin 函數需要 PCNTL PHP 擴充功能來驅動載入動畫。當此擴充功能不可用時，將會顯示靜態版本的載入動畫。

進度條 ​

對於執行時間較長的任務，顯示一個進度條來告知使用者任務的完成進度會非常有幫助。使用 progress 函數，Laravel 會顯示一個進度條，並在對給定的可迭代 (iterable) 值進行每次迭代時推進進度：

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 實例，讓您在每次迭代時修改標籤 (label) 和提示 (hint)：

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

任務 ​

task 函數會在執行指定的回呼函數 (callback) 時，顯示一個帶有標籤的任務、載入動畫以及一個可滾動的即時輸出區域。它非常適合用來封裝耗時較長的行程（例如安裝依賴項目或部署腳本），以提供執行狀況的即時可視化：

php
use function Laravel\Prompts\task;

task(
    label: 'Installing dependencies',
    callback: function ($logger) {
        // Long-running process...
    }
);

該回呼函數會接收到一個 Logger 實例，您可以使用它在任務的輸出區域中顯示紀錄行、狀態訊息以及串流文字。

⚠️ 警告

task 函數需要 PCNTL PHP 擴展才能讓載入動畫產生動畫效果。當此擴展不可用時，將會顯示靜態版本的任務。

紀錄行 ​

line 方法會將單行紀錄寫入任務的滾動輸出區域：

php
task(
    label: 'Installing dependencies',
    callback: function ($logger) {
        $logger->line('Resolving packages...');
        // ...
        $logger->line('Downloading laravel/framework');
        // ...
    }
);

狀態訊息 ​

您可以使用 success、warning 和 error 方法來顯示狀態訊息。這些訊息會以穩定且高亮的格式顯示在滾動紀錄區域上方：

php
task(
    label: 'Deploying application',
    callback: function ($logger) {
        $logger->line('Pulling latest changes...');
        // ...
        $logger->success('Changes pulled!');

        $logger->line('Running migrations...');
        // ...
        $logger->warning('No new migrations to run.');

        $logger->line('Clearing cache...');
        // ...
        $logger->success('Cache cleared!');
    }
);

更新標籤 ​

label 方法允許您在任務執行期間更新其標籤：

php
task(
    label: 'Starting deployment...',
    callback: function ($logger) {
        $logger->label('Pulling latest changes...');
        // ...
        $logger->label('Running migrations...');
        // ...
        $logger->label('Clearing cache...');
        // ...
    }
);

串流文字 ​

對於會逐步產生輸出的行程（例如 AI 產生的回應），partial 方法允許您逐字或逐塊地串流文字。一旦串流完成，請呼叫 commitPartial 來完成輸出：

php
task(
    label: 'Generating response...',
    callback: function ($logger) {
        foreach ($words as $word) {
            $logger->partial($word . ' ');
        }

        $logger->commitPartial();
    }
);

自定義輸出限制 ​

預設情況下，任務會顯示最多 10 行的滾動輸出。您可以使用 limit 引數來自定義此限制：

php
task(
    label: 'Installing dependencies',
    callback: function ($logger) {
        // ...
    },
    limit: 20
);

串流 ​

stream 函數會顯示串流進入終端機的文字，非常適合用來顯示 AI 產生的內容或任何逐步到達的文字：

php
use function Laravel\Prompts\stream;

$stream = stream();

foreach ($words as $word) {
    $stream->append($word . ' ');
    usleep(25_000); // Simulate delay between chunks...
}

$stream->close();

append 方法將文字新增至串流中，並以漸顯效果呈現。當所有內容都串流完畢後，呼叫 close 方法來完成輸出並恢復游標。

終端機標題 ​

title 函數會更新使用者終端機視窗或分頁的標題：

php
use function Laravel\Prompts\title;

title('Installing Dependencies');

若要將終端機標題重設為預設值，請傳遞一個空字串：

php
title('');

清除終端機 ​

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

php
use function Laravel\Prompts\clear;

clear();

終端機注意事項 ​

終端機寬度 ​

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

終端機高度 ​

對於任何接受 scroll 引數的 prompt，配置的值將會自動減少，以適應使用者終端機的高度，包括留給驗證訊息的空間。

不支援的環境與回退機制 ​

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

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

📌 備註

當在 Laravel 框架中使用 Laravel Prompts 時，每個 prompt 的回退機制都已經為您配置好了，並會在不支援的環境中自動啟用。

回退條件 ​

如果您沒有使用 Laravel，或者需要自定義何時使用回退行為，您可以將布林值傳遞給 Prompt 類別的 fallbackWhen 靜態方法：

php
use Laravel\Prompts\Prompt;

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

回退行為 ​

如果您沒有使用 Laravel，或者需要自定義回退行為，您可以將閉包 (closure) 傳遞給每個 prompt 類別的 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);
});

回退機制必須為每個 prompt 類別單獨配置。閉包將會接收到該 prompt 類別的一個實例，且必須回傳適合該 prompt 的類型。

測試 ​

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