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

CakePHP3でシェルを作成コマンドラインから実行

CakePHP3のシェルの作成方法の前書き

　
この記事では、CakePHP3でシェルプログラムを作成し、コマンドラインから実行する方法を解説します。
　
また、公式サイトを始め、ブログなどで解説されている CakePHP関連のサンプルソースですが、ファイル名、Class名、関数名は単一単語で付けられた名称がほとんどで、複数の単語をつなぎ合わせたときにどのようにすればいいのか、よく分からないときが多々あります。
　
今回は「SampleProgram」というファイル名のシェルを作成しますが、この場合
　「SampleProgram」（アッパーキャメルケース）
　「sampleProgram」（ローワーキャメルケース）
　「sample_program」（スネークケース）
　「sample-program」（チェインケース）
のどれが正しいでしょうか？
どれだとエラーになるのでしょうか？
CakePHP2の時は動いたけど、CakePHP3になったら動かなくなるのはどれでしょうか？
　
といったことを含めて解説していきます。
　
　

CakePHP3のシェルの作成方法・複数単語の Class名、アクション名の付け方

　
シェルのプログラムを設置する場所は「/src/Shell/」フォルダの中になります。
ファイル名は「*******Shell.php」形式となります。
　
今回は「SampleProgram」というシェルを作成しますので、ファイル名は「SampleProgramShell.php」となります。
　
そして、今回作成するサンプルプログラムのファイルの中身は下記の通りとなります。
　

<?php
namespace App\Shell;

use Cake\Console\Shell;

class SampleProgramShell extends Shell
{
    public function main()
    {
        $this->out('これはサンプルシェルです');
    }

    public function sampleParameter ($parameter)
    {
        $this->out('サンプル関数の引数は「' . $parameter . '」です。');
    }
}

　
4行目の「use Cake\Console\Shell;」は、シェルを作成するときの必須記述ですので、まずこれを書きます。
　
6行目のクラス名は、ファイル名と同じですので「SampleProgramShell」を記述します。
CakePHPの命名規則としても「SampleProgramShell」となります。
複合語の先頭を大文字で書き始める記法を「アッパーキャメルケース」もしくは「パスカルケース」と言います。
ただ、「sampleProgramShell」としても問題なくは動作します。
　
関数を指定せずにシェル名だけを指定して実行したときは「main()」関数が実行されます。
「main()」関数がなくてもエラーにはなりません。
　
13行目のアクション名（関数名）は、CakePHP3の規約としては「sampleParameter」となります。
複合語の先頭を小文字で書き始める記法を「ローワーキャメルケース」もしくは「キャメルケース」と言います。
Class名は「アッパーキャメルケース」が規約に則った記述方法ですので、注意が必要です。
ただ、「SampleProgramShell」としても問題なくは動作します。
　

　

シェルをコマンドラインから実行する方法

　
前項で作成したシェルをコマンドラインから実行する場合は、
　
「（CakePHP3のルート）/」で下記のコマンドを実行します。
「（CakePHP3のルート）/」は「/var/www/html/」のような感じの場所です。
　
　
シェル名だけを指定した場合は、「main()」関数が実行されます。
引数として「main」を追加しても同じ処理になります。
　

$ bin/cake SampleProgram
これはサンプルシェルです
$ bin/cake SampleProgram main
これはサンプルシェルです

　
アクション名（関数名）を指定して、シェルを実行する場合は、下記の様に、Class名に続いて、アクション名、その引数を指定します。
　

$ bin/cake SampleProgram sampleParameter aaa
サンプル関数の引数は「aaa」です。
$ bin/cake SampleProgram sample-parameter aaa
サンプル関数の引数は「aaa」です。

　
この時、アクション名として指定するのは、アクション名の記述通りに「sampleParameter」とする方法があります。
また、ブラウザで表示する時と同じく、「sample-parameter」のように「-（ハイフン）」でつなぐ「チェインケース」で記述する方法があります。
　
また、規約から外れますが、「SampleParameter」「sample_parameter」としても動作はします。
　
　

CakePHP2と CakePHP3の違い

　
CakePHP2でシェルを実行する方法については、下記に記事を書いていますので、こちらを参考にしてください。
CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説
　
　
CakePHP2で作成したシェルを CakePHP3で実行する場合に不具合が発生する可能性があるのは、アクション名（関数名）の付け方ではないか、と感じます。
（というか、私がそれが原因でエラーを発生させてしまいましたので。）
　
　

<?php
namespace App\Shell;

use Cake\Console\Shell;

class SampleProgramShell extends Shell
{
    public function sample_parameter ($parameter)
    {
        $this->out('サンプル関数の引数は「' . $parameter . '」です。');
    }
}

　
具体的には、上記は CakePHP2の元になったシェルを CakePHP3に書き直したものですが、CakePHP2では、アクション名を「public function sample_parameter ($parameter)」のように「_（アンダースコア）」で区切る「スネークケース」で記述することができました。　
また、これを実行する場合は、「php cake.php SampleProgram sample_parameter aaa」のようにコマンドを実行することが可能でした。
　
ですが、CakePHP3では、これが正常に動作しなくなりました。
　
「main()」アクションがある場合は、「main()」アクションが実行されます。
ですが、「main()」アクションがない場合は、下記のエラーとなります。
　

bin/cake SampleProgram sample_parameter aaa
No subcommand provided. Choose one of the available subcommands.

Unable to find the `sample_program sample_parameter` subcommand. See `bin/cake sample_program --help`.

Available subcommands for the `sample_program` command are :

　
syntax error（文法エラー）ではないため、しばらくは何がエラーなのか分かりませんでした。
　
CakePHP3では、アクション名をローワーキャメルケース（sampleParameter）で記述しておけば、シェルを実行するときはスネークケース（sample_parameter）で呼び出すことは出来ますので、アクション名をスネークケースで記述することができなくなった、ということなのでしょう。
　
CakePHP3であっても、同一の Class内での関数の場合は、関数名がキャメルケースでもスネークケースでも動作するところもややこしさが増すところではありますね。
　
命名規則を理解して、しっかり規則に沿った命名を行いましょう！ってことですね。
　
　

CakePHP3の関連記事