Artisan Console

簡介
- Tinker (REPL)
撰寫指令
定義輸入預期
指令 I/O
註冊指令
以程式化方式執行指令
- 從其他指令呼叫指令
訊號處理
Stub 客製化
事件

簡介

Artisan 是 Laravel 隨附的命令列介面。Artisan 以 artisan 腳本的形式存在於您應用程式的根目錄，並提供許多有用的指令，可在您建構應用程式時提供協助。要查看所有可用 Artisan 指令的清單，您可以使用 list 指令：

shell

php artisan list

每個指令還包含一個「說明畫面」，用於顯示和描述該指令可用的引數和選項。要查看說明畫面，請在指令名稱前加上 help：

shell

php artisan help migrate

Laravel Sail

如果您正在使用 Laravel Sail 作為您的本機開發環境，請記住使用 sail 命令列來呼叫 Artisan 指令。Sail 將在您應用程式的 Docker 容器中執行您的 Artisan 指令：

shell

./vendor/bin/sail artisan list

Tinker (REPL)

Laravel Tinker 是 Laravel 框架的一個強大 REPL，由 PsySH 套件提供支援。

安裝

所有 Laravel 應用程式都預設包含 Tinker。但是，如果您之前已將其從應用程式中移除，則可以使用 Composer 安裝 Tinker：

shell

composer require laravel/tinker

📌 備註

正在尋找在與您的 Laravel 應用程式互動時的熱重載、多行程式碼編輯和自動補齊功能嗎？請查看 Tinkerwell！

用法

Tinker 允許您在命令列上與您的整個 Laravel 應用程式互動，包括您的 Eloquent models、工作、事件等等。要進入 Tinker 環境，請執行 tinker Artisan 指令：

shell

php artisan tinker

您可以使用 vendor:publish 指令發佈 Tinker 的設定檔：

shell

php artisan vendor:publish --provider="Laravel\Tinker\TinkerServiceProvider"

⚠️ 警告

dispatch 輔助函式和 Dispatchable 類別上的 dispatch 方法依賴於垃圾收集來將工作放入佇列。因此，使用 Tinker 時，您應該使用 Bus::dispatch 或 Queue::push 來分派工作。

指令允許清單

Tinker 使用一個「允許」清單來確定哪些 Artisan 指令被允許在其 Shell 中執行。預設情況下，您可以執行 clear-compiled、down、env、inspire、migrate、migrate:install、up 和 optimize 指令。如果您想允許更多指令，您可以將它們添加到 tinker.php 設定檔中的 commands 陣列中：

php

'commands' => [
    // App\Console\Commands\ExampleCommand::class,
],

不應建立別名的類別

通常，當您在 Tinker 中與類別互動時，Tinker 會自動為其建立別名。但是，您可能希望永不為某些類別建立別名。您可以透過在 tinker.php 設定檔的 dont_alias 陣列中列出這些類別來達成此目的：

php

'dont_alias' => [
    App\Models\User::class,
],

撰寫指令

除了 Artisan 提供的指令之外，您也可以建立自己的自訂指令。指令通常儲存在 app/Console/Commands 目錄中；但是，您可以自由選擇自己的儲存位置，只要您指示 Laravel 掃描其他目錄以尋找 Artisan 指令即可。

產生指令

要建立一個新指令，您可以使用 make:command Artisan 指令。此指令將會在 app/Console/Commands 目錄中建立一個新的指令類別。如果此目錄在您的應用程式中不存在，請不用擔心，它會在您第一次執行 make:command Artisan 指令時被建立：

shell

php artisan make:command SendEmails

指令結構

產生指令後，您應該為類別的 signature 與 description 屬性定義適當的值。這些屬性將用於在 list 畫面顯示您的指令。signature 屬性也允許您定義指令的輸入預期。handle 方法將在指令執行時被呼叫。您可以將指令邏輯放在此方法中。

讓我們看看一個範例指令。請注意，我們可以透過指令的 handle 方法請求任何所需的依賴。Laravel 服務容器將自動注入此方法簽章中所有型別提示的依賴：

php

<?php

namespace App\Console\Commands;

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Console\Command;

class SendEmails extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Send a marketing email to a user';

    /**
     * Execute the console command.
     */
    public function handle(DripEmailer $drip): void
    {
        $drip->send(User::find($this->argument('user')));
    }
}

📌 備註

為了提高程式碼的重複使用性，最佳實務是保持您的主控台指令輕量化，並讓它們委託給應用程式服務來完成其任務。在上述範例中，請注意我們注入了一個服務類別來執行發送電子郵件的「繁重工作」。

結束碼

如果 handle 方法沒有回傳任何值，且指令成功執行，該指令將以 0 結束碼退出，表示成功。然而，handle 方法可以選擇性地回傳一個整數來手動指定指令的結束碼：

php

$this->error('Something went wrong.');

return 1;

如果您想在指令中的任何方法中「失敗」指令，您可以使用 fail 方法。fail 方法將立即終止指令的執行並回傳結束碼 1：

php

$this->fail('Something went wrong.');

閉包指令

基於閉包的指令提供了一種替代方案，可以不將主控台指令定義為類別。就像路由閉包是控制器的一種替代方案一樣，您可以將指令閉包視為指令類別的替代方案。

儘管 routes/console.php 檔案沒有定義 HTTP 路由，但它定義了基於主控台的進入點 (路由) 到您的應用程式。在此檔案中，您可以使用 Artisan::command 方法定義所有基於閉包的主控台指令。command 方法接受兩個引數：指令簽章和一個接收指令引數和選項的閉包：

php

Artisan::command('mail:send {user}', function (string $user) {
    $this->info("Sending email to: {$user}!");
});

該閉包綁定到底層的指令實例，因此您可以完全存取通常在完整指令類別上能夠存取的所有輔助方法。

型別提示依賴

除了接收指令的引數和選項之外，指令閉包還可以型別提示您希望從服務容器中解析的其他依賴：

php

use App\Models\User;
use App\Support\DripEmailer;
use Illuminate\Support\Facades\Artisan;

Artisan::command('mail:send {user}', function (DripEmailer $drip, string $user) {
    $drip->send(User::find($user));
});

閉包指令說明

當定義一個基於閉包的指令時，您可以使用 purpose 方法為指令添加說明。當您執行 php artisan list 或 php artisan help 指令時，此說明將會顯示：

php

Artisan::command('mail:send {user}', function (string $user) {
    // ...
})->purpose('Send a marketing email to a user');

可隔離指令

⚠️ 警告

若要使用此功能，您的應用程式必須使用 memcached、redis、dynamodb、database、file 或 array 快取驅動作為應用程式的預設快取驅動。此外，所有伺服器都必須與相同的中央快取伺服器通訊。

有時您可能希望確保指令在同一時間只能執行一個實例。為此，您可以在指令類別上實作 Illuminate\Contracts\Console\Isolatable 介面：

php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\Isolatable;

class SendEmails extends Command implements Isolatable
{
    // ...
}

當您將指令標記為 Isolatable 時，Laravel 會自動為該指令提供 --isolated 選項，而無需在指令的選項中明確定義。當指令透過該選項被呼叫時，Laravel 將確保沒有其他該指令的實例正在執行。Laravel 透過嘗試使用應用程式的預設快取驅動獲取原子鎖定來實現此目的。如果該指令的其他實例正在執行，指令將不會執行；但是，指令仍將以成功的結束狀態碼退出：

shell

php artisan mail:send 1 --isolated

如果您想指定指令在無法執行時應回傳的結束狀態碼，您可以透過 isolated 選項提供所需的狀態碼：

shell

php artisan mail:send 1 --isolated=12

鎖定 ID

預設情況下，Laravel 將使用指令的名稱來產生用於在應用程式快取中獲取原子鎖定的字串鍵。但是，您可以透過在 Artisan 指令類別上定義 isolatableId 方法來自訂此鍵，從而允許您將指令的引數或選項整合到鍵中：

php

/**
 * Get the isolatable ID for the command.
 */
public function isolatableId(): string
{
    return $this->argument('user');
}

鎖定過期時間

預設情況下，隔離鎖定會在指令完成後過期。或者，如果指令被中斷且無法完成，鎖定將在一小時後過期。然而，您可以透過在指令上定義 isolationLockExpiresAt 方法來調整鎖定過期時間：

php

use DateTimeInterface;
use DateInterval;

/**
 * Determine when an isolation lock expires for the command.
 */
public function isolationLockExpiresAt(): DateTimeInterface|DateInterval
{
    return now()->plus(minutes: 5);
}

定義輸入預期

撰寫 Console 指令時，通常會透過引數或選項來從使用者那裡收集輸入。Laravel 讓您可以非常方便地使用指令上的 signature 屬性來定義您期望的使用者輸入。signature 屬性允許您以單一、表達性、類似路由的語法來定義指令的名稱、引數和選項。

引數

所有使用者提供的引數和選項都用大括號包圍。在以下範例中，指令定義了一個必填引數：user：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user}';

您也可以將引數設為選用，或為引數定義預設值：

php

// Optional argument...
'mail:send {user?}'

// Optional argument with default value...
'mail:send {user=foo}'

選項

選項與引數一樣，是另一種形式的使用者輸入。當透過命令列提供選項時，選項會以兩個連字號 (--) 作為字首。選項有兩種：接收值的選項和不接收值的選項。不接收值的選項充當布林「開關」。讓我們看看這種類型選項的範例：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue}';

在此範例中，呼叫 Artisan 指令時可以指定 --queue 開關。如果傳遞了 --queue 開關，則選項的值將為 true。否則，值將為 false：

shell

php artisan mail:send 1 --queue

附帶值的選項

接下來，讓我們看看一個期望值的選項。如果使用者必須為選項指定一個值，您應該在選項名稱後加上 = 符號：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send {user} {--queue=}';

在此範例中，使用者可以像這樣為選項傳遞一個值。如果在呼叫指令時未指定選項，則其值將為 null：

shell

php artisan mail:send 1 --queue=default

您可以透過在選項名稱後指定預設值來為選項指派預設值。如果使用者未傳遞任何選項值，則將使用預設值：

php

'mail:send {user} {--queue=default}'

選項捷徑

要在定義選項時指派捷徑，您可以在選項名稱之前指定它，並使用 | 字元作為分隔符號來將捷徑與完整選項名稱分開：

php

'mail:send {user} {--Q|queue=}'

在終端機上呼叫指令時，選項捷徑應該以單一連字號作為字首，並且在為選項指定值時不應包含 = 字元：

shell

php artisan mail:send 1 -Qdefault

輸入陣列

如果您想定義引數或選項以期望多個輸入值，可以使用 * 字元。首先，讓我們看看一個指定此類引數的範例：

php

'mail:send {user*}'

執行此指令時，user 引數可以依序傳遞到命令列。例如，以下指令將 user 的值設定為一個陣列，其中包含 1 和 2 作為其值：

shell

php artisan mail:send 1 2

此 * 字元可以與選用引數定義結合使用，以允許引數出現零次或多次：

php

'mail:send {user?*}'

選項陣列

當定義一個期望多個輸入值的選項時，傳遞給指令的每個選項值都應以選項名稱作為字首：

php

'mail:send {--id=*}'

此類指令可以透過傳遞多個 --id 引數來呼叫：

shell

php artisan mail:send --id=1 --id=2

輸入說明

您可以透過使用冒號將引數名稱與說明分開，來為輸入引數和選項指派說明。如果您需要更多空間來定義指令，請隨意將定義分散到多行：

php

/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'mail:send
                        {user : The ID of the user}
                        {--queue : Whether the job should be queued}';

提示遺漏的輸入

如果您的指令包含必填引數，當它們未提供時，使用者將收到錯誤訊息。或者，您可以透過實作 PromptsForMissingInput 介面，將指令設定為在必填引數遺漏時自動提示使用者：

php

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Contracts\Console\PromptsForMissingInput;

class SendEmails extends Command implements PromptsForMissingInput
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'mail:send {user}';

    // ...
}

如果 Laravel 需要從使用者那裡收集一個必填引數，它將透過巧妙地使用引數名稱或說明來措辭問題，自動詢問使用者該引數。如果您希望自訂用於收集必填引數的問題，您可以實作 promptForMissingArgumentsUsing 方法，傳回一個以引數名稱為鍵的問題陣列：

php

/**
 * Prompt for missing input arguments using the returned questions.
 *
 * @return array<string, string>
 */
protected function promptForMissingArgumentsUsing(): array
{
    return [
        'user' => 'Which user ID should receive the mail?',
    ];
}

您也可以使用包含問題和佔位符的元組來提供佔位符文字：

php

return [
    'user' => ['Which user ID should receive the mail?', 'E.g. 123'],
];

如果您想完全控制提示，您可以提供一個閉包，該閉包應提示使用者並傳回他們的答案：

php

use App\Models\User;
use function Laravel\Prompts\search;

// ...

return [
    'user' => fn () => search(
        label: 'Search for a user:',
        placeholder: 'E.g. Taylor Otwell',
        options: fn ($value) => strlen($value) > 0
            ? User::whereLike('name', "%{$value}%")->pluck('name', 'id')->all()
            : []
    ),
];

📌 備註

完整的 Laravel Prompts 文件包含有關可用提示及其用法的更多資訊。

如果您希望提示使用者選擇或輸入 options，您可以將提示包含在指令的 handle 方法中。但是，如果您只想在使用者也自動提示遺漏引數時才提示使用者，那麼您可以實作 afterPromptingForMissingArguments 方法：

php

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use function Laravel\Prompts\confirm;

// ...

/**
 * Perform actions after the user was prompted for missing arguments.
 */
protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output): void
{
    $input->setOption('queue', confirm(
        label: 'Would you like to queue the mail?',
        default: $this->option('queue')
    ));
}

指令 I/O

取得輸入

當指令執行時，您可能需要存取指令所接受的引數與選項值。為此，您可以使用 argument 與 option 方法。如果引數或選項不存在，則會回傳 null：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $userId = $this->argument('user');
}

如果您需要將所有引數作為 array 取得，請呼叫 arguments 方法：

php

$arguments = $this->arguments();

選項可以像引數一樣，使用 option 方法輕鬆取得。若要將所有選項作為陣列取得，請呼叫 options 方法：

php

// Retrieve a specific option...
$queueName = $this->option('queue');

// Retrieve all options as an array...
$options = $this->options();

提示輸入

📌 備註

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

除了顯示輸出外，您還可以在指令執行期間要求使用者提供輸入。ask 方法會向使用者提出給定問題，接受其輸入，然後將使用者的輸入回傳給您的指令：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $name = $this->ask('What is your name?');

    // ...
}

ask 方法也接受一個選用的第二個引數，用於指定在未提供使用者輸入時應回傳的預設值：

php

$name = $this->ask('What is your name?', 'Taylor');

secret 方法與 ask 類似，但使用者在主控台中輸入時，其輸入將不可見。此方法在詢問密碼等敏感資訊時非常有用：

php

$password = $this->secret('What is the password?');

詢問確認

如果您需要向使用者詢問簡單的「是或否」確認，您可以使用 confirm 方法。預設情況下，此方法會回傳 false。但是，如果使用者在提示時輸入 y 或 yes，此方法將回傳 true。

php

if ($this->confirm('Do you wish to continue?')) {
    // ...
}

如有必要，您可以透過將 true 作為第二個引數傳遞給 confirm 方法，來指定確認提示預設應回傳 true：

php

if ($this->confirm('Do you wish to continue?', true)) {
    // ...
}

自動完成

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

php

$name = $this->anticipate('What is your name?', ['Taylor', 'Dayle']);

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

php

use App\Models\Address;

$name = $this->anticipate('What is your address?', function (string $input) {
    return Address::whereLike('name', "{$input}%")
        ->limit(5)
        ->pluck('name')
        ->all();
});

多選問題

如果您在提問時需要給使用者預定義的一組選項，您可以使用 choice 方法。您可以透過將索引作為第三個引數傳遞給該方法，來設定當未選擇任何選項時應回傳的預設值的陣列索引：

php

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex
);

此外，choice 方法接受選用的第四和第五個引數，用於決定選擇有效回應的最大嘗試次數以及是否允許多重選擇：

php

$name = $this->choice(
    'What is your name?',
    ['Taylor', 'Dayle'],
    $defaultIndex,
    $maxAttempts = null,
    $allowMultipleSelections = false
);

撰寫輸出

若要向主控台輸出內容，您可以使用 line、newLine、info、comment、question、warn、alert 和 error 方法。每個方法都會為其目的使用適當的 ANSI 顏色。例如，讓我們向使用者顯示一些一般資訊。通常，info 方法會在主控台中顯示為綠色文字：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    // ...

    $this->info('The command was successful!');
}

若要顯示錯誤訊息，請使用 error 方法。錯誤訊息文字通常會以紅色顯示：

php

$this->error('Something went wrong!');

您可以使用 line 方法顯示純文字，無顏色：

php

$this->line('Display this on the screen');

您可以使用 newLine 方法顯示空白行：

php

// Write a single blank line...
$this->newLine();

// Write three blank lines...
$this->newLine(3);

表格

table 方法可讓您輕鬆正確地格式化多行/多欄資料。您只需提供欄位名稱和表格資料，Laravel 就會自動為您計算表格的適當寬度和高度：

php

use App\Models\User;

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

進度條

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

php

use App\Models\User;

$users = $this->withProgressBar(User::all(), function (User $user) {
    $this->performTask($user);
});

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

php

$users = App\Models\User::all();

$bar = $this->output->createProgressBar(count($users));

$bar->start();

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

    $bar->advance();
}

$bar->finish();

📌 備註

若要取得更進階的選項，請查閱 Symfony 進度條組件文件。

註冊指令

預設情況下，Laravel 會自動註冊 app/Console/Commands 目錄中的所有指令。但是，您可以使用應用程式的 bootstrap/app.php 檔案中的 withCommands 方法，指示 Laravel 掃描其他目錄以尋找 Artisan 指令：

php

->withCommands([
    __DIR__.'/../app/Domain/Orders/Commands',
])

如有必要，您也可以透過向 withCommands 方法提供指令的類別名稱來手動註冊指令：

php

use App\Domain\Orders\Commands\SendEmails;

->withCommands([
    SendEmails::class,
])

當 Artisan 啟動時，應用程式中的所有指令都將由服務容器解析並註冊到 Artisan 中。

以程式化方式執行指令

有時您可能希望在 CLI 之外執行 Artisan 指令。例如，您可能希望從路由或控制器執行 Artisan 指令。您可以使用 Artisan facade 上的 call 方法來完成此操作。 call 方法接受指令的簽章名稱或類別名稱作為第一個引數，以及一個指令參數陣列作為第二個引數。執行後的結束代碼將會回傳：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/user/{user}/mail', function (string $user) {
    $exitCode = Artisan::call('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

或者，您可以將整個 Artisan 指令以字串形式傳遞給 call 方法：

php

Artisan::call('mail:send 1 --queue=default');

傳遞陣列值

如果您的指令定義了一個接受陣列的選項，您可以將一個值陣列傳遞給該選項：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/mail', function () {
    $exitCode = Artisan::call('mail:send', [
        '--id' => [5, 13]
    ]);
});

傳遞布林值

如果您需要指定不接受字串值的選項值，例如 migrate:refresh 指令上的 --force 標誌，您應該傳遞 true 或 false 作為選項值：

php

$exitCode = Artisan::call('migrate:refresh', [
    '--force' => true,
]);

將 Artisan 指令加入佇列

使用 Artisan facade 上的 queue 方法，您甚至可以將 Artisan 指令加入佇列，以便它們由您的佇列 Worker 在背景處理。在使用此方法之前，請確保您已設定佇列並正在執行佇列監聽器：

php

use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Route;

Route::post('/user/{user}/mail', function (string $user) {
    Artisan::queue('mail:send', [
        'user' => $user, '--queue' => 'default'
    ]);

    // ...
});

使用 onConnection 和 onQueue 方法，您可以指定 Artisan 指令應該分派至的連線或佇列：

php

Artisan::queue('mail:send', [
    'user' => 1, '--queue' => 'default'
])->onConnection('redis')->onQueue('commands');

從其他指令呼叫指令

有時您可能希望從現有的 Artisan 指令中呼叫其他指令。您可以使用 call 方法來實現。此 call 方法接受指令名稱和一個指令引數/選項陣列：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->call('mail:send', [
        'user' => 1, '--queue' => 'default'
    ]);

    // ...
}

如果您希望呼叫另一個主控台指令並抑制其所有輸出，您可以使用 callSilently 方法。 callSilently 方法與 call 方法具有相同的簽章：

php

$this->callSilently('mail:send', [
    'user' => 1, '--queue' => 'default'
]);

訊號處理

如您所知，作業系統允許向執行中的程序發送訊號。例如，SIGTERM 訊號是作業系統要求程式終止的方式。如果您希望在 Artisan 主控台指令中監聽訊號並在它們發生時執行程式碼，您可以使用 trap 方法：

php

/**
 * Execute the console command.
 */
public function handle(): void
{
    $this->trap(SIGTERM, fn () => $this->shouldKeepRunning = false);

    while ($this->shouldKeepRunning) {
        // ...
    }
}

若要同時監聽多個訊號，您可以向 trap 方法提供一個訊號陣列：

php

$this->trap([SIGTERM, SIGQUIT], function (int $signal) {
    $this->shouldKeepRunning = false;

    dump($signal); // SIGTERM / SIGQUIT
});

Stub 客製化

Artisan 主控台的 make 指令用於建立各種類別，例如控制器、工作、遷移檔案與測試檔案。這些類別是使用「stub」檔案生成的，這些檔案根據您的輸入填充值。但是，您可能希望對 Artisan 生成的檔案進行小幅更改。為了實現這一點，您可以使用 stub:publish 指令將最常見的 stubs 發佈到您的應用程式中，以便您可以自訂它們：

shell

php artisan stub:publish

發佈的 stubs 將位於您應用程式根目錄中的 stubs 目錄。您對這些 stubs 所做的任何更改都將在您使用 Artisan 的 make 指令生成其對應的類別時反映出來。

事件

Artisan 在執行指令時分派三個事件：Illuminate\Console\Events\ArtisanStarting、Illuminate\Console\Events\CommandStarting 和 Illuminate\Console\Events\CommandFinished。 ArtisanStarting 事件在 Artisan 開始執行時立即分派。接下來，CommandStarting 事件在指令執行前立即分派。最後，CommandFinished 事件在指令執行完成後分派。

Artisan Console ​

簡介 ​

Laravel Sail ​

Tinker (REPL) ​

安裝 ​

用法 ​

指令允許清單 ​

不應建立別名的類別 ​

撰寫指令 ​

產生指令 ​

指令結構 ​

結束碼 ​

閉包指令 ​

型別提示依賴 ​

閉包指令說明 ​

可隔離指令 ​

鎖定 ID ​

鎖定過期時間 ​

定義輸入預期 ​

引數 ​

選項 ​

附帶值的選項 ​

選項捷徑 ​

輸入陣列 ​

選項陣列 ​

輸入說明 ​

提示遺漏的輸入 ​

指令 I/O ​

取得輸入 ​

提示輸入 ​

詢問確認 ​

自動完成 ​

多選問題 ​

撰寫輸出 ​

表格 ​

進度條 ​

註冊指令 ​

以程式化方式執行指令 ​

傳遞陣列值 ​

傳遞布林值 ​

將 Artisan 指令加入佇列 ​

從其他指令呼叫指令 ​

訊號處理 ​

Stub 客製化 ​

事件 ​

Artisan Console

簡介

Laravel Sail

Tinker (REPL)

安裝

用法

指令允許清單

不應建立別名的類別

撰寫指令

產生指令

指令結構

結束碼

閉包指令

型別提示依賴

閉包指令說明

可隔離指令

鎖定 ID

鎖定過期時間

定義輸入預期

引數

選項

附帶值的選項

選項捷徑

輸入陣列

選項陣列

輸入說明

提示遺漏的輸入

指令 I/O

取得輸入

提示輸入

詢問確認

自動完成

多選問題

撰寫輸出

表格

進度條

註冊指令

以程式化方式執行指令

傳遞陣列值

傳遞布林值

將 Artisan 指令加入佇列

從其他指令呼叫指令

訊號處理

Stub 客製化

事件