エス技研

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


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」となります。
 
そして、今回作成するサンプルプログラムのファイルの中身は下記の通りとなります。
 

 
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の関連記事

CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3のキャッシュをクリアする方法「bin/cake cache clear_all」を使う
CakePHP3のルーティング(routes.php)の変更が反映されない時はキャッシュのクリアを
Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説
CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

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

Message

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

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

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

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

  関連記事

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

ファイルのアップロード機能の自作サンプルコードとその解説のその2。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

CakePHP 2.3 テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション(連携)している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

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

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

CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法
CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに¥を追加する必要が!

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

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

CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説
CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション(入力チェック)の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数
CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

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

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

CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説
CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。