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 コメントをキャンセル

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

: CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説

CakePHP4のエラーメッセージ、完了メッセージなどを表示するフラッシュ処理の解説。Controller、レイアウトファイル、テンプレートファイルでそれぞれ処理を指定する。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

: CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

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 コメントをキャンセル

関連記事

CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説

CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法

CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

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()`」で取得