Help us understand the problem. What is going on with this article?

Laravelのコンソールコマンドのhandle関数の戻り値はどう使われる?

More than 1 year has passed since last update.

はじめに

Laravelでコンソールコマンドを作成するときに、artisanのmake:commandを使うと思いますが、生成されたファイルをよく見るとhandle関数の戻り値がmixedになっています。

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }

でもドキュメントのArtisanコンソールを見ても戻り値を返している例が一つも無く説明もありません。気になるので調べて見ました。

調査

適当にコマンドクラスを作ってhandleの中でブレークさせて処理を追いかけてみます。

スクリーンショット 2018-04-27 9.08.35.png

ただreturnしてるだけのような所は省略して

Command.phpの252行:

    public function run(InputInterface $input, OutputInterface $output)
    {
        # ...略...

        if ($this->code) {
            $statusCode = call_user_func($this->code, $input, $output); # ←ここ
        } else {
            $statusCode = $this->execute($input, $output);
        }

        return is_numeric($statusCode) ? (int) $statusCode : 0;
    }

$statusCodeで戻り値を受けていますが、最後のreturn文で、is_numericならint型にキャスト、そうでなければ0を返しています。

この値が最終的にartisanスクリプトの最後のexit($status);で使われるようになっていました。

まとめ

handle関数の戻り値はartisanコマンドの終了ステータスに使われます。値がis_numericでなければ0として扱われます。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした