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 5.x CakePHP4

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

Message コメントをキャンセル

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

: CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単！

: CakePHP4、CakePHP5の「warning: DebugKit is disabling．．．」の対処方法

CakePHPのデバッグ用のツールであるDebugKitは適切な設定をしないとエラーログにワーニングメッセージが出力される。それを解消する方法を解説。

: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

CakePHP4系、5系ではAuthenticationを使用してログイン認証を行う。その認証でID、PASS以外の削除フラグなどの条件を加えたいときの対応方法について解説。

: CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。

: CakePHP4、CakePHP5のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP4の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

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

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

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

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