Spark コマンド

CodeIgniter には、公式コマンド spark と組み込みコマンドが付属しています。

コマンドの実行 

コマンドは、プロジェクトのルートディレクトリでコマンドラインから実行されます。コマンドファイル spark が提供されており、これを使用して CLI コマンドを実行します。

コマンドを指定せずに spark を呼び出すと、利用可能なコマンドとその説明がカテゴリ別にソートされた簡単なヘルプページが表示されます。

php spark

php spark は、list コマンドとまったく同じです。

php spark list

--simple オプションを使用すると、利用可能なすべてのコマンドの生のリストをアルファベット順で取得することもできます。

php spark list --simple

help コマンドを使用すると、次のように CLI コマンドに関するヘルプを表示できます。

php spark help db:seed

v4.3.0 以降では、help コマンドの代わりに --help オプションを使用することもできます。

php spark db:seed --help

コマンドを実行するには、コマンドの名前を最初の引数として渡す必要があります。

php spark migrate

一部のコマンドは追加の引数を取り、これらはコマンドの直後にスペースで区切って指定する必要があります。

php spark db:seed DevUserSeeder

CodeIgniter が提供するすべてのコマンドで、必要な引数を指定しない場合は、正しく実行するために必要な情報が求められます。

php spark make:controller

Controller class name :

コマンドを実行すると、CodeIgniter のバージョンと現在の時刻を含むヘッダーが出力されます。

php spark env

CodeIgniter v4.3.5 Command Line Tool - Server Time: 2023-06-16 12:45:31 UTC+00:00

Your environment is currently set as development.

結果の解析に役立つヘッダー出力を抑制するには、常に --no-header を渡すことができます。

php spark env --no-header

Your environment is currently set as development.

コマンドは、独自のコード内からも実行できます。これは通常、cronjob タスクのコントローラー内で実行されますが、いつでも使用できます。これを行うには、command() 関数を使用します。この関数は常に利用可能です。

<?php

echo command('make:migration TestMigration');

唯一の引数は、呼び出されるコマンドと任意のパラメーターである文字列です。これは、コマンドラインから呼び出す場合とまったく同じように表示されます。

コマンドラインから実行されていない場合、実行されたコマンドからのすべての出力がキャプチャされます。表示するかどうかを選択できるように、コマンドから返されます。