エス技研

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でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説
 
その他の「CakePHP3」に関する記事一覧
 
 

 - CakePHP 2.x 3.x

GoogleAdwords

GoogleAdwords

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

Message

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

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

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

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

  関連記事

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

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

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

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

CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

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

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

CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定
CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

CakePHP3のCakeDC/Usersのログイン後のリダイレクトを設定解説
CakePHP3のCakeDC/Usersのログイン後のリダイレクトを設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

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

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

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

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

CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3
CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その3

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

CakePHP 2.x系 Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。