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

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

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

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

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

: CakePHP4の数値項目は「like %10%」の部分一致検索（find select）はできない

CakePHP4でテーブルの数値項目に対してlike句を使用した部分一致検索を実行するとエラーが発生する。クリエービルダーの不具合だと思われ対処方法が分からない。

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

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

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

: CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP4、CakePHP5でクリエビルダーを利用してテーブルからレコードを取得する際、asを使用してカラムの別名で値を取得したい場合の対応方法を解説。また、別名にはハイフンやアスタリスクなど使用できない文字がある点も解説。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

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

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

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

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

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

「use」句に「ConsoleOptionParser」を追記

「buildOptionParser」メソッドを追記

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

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

CakePHP4の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

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

CakePHP4の数値項目は「like %10%」の部分一致検索（find select）はできない

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

CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP 2.3でOn Duplicate Key構文を実装

CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

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