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 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP初心者に向けてデバッグキット（DebugKit）のインストール方法、はまりポイントを解説。

: CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順

CakePHP3で「1対多」の連携を中間テーブルを利用した「多対多」の連携に変更するときの手順のまとめ。中間テーブルの設定やModelの変更などを間違いやすい箇所を指摘しながらの解説。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

: CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法

CakePHP3のツリービヘイビアを使ったツリーカテゴリーの子階層も含めての検索を検索プラグイン「friendsofcake/search」を使って実現する方法を解説しました。

: CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート（エレメント）を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。

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

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

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

PREV: CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
NEXT: Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

日	月	火	水	木	金	土
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

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

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

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

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

「use」句に「ConsoleOptionParser」を追記

「buildOptionParser」メソッドを追記

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

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

CakePHP4の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHP 2.3　デバッグキット（DebugKit）超初心者向けフォロー講座

CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順

CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法

CakePHP3のForm Helperの使い方のまとめ

CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説

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

CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

`getParam('action')`で取得するアクション名は別関数に移動しても不変

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

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

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

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

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

「use」句に「ConsoleOptionParser」を追記

「buildOptionParser」メソッドを追記

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

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

CakePHP4の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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