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


関連記事

軽量なAlpine Linuxイメージでgitbookのローカル環境を構築する

1 はじめに2 Alpine Linuxとは3 Docker本体のインストール4 サンプルリポジトリのダウンロード5 dockerイメージ作成6 Gitbook初期化&実行7 Dockerの ...

rails

configに追記したのに、rails runnerが起動しない?

1 はじめに1.1 環境2 rails runnerを使用してみる2.1 バッチファイルの作成2.2 configにパスを追記2.3 実行3 ところが…3.1 解決方法4 おまけ(runnerコマンド ...

Go言語

GoフレームワークGinでミドルウェアを使ってログインAPIを実装

1 はじめに2 ログインAPIの作成3 ログインのセッション管理4 ミドルウェア4.1 gin.Default()4.2 Logger4.3 Recovery4.4 sessions5 独自ミドルウェ ...

laravel logo

laravel-enumを使ってみたら快適だった

1 はじめに2 enumについて3 環境4 導入5 enumクラス5.1 生成5.2 enumクラス編集5.3 日本語化6 マイグレーション6.1 生成6.2 編集7 プロパティのキャスト8 さいごに ...

Kotlinでのnullの基本的な扱いかた

1 はじめに2 基本的にnullを許容しない3 nullを許容するNullable4 Nullableをnon-nullに変える4.1 nullチェックとスマートキャスト4.2 エルビス演算子4.3 ...

フォロー

follow us in feedly

blog-page_side_responsive

2020年6月
 123456
78910111213
14151617181920
21222324252627
282930 

アプリ情報

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