エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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

      2019/03/02

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

 

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

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

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

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

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


 

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

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

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

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

CakePHP2と CakePHP3の違い

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

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

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

CakePHP3の関連記事

CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 3.x 4.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

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

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

CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース+解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by(distinct)の実装方法
CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by(distinct)の実装方法

CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。

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

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

CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法
CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。[”項目名”=>”値”]ではなく[”項目名 = 項目名”]と書くところがポイント。

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

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

CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる!

CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説

CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。

CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root/Homeのリンクなども
CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root/Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その2
CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その2

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。