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の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。

: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

PHPでサーバ情報、環境情報を取得する際は「$_SERVER」を利用するが、似たような情報をCakePHPの関数で取得する際は「getUri()」を使用する。取得出来る値は一致するものもあるが、違うものもあり便利な使い方もある。

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP3のインストールでURL rewriting……のエラーが！その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。

: VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

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

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

: CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

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

関連記事

CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakePHP3のインストールでURL rewriting……のエラーが！その解決方法解説

VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP 2.3　Search Pluginで検索処理　その１設置方法

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

CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

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