CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

2024/06/19 2024/06/21

CakePHP4でコマンドプログラムを作成する

CakePHP4にもコマンドプログラムが用意されている

　
CakePHP4では、画面で見る処理だけではなく、コマンドラインからコマンドを入力して実行する処理も用意されています。
cronを使って定期的に自動処理を実行したい場合などに便利です。
　
CakePHP4でコマンドの処理を作成する方法を 4記事にわたって紹介します。
今回はその 1回目で、コマンドプロジェクトを作成する基本を解説します。
　

CakePHP3.6以降はシェル（Shell）は非推奨に

　
ちなみに、この記事の最後に書いていますが、CakePHP3.6以降はシェル（Shell）は非推奨となり、コマンド（Command）を利用することとなりました。
　
そのため、この記事では「コマンド」についての内容になります。（シェルについては検証していません。）
　
　

Bakeコマンドを実行しコマンドプログラムのテンプレートを生成

　
まず初めに、下記のコマンドを実行し、コマンドプログラムのテンプレートを生成します。

$ bin/cake bake command hello

1	$ bin/cake bake command hello

　
コマンドを実行すると下記の 2ファイルが生成されます。
/src/Command/HelloCommand.php
/tests/TestCase\Command/HelloCommandTest.php
　
このうち、コマンドプログラムである「/src/Command/HelloCommand.php」を使用していきます。
　
　

コマンドプログラム「HelloCommand.php」の中身

　
/src/Command/HelloCommand.phpの中身は下記のようになっています。
必要最低限の内容になっています。
　

<?php
declare(strict_types=1);

namespace App\Command;

use Cake\Command\Command;
use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;

/**
 * Hello command.
 */
class HelloCommand extends Command
{
  /**
   * Hook method for defining this command's option parser.
   *
   * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
   * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
   * @return \Cake\Console\ConsoleOptionParser The built parser.
   */
  public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
  {
    $parser = parent::buildOptionParser($parser);

    return $parser;
  }

  /**
   * Implement this method with your command's logic.
   *
   * @param \Cake\Console\Arguments $args The command arguments.
   * @param \Cake\Console\ConsoleIo $io The console io
   * @return null|void|int The exit code or null for success
   */
  public function execute(Arguments $args, ConsoleIo $io)
  {
  }
}

<?php

declare(strict_types=1);

namespace App\Command;

use Cake\Command\Command;

use Cake\Console\Arguments;

use Cake\Console\ConsoleIo;

use Cake\Console\ConsoleOptionParser;

/**

* Hello command.

class HelloCommand extends Command

{

/**

* Hook method for defining this command's option parser.

* @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options

* @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined

* @return \Cake\Console\ConsoleOptionParser The built parser.

public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

{

$parser = parent::buildOptionParser($parser);

return $parser;

}

/**

* Implement this method with your command's logic.

* @param \Cake\Console\Arguments $args The command arguments.

* @param \Cake\Console\ConsoleIo $io The console io

* @return null|void|int The exit code or null for success

public function execute(Arguments $args, ConsoleIo $io)

{

}

「buildOptionParser()」は引数（パラメータ）の付与時に使用

　
「buildOptionParser()」は、コマンドに引数（パラメータ）を付与して実行する際に、引数を受け取る処理に使用します。
次々回の下記の記事で紹介していますので、そちらを参照してください。
CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法
　
　

コマンドプログラムの本体は「execute()」メソッド内に記述

　
コマンドプログラムを実行すると「execute()」メソッドの中の処理が実行されますので、この中に処理を記述していきます。
　
　

「execute()」メソッド内に処理を記述

　
定番の「Hello world.」を表示する処理を「execute()」内に記述します。
　

  public function execute(Arguments $args, ConsoleIo $io)
  {
    $io->out('Hello world.');
  }

public function execute(Arguments $args, ConsoleIo $io)

{

$io->out('Hello world.');

}

「HelloCommand」のプログラムを実行

　
コマンドプログラムを実行するコマンドは下記になります。
　

$ bin/cake hello

1	$ bin/cake hello

　
「Hello world.」とコンソール画面に表示されれば成功です。
　
　

「$io->out()」以外に「print_r()」「echo」も使える

　
ちなみに、規約上は「$io->out()」で画面に出力処理を行いますが、「print_r()」「echo」でも画面表示できますので、デバッグの時などはこれらを使うのもありかと思います。
　

  public function execute(Arguments $args, ConsoleIo $io)
  {
    $io->out('Hello world.');
    print_r("Hello world. \n");
    echo "Hello world. \n";
  }

public function execute(Arguments $args, ConsoleIo $io)

{

$io->out('Hello world.');

print_r("Hello world. \n");

echo "Hello world. \n";

}

複数の単語からなるコマンドプログラムの場合の記述方法

　
今回は「HelloCommand.php」ですが、複数の単語からなるコマンドの場合は下記のようになります。
　
　
先ほどと同じように bakeコマンドを利用して、コマンドプログラムのテンプレートファイルを生成します。
　

$ bin/cake bake command SayHello

1	$ bin/cake bake command SayHello

　
「SayHelloCommand.php」と言うコマンドファイルが作成されます。
　
このファイルを実行する際のコマンドは、下記の記述（キャメルケース・camelCase）が、規約上の正解なのだろうと思います。
　

$ bin/cake sayHello

1	$ bin/cake sayHello

　
Cookbookの記事内では、「HelloCommand.php」の時に「bin/cake hello」となっていましたので、コマンドで実行する際の記述は 1単語目の 1文字目は小文字が規約上の正解なのだろうと思います。
　
ただ、下記でも動作します。
　

$ bin/cake SayHello

1	$ bin/cake SayHello

　
コマンドのファイル名も Class名も「SayHello」と「S」は大文字（パスカルケース・PascalCase）となっていますので、こちらの方が正しいのではないか、とすら思います。
　
　

キャメルケース、パスカルケース、スネークケース、ケバブケースのコマンドでの動作確認

　
ということで、規約上はキャメルケースで記述することが正しいであろうと思われますが、パスカルケースやスネークケース、ケバブケースなどの記述方法でコマンドとして認識されるのか、実験をしてみました。
　
ちょっと意外な感じがする結果もありますが、以下の通りの結果となりました。
　
コマンドとして実行される記述方法
　

$ bin/cake sayHello   OK
$ bin/cake SayHello   OK

$ bin/cake Say-hello  OK
$ bin/cake Say_hello  OK

$ bin/cake say-hello  OK
$ bin/cake say_hello  OK

$ bin/cake sayHello OK

$ bin/cake SayHello OK

$ bin/cake Say-hello OK

$ bin/cake Say_hello OK

$ bin/cake say-hello OK

$ bin/cake say_hello OK

　
　
コマンドとして認識されない記述方法
　

$ bin/cake sayhello   NG

$ bin/cake Say-Hello  NG
$ bin/cake Say_Hello  NG

$ bin/cake say-Hello  NG
$ bin/cake say_Hello  NG

$ bin/cake sayhello NG

$ bin/cake Say-Hello NG

$ bin/cake Say_Hello NG

$ bin/cake say-Hello NG

$ bin/cake say_Hello NG

　
　
参考サイトとしては、下記の Cookbookとなります。
https://book.cakephp.org/4/ja/console-commands/commands.html
　
　

CakePHP3.6 以降、シェルは非推奨になった

　
CakePHP3.6 以降、シェルは非推奨となりました。
　
https://book.cakephp.org/2/ja/console-and-shells.html
https://book.cakephp.org/3/ja/console-and-shells.html
https://book.cakephp.org/4/ja/console-commands/shells.html
　
CakePHP2のころは「/app/Console/Command」フォルダ内に「HelloShell.php」と言うファイル名でシェルと言うプログラムを作成していました。
　
CakePHP3では、「src/Shell」にはシェル「HelloShell.php」を作成し、「src/Command」にはコマンド「HelloCommand.php」を作成する仕様になりました。
そして、CakePHP3.6で「シェル」の方が非推奨となりました。
　
　
シェルは、非推奨ながら CakePHP5までは削除されないようですが、CakePHP4、CakePHP5で作成するならば、コマンドで実装するべきものでしょう。
　
諸行無常と言うか、栄枯盛衰と言うか、フレームワークの機能も改廃が進んでいきますね。
　
　

- CakePHP 3.x 4.x CakePHP4

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

Message コメントをキャンセル

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

: cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

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

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

: CakePHP3で保存前にバリデーション結果を取得する2つの方法

CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

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

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

: CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

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

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

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

PREV: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点
NEXT: CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

日	月	火	水	木	金	土
					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でコマンドプログラムを作成する

CakePHP4にもコマンドプログラムが用意されている

CakePHP3.6以降はシェル（Shell）は非推奨に

Bakeコマンドを実行しコマンドプログラムのテンプレートを生成

コマンドプログラム「HelloCommand.php」の中身

「buildOptionParser()」は引数（パラメータ）の付与時に使用

コマンドプログラムの本体は「execute()」メソッド内に記述

「execute()」メソッド内に処理を記述

「HelloCommand」のプログラムを実行

「$io->out()」以外に「print_r()」「echo」も使える

複数の単語からなるコマンドプログラムの場合の記述方法

キャメルケース、パスカルケース、スネークケース、ケバブケースのコマンドでの動作確認

CakePHP3.6 以降、シェルは非推奨になった

CakePHP4の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

cakephp3 カスタムバリデーションを簡易的に実装する方法

CakePHP 2.3でファイルのアップロード処理を作る

CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

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

CakePHP3で保存前にバリデーション結果を取得する2つの方法

Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

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

CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

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

CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

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

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

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

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

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