BackEnd

LaravelのArtisanコマンドを自作する

投稿日:

はじめに

Laravelの artisanコマンドは、実際にはバッチの開発などで使う機会が多いと思いますが、コンソール向きのコマンドも、Laravelから用意された機能を組み合わせることで、開発しやすくなっています。
今回は、 artisanコマンドを使用した、コンソール向きのコマンドの作成方法を紹介します。

コマンドの作成方法

コマンドを作成するには、下記コマンドを実行します。

$ php artisan make:command CommandName

app>Console>Commands配下に、コマンド用のクラスが作成されます。

コマンドの実装

コマンドを生成すると、以下のコードが生成されます。

$signatureにコマンド名を指定します。実際にコマンドを実行する際は、 $ php artisan command:nameとなります。
また、 $descriptionには、コマンドの説明を書きます。ここに書いた説明は、 $ php artisan listコマンドを実行した時に表示されます。

__construct()メソッドは、主にコンストラクタインジェクションとして活用することができます。今回は説明を省略しますが、コマンドのロジックは、Service化しておくことで、取り回しの良いコードになると思います。
handle()メソッドに、実際にコマンドが実行された時の処理を書きます。コマンドの引数やオプションも、このメソッド内で受け取ります。
以降、 handle()メソッド内での、コマンドの実装方法について、紹介したいと思います。

文字列出力

シンプルにコンソールに出力するには、以下のように実装します。

この他にも、出力したい内容別にメソッドが用意されており、それぞれ表示色が異なります。
状況に応じて、 info, comment,question,errorなども使い分けましょう。
表示色のサンプルです。

引数

コマンドに引数を設定するには、 $signatureプロパティを次のようにします。

引数を取得するには、handle()メソッドで、次のようにします。

実際のコマンド実行は、次のようになります。

$signatureを次のようにすると、配列として引数を受け取ることができます。

オプション

オプションを指定し、値を取得するには、 $signatureプロパティを次のようにします。

オプションにデフォルト値を設定する場合は、上記の =に続けてデフォルト値を記載します。
また、bool値の取得であれば、 =は不要です。

オプションの値を取得するには、 handle()ソメッドで、次のようにします。

実際のコマンド実行は次のようになります。

入力を使用した対話型

対話型のコマンドを作成することも可能です。

ask()メソッド

ユーザに入力を要求することができます。

実行結果は次のようになります。

secret()メソッド

ask()と似ていますが、入力内容がコンソールに表示されません。

confirm()メソッド

Y/Nで確認を取りたい時に使用します。

実行結果は次のようになります。

プログレスバー

時間のかかる処理を実行するときは、プログレスバーで進捗を表示することができます。

注意点としては、プログレスバーの後は改行されないため、 echo PHP_EOLで改行コードを出力する必要があります。
実行結果は次のようになります。

テーブル

テーブルを出力できることも可能です。例えば、DBのレコードを一覧表示する時に使用できます。

実行結果は次のようになります。

サンプル実装

「国立図書館デジタルコレクション書誌情報」をダウンロードし、テーブルに格納するコマンドのサンプルコードです。
ダウンロードにはGuzzleHttp、ExcelデータのインポートにはLaravel Excelを使用しています。

BooksImport.php

ImportBooks.php

$ php artisan import:booksコマンドで実行できます。

さいごに

いかがでしたか。 artisanコマンドは、よくコンソールで使用される機能が揃っているので、ちょっとした手作業を自動化する際に、使い勝手が良さそうですね。

おすすめ書籍

PHPフレームワークLaravel入門 第2版 PHPフレームワーク Laravel実践開発 PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応 よくわかるPHPの教科書 【PHP7対応版】

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

rails

【Puma】アプリサーバのチューニング

1 はじめに2 チューニングで注意する項目3 子プロセスの数3.1 最低3つの子プロセスを割り当てる3.2 最大子プロセス数3.3 CPUコア数と子プロセス数3.4 なぜPumaの子プロセス数を増やす ...

rails

Railsでの非同期処理とDelayed Job

1 はじめに2 Active Job2.1 Active Jobの役割2.2 ジョブを作成する2.3 ジョブをキューに登録する2.4 コールバック2.5 例外3 Delayed Job3.1 設定3. ...

rails

ShrineでS3に画像をアップロードする

1 はじめに1.1 前提条件1.2 関連記事2 AWS側の準備2.1 S3バケットを作成する2.2 CORSを設定する2.3 アクセス用のユーザを作成する3 Rails側の設定3.1 Initiali ...

laravel logo

Laravelでテストコードを書くには? Featureテスト/Unitテスト

1 はじめに2 FeatureとUnitの使い分け3 テスト用データベースの準備4 Featureテスト4.1 テスト対象のコード4.2 テストコードの実装4.3 テスト結果の検証4.3.1 ステータ ...

laravel logo

Laravel Authのパスワードリセット機能をカスタマイズする

1 はじめに2 準備2.1 Auth2.2 mailhog3 ユーザー登録とログイン4 パスワードリセットのカスタマイズ4.1 ルーティング確認4.2 view編集4.3 認証処理の編集5 リセット画 ...

フォロー

follow us in feedly

blog-page_side_responsive

2020年6月
 123456
78910111213
14151617181920
21222324252627
282930 

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。