CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

2024/06/21 2024/06/23

CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

　
今回は「CakePHP4でコマンドプログラムを作成する」の全 4回のうちの 3回目で、「コマンドを実行する際に引数（パラメータ）を指定する方法」について解説します。
　

引数（パラメータ）付きのコマンドの入力例

　
サンプルとして
「/src/Command/SampleTestsCommand.php」と言うコマンドプログラムに対して、「param01」「param02」「param03」という 3つの引数（パラメータ）を持たせてコマンドを実行する例です。
　
Linux環境でコマンドを実行するときは下記のコマンドを入力します。
　

$ bin/cake SampleTests param01 param02 param03

1	$ bin/cake SampleTests param01 param02 param03

　
　
XAMPPなどの Windows環境では、binフォルダに移動して下記のコマンドを入力します。
　

$ cake SampleTests param01 param02 param03

1	$ cake SampleTests param01 param02 param03

引数（パラメータ）付きのコマンドから値を受け取る記述方法

　
上記のように指定した引数（パラメータ）をコマンドプログラムの中で取得する方法は以下のようになります。
　
　

「use」句に「ConsoleOptionParser」を追記

　
まず最初に、「use」句に「ConsoleOptionParser」を追記します。
　

use Cake\Console\ConsoleOptionParser;

1	use Cake\Console\ConsoleOptionParser;

「buildOptionParser」メソッドを追記

　
続けて、「buildOptionParser」メソッドを追記します。
「initialize()」や「execute()」より前に記述します。
　

  protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
  {
    $parser->addArgument('name',   ['help' => 'What is your name']);
    $parser->addArgument('height', ['help' => 'What is your height']);
    $parser->addArgument('weight', ['help' => 'What is your weight']);

    return $parser;
  }

protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

{

$parser->addArgument('name', ['help' => 'What is your name']);

$parser->addArgument('height', ['help' => 'What is your height']);

$parser->addArgument('weight', ['help' => 'What is your weight']);

return $parser;

}

　
この「buildOptionParser」では、指定する引数（パラメータ）をコマンドプログラム内の変数を割り当てる設定となります。
　
コマンドに続けて記述する引数の順番には意味があり、ここで記述する「$parser->addArgument()」の順番で、引数とプログラム内の変数を割り当てていきます。
　
今回は、引数を 3つ想定していますので「addArgument()」も 3行書いていますが、引数が 1つであれば 1行で、5つあれば 5行に増やしてください。
　
　

「buildOptionParser」で割り当てた引数を「`$args->getArgument()`」で取得

　
「buildOptionParser」で割り当てた引数は、「execute()」メソッド内で、下記のように「$args->getArgument()」にキーを指定して取得します。
　

  $name   = $args->getArgument('name');
  $height = $args->getArgument('height');
  $weight = $args->getArgument('weight');

$name = $args->getArgument('name');

$height = $args->getArgument('height');

$weight = $args->getArgument('weight');

　
ここで引数（パラメータ）をそれぞれ変数に入れましたので、あとはその変数を普通の変数と同じように利用できます。
　
　
ちなみに、引数に配列を指定することはできませんので、下記のようにカンマ区切りで引数を記述し、プログラムに取り込んだのち「,（半角カンマ）」付きの文字列を「explode()」で配列に変換する手順を取る必要があるかと思います。
　

$ cake SampleTests param11,param12,param13 param02 param03

1	$ cake SampleTests param11,param12,param13 param02 param03

複数の引数をまとめて指定、取得する方法「addArguments()」

　
複数の引数を取得する方法として、「$parser->addArgument()」を複数書くのではなく、まとめて配列で記述する「$parser->addArguments()」もあります。
「addArgument」が複数形になっています。
　

  protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
  {
    $parser->addArguments([
      'name'    => ['help' => 'What is your name'],
      'height'  => ['help' => 'What is your height'],
      'weight'  => ['help' => 'What is your weight'],
    ]);

    return $parser;
  }

protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

{

$parser->addArguments([

'name' => ['help' => 'What is your name'],

'height' => ['help' => 'What is your height'],

'weight' => ['help' => 'What is your weight'],

]);

return $parser;

}

　
異なるのは「$parser->addArguments()」の部分のみで、「execute()」メソッド内の「$args->getArgument()」で受け取る処理の記述方法に変更はありません。
　
　
最後に。
この記事を書くにあたって参考にしたオフィシャルサイトのページを書いておきます。
あわせて参考にしてください。
　
https://book.cakephp.org/4/ja/console-commands/commands.html
https://book.cakephp.org/4/ja/console-commands/option-parsers.html
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法

CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。